class GroupDatasetImporter(GenericSampleDatasetImporter): (source)
Constructor: GroupDatasetImporter(dataset_dir, shuffle, seed, max_samples)
Interface for importing datasets that contain arbitrary grouped
fiftyone.core.sample.Sample instances.
Typically, dataset importers should implement the parameters documented on this class, although this is not mandatory.
See :ref:`this page <writing-a-custom-dataset-importer>` for information about implementing/using dataset importers.
| Parameters | |
| dataset | the dataset directory. This may be optional for some importers |
| shuffle | whether to randomly shuffle the order in which the samples are imported |
| seed | a random seed to use when shuffling |
| max | a maximum number of samples to import. By default, all samples are imported |
| Method | __len__ |
The total number of samples that will be imported across all group slices. |
| Method | __next__ |
Returns information about the next group in the dataset. |
| Property | group |
The name of the group field to populate on each sample. |
Inherited from GenericSampleDatasetImporter:
| Method | get |
Returns a dictionary describing the field schema of the samples loaded by this importer. |
| Property | has |
Whether this importer produces a sample field schema. |
Inherited from DatasetImporter (via GenericSampleDatasetImporter):
| Method | __enter__ |
Undocumented |
| Method | __exit__ |
Undocumented |
| Method | __init__ |
Undocumented |
| Method | __iter__ |
Undocumented |
| Method | close |
Performs any necessary actions after the last sample has been imported. |
| Method | get |
Returns the dataset info for the dataset. |
| Method | setup |
Performs any necessary setup before importing the first sample in the dataset. |
| Property | has |
Whether this importer produces a dataset info dictionary. |
| Method | _preprocess |
Internal utility that preprocesses the given list---which is presumed to be a list defining the samples that should be imported---by applying the values of the shuffle, seed, and max_samples parameters of the importer. |
The total number of samples that will be imported across all group slices.
| Raises | |
TypeError | if the total number is not known |
Returns information about the next group in the dataset.
| Returns | |
a dict mapping slice names to fiftyone.core.sample.Sample
instances | |
| Raises | |
StopIteration | if there are no more samples to import |