ray.data.Dataset.map#

Dataset.map(fn: Callable[[Dict[str, Any]], Dict[str, Any]] | Callable[[Dict[str, Any]], Iterator[Dict[str, Any]]] | _CallableClassProtocol, *, compute: ComputeStrategy | None = None, fn_args: Iterable[Any] | None = None, fn_kwargs: Dict[str, Any] | None = None, fn_constructor_args: Iterable[Any] | None = None, fn_constructor_kwargs: Dict[str, Any] | None = None, num_cpus: float | None = None, num_gpus: float | None = None, concurrency: int | Tuple[int, int] | None = None, **ray_remote_args) Dataset[source]#

Apply the given function to each row of this dataset.

Use this method to transform your data. To learn more, see Transforming rows.

You can use either a function or a callable class to perform the transformation. For functions, Ray Data uses stateless Ray tasks. For classes, Ray Data uses stateful Ray actors. For more information, see Stateful Transforms.

Tip

If your transformation is vectorized like most NumPy or pandas operations, map_batches() might be faster.

Examples

import os
from typing import Any, Dict
import ray

def parse_filename(row: Dict[str, Any]) -> Dict[str, Any]:
    row["filename"] = os.path.basename(row["path"])
    return row

ds = (
    ray.data.read_images("s3://anonymous@ray-example-data/image-datasets/simple", include_paths=True)
    .map(parse_filename)
)
print(ds.schema())
Column    Type
------    ----
image     numpy.ndarray(shape=(32, 32, 3), dtype=uint8)
path      string
filename  string

Time complexity: O(dataset size / parallelism)

Parameters:
  • fn – The function to apply to each row, or a class type that can be instantiated to create such a callable.

  • compute – This argument is deprecated. Use concurrency argument.

  • fn_args – Positional arguments to pass to fn after the first argument. These arguments are top-level arguments to the underlying Ray task.

  • fn_kwargs – Keyword arguments to pass to fn. These arguments are top-level arguments to the underlying Ray task.

  • fn_constructor_args – Positional arguments to pass to fn’s constructor. You can only provide this if fn is a callable class. These arguments are top-level arguments in the underlying Ray actor construction task.

  • fn_constructor_kwargs – Keyword arguments to pass to fn’s constructor. This can only be provided if fn is a callable class. These arguments are top-level arguments in the underlying Ray actor construction task.

  • num_cpus – The number of CPUs to reserve for each parallel map worker.

  • num_gpus – The number of GPUs to reserve for each parallel map worker. For example, specify num_gpus=1 to request 1 GPU for each parallel map worker.

  • concurrency – The number of Ray workers to use concurrently. For a fixed-sized worker pool of size n, specify concurrency=n. For an autoscaling worker pool from m to n workers, specify concurrency=(m, n).

  • ray_remote_args – Additional resource requirements to request from Ray for each map worker.

See also

flat_map()

Call this method to create new rows from existing ones. Unlike map(), a function passed to flat_map() can return multiple rows.

map_batches()

Call this method to transform batches of data.