class documentation
class MediaDirectoryImporter(UnlabeledMediaDatasetImporter): (source)
Constructor: MediaDirectoryImporter(dataset_dir, recursive, compute_metadata, shuffle, ...)
Importer for a directory of media files stored on disk.
See :ref:`this page <MediaDirectory-import>` for format details.
| Parameters | |
| dataset | the dataset directory |
| recursive | whether to recursively traverse subdirectories |
| compute | whether to produce
fiftyone.core.metadata.Metadata instances for each media
file when importing |
| 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 | __init__ |
Undocumented |
| Method | __iter__ |
Undocumented |
| Method | __len__ |
The total number of samples that will be imported. |
| Method | __next__ |
Returns information about the next sample in the dataset. |
| Method | setup |
Performs any necessary setup before importing the first sample in the dataset. |
| Instance Variable | compute |
Undocumented |
| Instance Variable | recursive |
Undocumented |
| Property | has |
Whether this importer produces a dataset info dictionary. |
| Property | has |
Whether this importer produces fiftyone.core.metadata.Metadata instances for each sample. |
| Static Method | _get |
Undocumented |
| Instance Variable | _filepaths |
Undocumented |
| Instance Variable | _iter |
Undocumented |
| Instance Variable | _num |
Undocumented |
Inherited from DatasetImporter (via UnlabeledMediaDatasetImporter):
| Method | __enter__ |
Undocumented |
| Method | __exit__ |
Undocumented |
| Method | close |
Performs any necessary actions after the last sample has been imported. |
| Method | get |
Returns the dataset info for the dataset. |
| 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. |
def __init__(self, dataset_dir, recursive=True, compute_metadata=False, shuffle=False, seed=None, max_samples=None):
(source)
¶
Undocumented
Returns information about the next sample in the dataset.
| Returns | |
an(filepath, metadata)tuple, where |
|
| Raises | |
StopIteration | if there are no more samples to import |
Performs any necessary setup before importing the first sample in the dataset.
This method is called when the importer's context manager interface is
entered, DatasetImporter.__enter__.