Module Index

fiftyone - FiftyOne: a powerful package for dataset curation, analysis, and visualization.
- __public__ - FiftyOne's public interface.
- constants - Package-wide constants.
- core - No summary
  - aggregations - Aggregations.
  - annotation - Annotation runs framework.
  - brain - Brain method runs framework.
  - cli - Definition of the fiftyone command-line interface (CLI).
  - clips - Clips views.
  - collections - Interface for sample collections.
  - config - FiftyOne config.
  - context - Context utilities.
  - dataset - FiftyOne datasets.
  - document - Base classes for objects that are backed by database documents.
  - evaluation - Evaluation runs framework.
  - expressions - Expressions for fiftyone.core.stages.ViewStage definitions.
  - fields - Dataset sample fields.
  - frame - Video frames.
  - frame_utils - Frame utilities.
  - groups - Sample groups.
  - json - FiftyOne JSON handling
  - labels - Labels stored in dataset samples.
  - logging - Logging utilities.
  - map - Map package declaration.
    - batcher - Sample batcher package declaration.
      - batch - Abstract mapping backend
      - id_batch - Abstract mapping backend
      - slice_batch - Abstract mapping backend
    - factory - Factory for mapping backends | Copyright 2017-2025, Voxel51, Inc. | voxel51.com |
    - mapper - Abstract mapping backend
    - process - Multiprocessing utilities.
    - threading - Threading mapping backend
    - typing - Miscellaneous types
  - media - Sample media utilities.
  - metadata - Metadata stored in dataset samples.
  - models - FiftyOne models.
  - odm - ODM package declaration.
    - database - Database utilities.
    - dataset - Documents that track datasets and their sample schemas in the database.
    - document - Base classes for documents that back dataset contents.
    - embedded_document - Base classes for documents that back dataset contents.
    - frame - Backing document classes for fiftyone.core.frame.Frame instances.
    - mixins - Mixins and helpers for dataset backing documents.
    - runs - Dataset run documents.
    - sample - Backing document classes for fiftyone.core.sample.Sample instances.
    - utils - Utilities for documents.
    - views - Saved view documents.
    - workspace - App Space configuration.
  - patches - Patches views.
  - plots - Plotting framework.
    - base - Base plotting definitions.
    - manager - Session plot manager.
    - matplotlib - Matplotlib plots.
    - plotly - Plotly plots.
    - utils - Plotting utils.
    - views - Plotly-powered view plots.
  - runs - Dataset runs framework.
  - sample - Dataset samples.
  - service - FiftyOne Services.
  - session - Session definitions for interacting with the FiftyOne App.
    - client - Session server-sent events client.
    - events - Session events.
    - notebooks - Session notebook handling.
    - session - Session class for interacting with the FiftyOne App.
    - templates - Notebook Session HTML templates
  - singletons - FiftyOne singleton implementations.
  - stages - View stages.
  - state - Defines the shared state between the FiftyOne App and backend.
  - storage - File storage utilities.
  - threed - 3D definitions for FiftyOne.
    - camera - Camera definition for 3D visualization.
    - lights - Lights definition for 3D visualization.
    - material_3d - Material definition for 3D visualization.
    - mesh - Mesh definitions for 3D visualization.
    - object_3d - FiftyOne 3D Object3D base class.
    - pointcloud - PointCloud definition for 3D visualization.
    - scene_3d - 3D scene definitions.
    - shape_3d - Mesh definitions for 3D visualization.
    - transformation - No module docstring; 0/2 type alias, 0/1 constant, 0/2 function, 3/3 classes documented
    - utils - No summary
    - validators - Simple validator utilities
  - uid - Utilities for usage analytics.
  - utils - Core utilities.
  - validation - Validation utilities.
  - video - Video frame views.
  - view - Dataset views.
- factory - FiftyOne repository factory.
  - repo_factory - FiftyOne repository factory.
  - repos - FiftyOne repository factory.
    - delegated_operation - FiftyOne delegated operation repository.
    - delegated_operation_doc - FiftyOne delegated operation repository document.
    - execution_store - Execution store repository interface and implementations.
- internal - Internal classes and utilities.
  - secrets - FiftyOne secrets.
    - providers - FiftyOne secrets providers.
      - iprovider - FiftyOne secrets provider interface
      - local - FiftyOne env secrets provider
    - secret - FiftyOne secret types
  - util - FiftyOne internal utilities.
- migrations - FiftyOne's migration interface.
  - runner - FiftyOne migrations runner.
- operators - FiftyOne operators.
  - cache - Execution cache.
    - decorator - Execution cache decorator.
    - ephemeral - Undocumented
    - serialization - Execution cache serialization.
    - utils - Execution cache utils.
  - categories - Undocumented
  - decorators - FiftyOne operator decorators.
  - delegated - FiftyOne delegated operations.
  - evaluation_metric - Evaluation metric operators.
  - events - Undocumented
  - executor - FiftyOne operator execution.
  - message - FiftyOne operator messages.
  - operations - FiftyOne operator execution.
  - operator - FiftyOne operators.
  - panel - FiftyOne panels.
  - permissions - FiftyOne operator permissions.
  - registry - FiftyOne operator registry.
  - server - FiftyOne operator server.
  - store - Execution store.
    - models - Execution store models.
    - service - Execution store service.
    - store - Execution store class.
  - types - FiftyOne operator types.
  - utils - FiftyOne operator utilities.
- plugins - FiftyOne plugins.
  - constants - FiftyOne plugins constants.
  - context - FiftyOne plugin context.
  - core - Core plugin methods.
  - definitions - Plugin definitions.
  - secrets - Plugin secrets resolver.
  - utils - FiftyOne plugin utilities.
- server - FiftyOne Server
  - aggregate - FiftyOne Server aggregations
  - aggregations - FiftyOne Server aggregations
  - app - FiftyOne Server app.
  - color - FiftyOne Server coloring
  - constants - FiftyOne Server constants
  - context - FiftyOne Server context
  - data - FiftyOne Server data
  - dataloader - FiftyOne Server dataloader
  - decorators - FiftyOne Server decorators
  - events - FiftyOne Server events.
    - dispatch - FiftyOne Server events dispatching.
    - initialize - FiftyOne Server events initialization.
    - listener - FiftyOne Server events listening.
    - polling - FiftyOne Server events polling.
    - state - FiftyOne Server events state.
  - extensions - FiftyOne Server extensions
  - filters - FiftyOne Server filter inputs
  - indexes - FiftyOne Server indexes.
  - inputs - FiftyOne Server shared GraphQL input types.
  - interfaces - FiftyOne Server interfaces
  - lightning - FiftyOne Server lightning queries
  - main - FiftyOne Server main
  - metadata - FiftyOne Server JIT metadata utilities
  - mutation - FiftyOne Server mutations.
  - paginator - FiftyOne Server paginator
  - query - FiftyOne Server queries.
  - routes - FiftyOne Server routes
    - aggregate - FiftyOne Server /aggregation and /tagging routes
    - embeddings - FiftyOne Server /embeddings route.
    - event - FiftyOne Server /event route
    - events - FiftyOne Server /events route
    - fiftyone - FiftyOne Server /fiftyone route
    - frames - FiftyOne Server /frames route
    - geo - FiftyOne Server /geo route
    - get_similar_labels_frames - FiftyOne Server /get_similar_labels_frames route
    - media - FiftyOne Server /media route
    - plugins - FiftyOne Server /plugins route.
    - screenshot - FiftyOne Server /screenshot route
    - sort - FiftyOne Server /sort route
    - tag - FiftyOne Server /tag route
    - tagging - FiftyOne Server /tagging route
    - values - FiftyOne Server /values route
  - samples - FiftyOne Server samples pagination
  - scalars - FiftyOne Server GraphQL scalars
  - stage_definitions - FiftyOne Server stage definitions
  - stages - FiftyOne Server stage definitions
  - subscription - Undocumented
  - tags - FiftyOne Server tags and tagging
  - utils - FiftyOne Server utils.
  - view - FiftyOne Server view.
  - workspace - FiftyOne Server workspace.
- service - FiftyOne service support.
  - ipc - Inter-process communication handling.
  - main - This script provides a consistent environment for services to run in. The basic architecture is:
  - util - FiftyOne service utilities.
- types - FiftyOne types.
  - dataset_types - FiftyOne dataset types.
- utils - No summary
  - activitynet - Utilities for working with the ActivityNet dataset.
  - annotations - Annotation utilities.
  - aws - Utilities for working with Amazon Web Services.
  - bdd - Utilities for working with datasets in Berkeley DeepDrive (BDD) format.
  - beam - Apache Beam utilities.
  - cityscapes - Utilities for working with the Cityscapes dataset.
  - clip - CLIP model utils.
    - model - CLIP model from https://github.com/openai/CLIP.
    - tokenizer - CLIP text tokenizer from https://github.com/openai/CLIP.
    - zoo - CLIP model wrapper for the FiftyOne Model Zoo.
  - coco - Utilities for working with datasets in COCO format.
  - csv - CSV utilities.
  - cvat - Utilities for working with datasets in CVAT format.
  - data - Data utilities.
    - base - Data utilities.
    - converters - Dataset format conversion utilities.
    - exporters - Dataset exporters.
    - importers - Dataset importers.
    - ingestors - Dataset ingestors.
    - parsers - Sample parsers.
  - dicom - DICOM utilities.
  - eta - Utilities for interfacing with the ETA library.
  - eval - Evaluation utilities.
    - activitynet - ActivityNet-style temporal detection evaluation.
    - base - Base evaluation methods.
    - classification - Classification evaluation.
    - coco - COCO-style detection evaluation.
    - detection - Detection evaluation.
    - openimages - Open Images-style detection evaluation.
    - regression - Regression evaluation.
    - segmentation - Segmentation evaluation.
  - fiw - Utilities for working with the Families in the Wild dataset.
  - flash - Utilities for working with Lightning Flash.
  - geojson - GeoJSON utilities.
  - geotiff - GeoTIFF utilities.
  - github - GitHub utilities.
  - groups - Grouped dataset utilities.
  - hmdb51 - Utilities for working with the HMDB51 dataset.
  - huggingface - Utilities for working with Hugging Face.
  - image - Image utilities.
  - imagenet - Utilities for working with the ImageNet dataset.
  - iou - Intersection over union (IoU) utilities.
  - kinetics - Utilities for working with the Kinetics dataset.
  - kitti - Utilities for working with datasets in KITTI format.
  - labelbox - Utilities for working with annotations in Labelbox format.
  - labels - Label utilities.
  - labelstudio - Utilities for working with annotations in Label Studio.
  - lfw - Utilities for working with the Labeled Faces in the Wild dataset.
  - open_clip - CLIP model wrapper for the FiftyOne Model Zoo.
  - openimages - Utilities for working with the Open Images dataset.
  - openlabel - Utilities for working with datasets in OpenLABEL format.
  - patches - Image patch utilities.
  - places - Utilities for working with the Places dataset.
  - quickstart - FiftyOne quickstart.
  - random - Random sampling utilities.
  - rerun - Utilities for working with Rerun.
  - sam - Segment Anything wrapper for the FiftyOne Model Zoo.
  - sam2 - Segment Anything 2 wrapper for the FiftyOne Model Zoo.
  - sama - Sama utilities.
  - scale - Utilities for working with annotations in Scale AI format.
  - super_gradients - Utilities for working with SuperGradients.
  - tf - TensorFlow utilities.
  - torch - PyTorch utilities.
  - tracking - Tracking utilities.
    - deepsort - DeepSort wrapper for FiftyOne.
  - transformers - Utilities for working with Hugging Face Transformers.
  - ucf101 - Utilities for working with the UCF101 dataset.
  - ultralytics - Utilities for working with Ultralytics.
  - utils3d - 3D utilities.
  - video - Video utilities.
  - voc - Utilities for working with datasets in VOC format.
  - yolo - Utilities for working with datasets in YOLO format.
  - youtube - Utilities for working with YouTube.
- zoo - The FiftyOne Zoo.
  - datasets - The FiftyOne Dataset Zoo.
    - base - FiftyOne Zoo Datasets provided natively by the library.
    - tf - FiftyOne Zoo Datasets provided by tensorflow_datasets.
    - torch - FiftyOne Zoo Datasets provided by torchvision:torchvision.datasets.
  - models - The FiftyOne Model Zoo.
    - torch - FiftyOne Zoo models provided by torchvision:torchvision.models.