fiftyone.core.map.batcher#

Module contents#

Sample batcher package declaration.

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

Classes:

SampleBatch()

A sample batch

SampleIdBatch(*sample_ids)

Sample batch using ids

SampleSliceBatch(start_idx, stop_idx)

Sample batch using slices
class fiftyone.core.map.batcher.SampleBatch#

Bases: ABC

A sample batch

Methods:

split(sample_collection, num_workers[, ...])

Create a list of sample batches

create_subset(sample_collection)

Create a sample collection from the batch

Attributes:

total

Get the total number of samples in the batch
abstract classmethod split(sample_collection: SampleCollection[T], num_workers: int, batch_size: int | None = None) → List[SampleBatch]#

Create a list of sample batches

abstract property total: int#

Get the total number of samples in the batch

abstract create_subset(sample_collection: SampleCollection[T]) → SampleCollection[T]#

Create a sample collection from the batch

class fiftyone.core.map.batcher.SampleIdBatch(*sample_ids: ObjectId)#

Bases: SampleBatch

Sample batch using ids

Methods:

get_max_batch_size()

Get max batch size

split(sample_collection, num_workers[, ...])

Create a list of sample batches

create_subset(sample_collection)

Create a sample collection from the batch

Attributes:

total

Get the total number of samples in the batch
classmethod get_max_batch_size()#

Get max batch size

classmethod split(sample_collection: SampleCollection[T], num_workers: int, batch_size: int | None = None) → List[SampleIdBatch]#

Create a list of sample batches

property total: int#

Get the total number of samples in the batch

create_subset(sample_collection: SampleCollection[T]) → SampleCollection[T]#

Create a sample collection from the batch

class fiftyone.core.map.batcher.SampleSliceBatch(start_idx: int, stop_idx: int)#

Bases: SampleBatch

Sample batch using slices

Methods:

split(sample_collection, num_workers[, ...])

Create a list of sample batches

create_subset(sample_collection)

Create a sample collection from the batch

Attributes:

total

Get the total number of samples in the batch
classmethod split(sample_collection: SampleCollection[T], num_workers: int, batch_size: int | None = None) → List[SampleSliceBatch]#

Create a list of sample batches

property total: int#

Get the total number of samples in the batch

create_subset(sample_collection: SampleCollection[T]) → SampleCollection[T]#

Create a sample collection from the batch