Function from_numpy_refs

python/ray/data/read_api.py:3555–3628

Creates a :class:`~ray.data.Dataset` from a list of Ray object references to NumPy ndarrays. The column name defaults to "data". Examples: >>> import numpy as np >>> import ray >>> arr_ref = ray.put(np.array([1])) >>> ray.data.from_numpy_refs(arr_ref) #

(
    ndarrays: Union[ObjectRef[np.ndarray], List[ObjectRef[np.ndarray]]],
)

@DeveloperAPI
def from_numpy_refs(
    ndarrays: Union[ObjectRef[np.ndarray], List[ObjectRef[np.ndarray]]],
) -> MaterializedDataset:
    """Creates a :class:`~ray.data.Dataset` from a list of Ray object references to
    NumPy ndarrays.

    The column name defaults to "data".

    Examples:
        >>> import numpy as np
        >>> import ray
        >>> arr_ref = ray.put(np.array([1]))
        >>> ray.data.from_numpy_refs(arr_ref)  # doctest: +ELLIPSIS
        shape: (1, 1)
        ╭───────╮
        │ data  │
        │ ---   │
        │ int64 │
        ╞═══════╡
        │ 1     │
        ╰───────╯
        (Showing 1 of 1 rows)

        Create a Ray Dataset from a list of NumPy array references.

        >>> ray.data.from_numpy_refs([arr_ref, arr_ref])  # doctest: +ELLIPSIS
        shape: (2, 1)
        ╭───────╮
        │ data  │
        │ ---   │
        │ int64 │
        ╞═══════╡
        │ 1     │
        │ 1     │
        ╰───────╯
        (Showing 2 of 2 rows)

    Args:
        ndarrays: A Ray object reference to a NumPy ndarray or a list of Ray object
            references to NumPy ndarrays.

    Returns:
        :class:`~ray.data.Dataset` holding data from the given ndarrays.
    """
    if isinstance(ndarrays, ray.ObjectRef):
        ndarrays = [ndarrays]
    elif isinstance(ndarrays, list):
        for ndarray in ndarrays:
            if not isinstance(ndarray, ray.ObjectRef):
                raise ValueError(
                    "Expected list of Ray object refs, "
                    f"got list containing {type(ndarray)}"
                )
    else:
        raise ValueError(
            f"Expected Ray object ref or list of Ray object refs, got {type(ndarray)}"
        )