ak.from_numpy — Awkward Array documentation

# ak.from_numpy

Defined in awkward.operations.convert on line 42.

ak.from_numpy(array, regulararray=False, recordarray=True, highlevel=True, behavior=None)
  Parameters:

    - array (np.ndarray) – The NumPy array to convert into an Awkward Array. This array can be a np.ma.MaskedArray.

    - regulararray (bool) – If True and the array is multidimensional, the dimensions are represented by nested `ak.layout.RegularArray` nodes; if False and the array is multidimensional, the dimensions are represented by a multivalued `ak.layout.NumpyArray.shape`. If the array is one-dimensional, this has no effect.

    - recordarray (bool) – If True and the array is a NumPy structured array (dtype.names is not None), the fields are represented by an `ak.layout.RecordArray`; if False and the array is a structured array, the structure is left in the `ak.layout.NumpyArray` `format`, which some functions do not recognize.

    - highlevel (bool) – If True, return an `ak.Array`; otherwise, return a low-level `ak.layout.Content` subclass.

    - behavior (None or dict) – Custom `ak.behavior` for the output array, if high-level.

Converts a NumPy array into an Awkward Array.

The resulting layout may involve the following `ak.layout.Content` types (only):

> - `ak.layout.NumpyArray`

> - `ak.layout.ByteMaskedArray` or `ak.layout.UnmaskedArray` if the `array` is an np.ma.MaskedArray.

> - `ak.layout.RegularArray` if `regulararray=True`.

> - `ak.layout.RecordArray` if `recordarray=True`.

See also `ak.to_numpy` and `ak.from_cupy`.