fiftyone.core.config

module documentation
(source)

FiftyOne config.

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

Class AnnotationConfig FiftyOne annotation configuration settings.
Class AppConfig FiftyOne App configuration settings.
Class AppConfigError Exception raised when an invalid AppConfig instance is encountered.
Class Config Base class for JSON serializable config classes.
Class Configurable Base class for classes that can be initialized with a Config instance that configures their behavior.
Class EnvConfig Undocumented
Class EvaluationConfig FiftyOne evaluation configuration settings.
Class FiftyOneConfig FiftyOne configuration settings.
Class FiftyOneConfigError Exception raised when a FiftyOne configuration issue is encountered.
Function load_annotation_config Loads the FiftyOne annotation config.
Function load_app_config Loads the FiftyOne App config.
Function load_config Loads the FiftyOne config.
Function load_evaluation_config Loads the FiftyOne evaluation config.
Function locate_annotation_config Returns the path to the AnnotationConfig on disk.
Function locate_app_config Returns the path to the AppConfig on disk.
Function locate_config Returns the path to the FiftyOneConfig on disk.
Function locate_evaluation_config Returns the path to the EvaluationConfig on disk.
Variable fop Undocumented
Variable logger Undocumented
Function _get_installed_packages Undocumented
Function _parse_env_value Undocumented
Function _set_nested_dict_value Undocumented
def load_annotation_config(): (source)

Loads the FiftyOne annotation config.

Returns
an AnnotationConfig instance
def load_app_config(): (source)

Loads the FiftyOne App config.

Returns
an AppConfig instance
def load_config(): (source)

Loads the FiftyOne config.

Returns
a FiftyOneConfig instance
def load_evaluation_config(): (source)

Loads the FiftyOne evaluation config.

Returns
an EvaluationConfig instance
def locate_annotation_config(): (source)

Returns the path to the AnnotationConfig on disk.

The default location is ~/.fiftyone/annotation_config.json, but you can override this path by setting the FIFTYONE_ANNOTATION_CONFIG_PATH environment variable.

Note that a config file may not actually exist on disk.

Returns
the path to the AnnotationConfig on disk
def locate_app_config(): (source)

Returns the path to the AppConfig on disk.

The default location is ~/.fiftyone/app_config.json, but you can override this path by setting the FIFTYONE_APP_CONFIG_PATH environment variable.

Note that the file may not actually exist.

Returns
the path to the AppConfig on disk
def locate_config(): (source)

Returns the path to the FiftyOneConfig on disk.

The default location is ~/.fiftyone/config.json, but you can override this path by setting the FIFTYONE_CONFIG_PATH environment variable.

Note that a config file may not actually exist on disk.

Returns
the path to the FiftyOneConfig on disk
def locate_evaluation_config(): (source)

Returns the path to the EvaluationConfig on disk.

The default location is ~/.fiftyone/evaluation_config.json, but you can override this path by setting the FIFTYONE_EVALUATION_CONFIG_PATH environment variable.

Note that a config file may not actually exist on disk.

Returns
the path to the EvaluationConfig on disk
fop = (source)

Undocumented

logger = (source)

Undocumented

def _get_installed_packages(): (source)

Undocumented

def _parse_env_value(value): (source)

Undocumented

def _set_nested_dict_value(d, path, value): (source)

Undocumented