Table of Contents
Contents

fiftyone.core.map¶

Module contents¶

Map package declaration.

Copyright 2017-2025, Voxel51, Inc.
voxel51.com

Classes:

Mapper(batch_cls, num_workers, batch_size)

Base class for mapping samples in parallel

MapperFactory()

Manage mapper implementations
class fiftyone.core.map.Mapper(batch_cls: Type[fiftyone.core.map.batcher.batch.SampleBatch], num_workers: int, batch_size: Optional[int] = None)¶

Bases: abc.ABC

Base class for mapping samples in parallel

Methods:

create(*, config, batch_cls[, num_workers])

Create a new mapper instance

map_samples(sample_collection, map_fcn, *[, …])

Applies map function to each sample and returns an iterator of the results.

Attributes:

num_workers

Number of workers to use

batch_size

Number of samples per worker batch
abstract classmethod create(*, config: fiftyone.core.config.FiftyOneConfig, batch_cls: Type[fiftyone.core.map.batcher.batch.SampleBatch], num_workers: Optional[int] = None, **__)¶

Create a new mapper instance

property num_workers¶

Number of workers to use

property batch_size¶

Number of samples per worker batch

map_samples(sample_collection: fiftyone.core.map.typing.SampleCollection[T], map_fcn: Callable[[T], R], *, progress: Optional[Union[bool, Literal[workers]]] = None, save: bool = False, skip_failures: bool = True) → Iterator[Tuple[bson.objectid.ObjectId, R]]¶

Applies map function to each sample and returns an iterator of the results.

Parameters

  • sample_collection (SampleCollection[T]) – The sample collection to map.

  • map_fcn (Callable[[T], R]) – The map function to apply to each sample.

  • progress (Union[bool, Literal["workers"]]) – Whether or not and how to render progress.

  • save (bool, optional) – Whether to save mutated samples mutated in the map function. Defaults to False.

  • skip_failures (bool, optional) – Whether to gracefully continue without raising an error if the map function raises an exception for a sample. Defaults to True.

Yields

Iterator[Tuple[bson.ObjectId, R]] –

The sample ID and the result of

the map function for the sample.

class fiftyone.core.map.MapperFactory¶

Bases: object

Manage mapper implementations

Methods:

batch_methods()

Get available batch methods

mapper_keys()

Get available mapper class keys

create([mapper_key, num_workers, …])

Create a mapper instance
classmethod batch_methods() → List[str]¶

Get available batch methods

classmethod mapper_keys() → List[str]¶

Get available mapper class keys

classmethod create(mapper_key: Optional[str] = None, num_workers: Optional[int] = None, batch_method: Optional[str] = None, batch_size: Optional[int] = None, **mapper_extra_kwargs) → fiftyone.core.map.mapper.Mapper¶

Create a mapper instance