# fiftyone.core.config FiftyOne config. Copyright 2017-2026, Voxel51, Inc.
[voxel51.com](https://voxel51.com/)

**Classes:** | [`Config`](#fiftyone.core.config.Config)() | Base class for JSON serializable config classes. | |-------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| | [`Configurable`](#fiftyone.core.config.Configurable)(config) | Base class for classes that can be initialized with a [`Config`](#fiftyone.core.config.Config) instance that configures their behavior. | | [`EnvConfig`](#fiftyone.core.config.EnvConfig)() | | | [`FiftyOneConfig`](#fiftyone.core.config.FiftyOneConfig)([d]) | FiftyOne configuration settings. | | [`AppConfig`](#fiftyone.core.config.AppConfig)([d]) | FiftyOne App configuration settings. | | [`AnnotationConfig`](#fiftyone.core.config.AnnotationConfig)([d]) | FiftyOne annotation configuration settings. | | [`EvaluationConfig`](#fiftyone.core.config.EvaluationConfig)([d]) | FiftyOne evaluation configuration settings. | | [`HTTPRetryConfig`](#fiftyone.core.config.HTTPRetryConfig)() | Values used to configure the behavior of the retry logic of HTTP calls made throughout the library. | **Exceptions:** | [`FiftyOneConfigError`](#fiftyone.core.config.FiftyOneConfigError) | Exception raised when a FiftyOne configuration issue is encountered. | |----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------| | [`AppConfigError`](#fiftyone.core.config.AppConfigError) | Exception raised when an invalid [`AppConfig`](#fiftyone.core.config.AppConfig) instance is encountered. | **Functions:** | [`locate_config`](#fiftyone.core.config.locate_config)() | Returns the path to the [`FiftyOneConfig`](#fiftyone.core.config.FiftyOneConfig) on disk. | |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------| | [`locate_app_config`](#fiftyone.core.config.locate_app_config)() | Returns the path to the [`AppConfig`](#fiftyone.core.config.AppConfig) on disk. | | [`locate_annotation_config`](#fiftyone.core.config.locate_annotation_config)() | Returns the path to the [`AnnotationConfig`](#fiftyone.core.config.AnnotationConfig) on disk. | | [`locate_evaluation_config`](#fiftyone.core.config.locate_evaluation_config)() | Returns the path to the [`EvaluationConfig`](#fiftyone.core.config.EvaluationConfig) on disk. | | [`load_config`](#fiftyone.core.config.load_config)() | Loads the FiftyOne config. | | [`load_app_config`](#fiftyone.core.config.load_app_config)() | Loads the FiftyOne App config. | | [`load_annotation_config`](#fiftyone.core.config.load_annotation_config)() | Loads the FiftyOne annotation config. | | [`load_evaluation_config`](#fiftyone.core.config.load_evaluation_config)() | Loads the FiftyOne evaluation config. | ### *class* fiftyone.core.config.Config Bases: `Config` Base class for JSON serializable config classes. **Methods:** | [`attributes`](#fiftyone.core.config.Config.attributes)() | Returns a list of class attributes to be serialized. | |-----------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| | [`builder`](#fiftyone.core.config.Config.builder)() | Returns a ConfigBuilder instance for this class. | | [`copy`](#fiftyone.core.config.Config.copy)() | Returns a deep copy of the object. | | [`custom_attributes`](#fiftyone.core.config.Config.custom_attributes)([dynamic, private]) | Returns a customizable list of class attributes. | | [`default`](#fiftyone.core.config.Config.default)() | Returns the default config instance. | | [`from_dict`](#fiftyone.core.config.Config.from_dict)(d) | Constructs a Config object from a JSON dictionary. | | [`from_json`](#fiftyone.core.config.Config.from_json)(path, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON file. | | [`from_kwargs`](#fiftyone.core.config.Config.from_kwargs)(\*\*kwargs) | Constructs a Config object from keyword arguments. | | [`from_str`](#fiftyone.core.config.Config.from_str)(s, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON string. | | [`get_class_name`](#fiftyone.core.config.Config.get_class_name)() | Returns the fully-qualified class name string of this object. | | [`load_default`](#fiftyone.core.config.Config.load_default)() | Loads the default config instance from file. | | [`parse_array`](#fiftyone.core.config.Config.parse_array)(d, key[, default]) | Parses a raw array attribute. | | [`parse_bool`](#fiftyone.core.config.Config.parse_bool)(d, key[, default]) | Parses a boolean value. | | [`parse_categorical`](#fiftyone.core.config.Config.parse_categorical)(d, key, choices[, default]) | Parses a categorical JSON field, which must take a value from among the given choices. | | [`parse_dict`](#fiftyone.core.config.Config.parse_dict)(d, key[, default]) | Parses a dictionary attribute. | | [`parse_int`](#fiftyone.core.config.Config.parse_int)(d, key[, default]) | Parses an integer attribute. | | [`parse_mutually_exclusive_fields`](#fiftyone.core.config.Config.parse_mutually_exclusive_fields)(fields) | Parses a mutually exclusive dictionary of pre-parsed fields, which must contain exactly one field with a truthy value. | | [`parse_number`](#fiftyone.core.config.Config.parse_number)(d, key[, default]) | Parses a number attribute. | | [`parse_object`](#fiftyone.core.config.Config.parse_object)(d, key, cls[, default]) | Parses an object attribute. | | [`parse_object_array`](#fiftyone.core.config.Config.parse_object_array)(d, key, cls[, default]) | Parses an array of objects. | | [`parse_object_dict`](#fiftyone.core.config.Config.parse_object_dict)(d, key, cls[, default]) | Parses a dictionary whose values are objects. | | [`parse_path`](#fiftyone.core.config.Config.parse_path)(d, key[, default]) | Parses a path attribute. | | [`parse_raw`](#fiftyone.core.config.Config.parse_raw)(d, key[, default]) | Parses a raw (arbitrary) JSON field. | | [`parse_string`](#fiftyone.core.config.Config.parse_string)(d, key[, default]) | Parses a string attribute. | | [`serialize`](#fiftyone.core.config.Config.serialize)([reflective]) | Serializes the object into a dictionary. | | [`to_str`](#fiftyone.core.config.Config.to_str)([pretty_print]) | Returns a string representation of this object. | | [`validate_all_or_nothing_fields`](#fiftyone.core.config.Config.validate_all_or_nothing_fields)(fields) | Validates a dictionary of pre-parsed fields checking that either all or none of the fields have a truthy value. | | [`write_json`](#fiftyone.core.config.Config.write_json)(path[, pretty_print]) | Serializes the object and writes it to disk. | #### attributes() Returns a list of class attributes to be serialized. This method is called internally by `serialize()` to determine the class attributes to serialize. Subclasses can override this method, but, by default, all attributes in vars(self) are returned, minus private attributes, i.e., those starting with “_”. The order of the attributes in this list is preserved when serializing objects, so a common pattern is for subclasses to override this method if they want their JSON files to be organized in a particular way. * **Returns:** a list of class attributes to be serialized #### *classmethod* builder() Returns a ConfigBuilder instance for this class. #### copy() Returns a deep copy of the object. * **Returns:** a Serializable instance #### custom_attributes(dynamic=False, private=False) Returns a customizable list of class attributes. By default, all attributes in vars(self) are returned, minus private attributes (those starting with “_”). * **Parameters:** * **dynamic** – whether to include dynamic properties, e.g., those defined by getter/setter methods or the `@property` decorator. By default, this is False * **private** – whether to include private properties, i.e., those starting with “_”. By default, this is False * **Returns:** a list of class attributes #### *classmethod* default() Returns the default config instance. By default, this method instantiates the class from an empty dictionary, which will only succeed if all attributes are optional. Otherwise, subclasses should override this method to provide the desired default configuration. #### *classmethod* from_dict(d) Constructs a Config object from a JSON dictionary. Config subclass constructors accept JSON dictionaries, so this method simply passes the dictionary to cls(). * **Parameters:** **d** – a dict of fields expected by cls * **Returns:** an instance of cls #### *classmethod* from_json(path, \*args, \*\*kwargs) Constructs a Serializable object from a JSON file. Subclasses may override this method, but, by default, this method simply reads the JSON and calls from_dict(), which subclasses must implement. * **Parameters:** * **path** – the path to the JSON file on disk * **\*args** – optional positional arguments for `self.from_dict()` * **\*\*kwargs** – optional keyword arguments for `self.from_dict()` * **Returns:** an instance of the Serializable class #### *classmethod* from_kwargs(\*\*kwargs) Constructs a Config object from keyword arguments. * **Parameters:** **\*\*kwargs** – keyword arguments that define the fields expected by cls * **Returns:** an instance of cls #### *classmethod* from_str(s, \*args, \*\*kwargs) Constructs a Serializable object from a JSON string. Subclasses may override this method, but, by default, this method simply parses the string and calls from_dict(), which subclasses must implement. * **Parameters:** * **s** – a JSON string representation of a Serializable object * **\*args** – optional positional arguments for `self.from_dict()` * **\*\*kwargs** – optional keyword arguments for `self.from_dict()` * **Returns:** an instance of the Serializable class #### *classmethod* get_class_name() Returns the fully-qualified class name string of this object. #### *classmethod* load_default() Loads the default config instance from file. Subclasses must implement this method if they intend to support default instances. #### *static* parse_array(d, key, default=) Parses a raw array attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **default** – a default list to return if key is not present * **Returns:** a list of raw (untouched) values * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default value was provided and the key was not found in the dictionary #### *static* parse_bool(d, key, default=) Parses a boolean value. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **default** – a default bool to return if key is not present * **Returns:** True/False * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default value was provided and the key was not found in the dictionary #### *static* parse_categorical(d, key, choices, default=) Parses a categorical JSON field, which must take a value from among the given choices. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **choices** – either an iterable of possible values or an enum-like class whose attributes define the possible values * **default** – a default value to return if key is not present * **Returns:** the raw (untouched) value of the given field, which is equal to a value from `choices` * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the key was present in the dictionary but its value was not an allowed choice, or if no default value was provided and the key was not found in the dictionary #### *static* parse_dict(d, key, default=) Parses a dictionary attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **default** – a default dict to return if key is not present * **Returns:** a dictionary * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default value was provided and the key was not found in the dictionary #### *static* parse_int(d, key, default=) Parses an integer attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **default** – a default integer value to return if key is not present * **Returns:** an int * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default value was provided and the key was not found in the dictionary #### *static* parse_mutually_exclusive_fields(fields) Parses a mutually exclusive dictionary of pre-parsed fields, which must contain exactly one field with a truthy value. * **Parameters:** **fields** – a dictionary of pre-parsed fields * **Returns:** the (field, value) that was set * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if zero or more than one truthy value was found #### *static* parse_number(d, key, default=) Parses a number attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **default** – a default numeric value to return if key is not present * **Returns:** a number (e.g. int, float) * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default value was provided and the key was not found in the dictionary #### *static* parse_object(d, key, cls, default=) Parses an object attribute. The value of d[key] can be either an instance of cls or a serialized dict from an instance of cls. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **cls** – the class of d[key] * **default** – a default cls instance to return if key is not present * **Returns:** an instance of cls * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default value was provided and the key was not found in the dictionary #### *static* parse_object_array(d, key, cls, default=) Parses an array of objects. The values in d[key] can be either instances of cls or serialized dicts from instances of cls. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **cls** – the class of the elements of list d[key] * **default** – the default list to return if key is not present * **Returns:** a list of cls instances * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default value was provided and the key was not found in the dictionary #### *static* parse_object_dict(d, key, cls, default=) Parses a dictionary whose values are objects. The values in d[key] can be either instances of cls or serialized dicts from instances of cls. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **cls** – the class of the values of dictionary d[key] * **default** – the default dict of cls instances to return if key is not present * **Returns:** a dictionary whose values are cls instances * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default value was provided and the key was not found in the dictionary #### *static* parse_path(d, key, default=) Parses a path attribute. The path is converted to an absolute path if necessary via `os.path.abspath(os.path.expanduser(value))`. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **default** – a default string to return if key is not present * **Returns:** a path string * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default value was provided and the key was not found in the dictionary #### *static* parse_raw(d, key, default=) Parses a raw (arbitrary) JSON field. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **default** – a default value to return if key is not present * **Returns:** the raw (untouched) value of the given field * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if no default value was provided and the key was not found in the dictionary #### *static* parse_string(d, key, default=) Parses a string attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **default** – a default string to return if key is not present * **Returns:** a string * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default value was provided and the key was not found in the dictionary #### serialize(reflective=False) Serializes the object into a dictionary. Serialization is applied recursively to all attributes in the object, including element-wise serialization of lists and dictionary values. * **Parameters:** **reflective** – whether to include reflective attributes when serializing the object. By default, this is False * **Returns:** a JSON dictionary representation of the object #### to_str(pretty_print=True, \*\*kwargs) Returns a string representation of this object. * **Parameters:** * **pretty_print** – whether to render the JSON in human readable format with newlines and indentations. By default, this is True * **\*\*kwargs** – optional keyword arguments for `self.serialize()` * **Returns:** a string representation of the object #### *static* validate_all_or_nothing_fields(fields) Validates a dictionary of pre-parsed fields checking that either all or none of the fields have a truthy value. * **Parameters:** **fields** – a dictionary of pre-parsed fields * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if some values are truth and some are not #### write_json(path, pretty_print=False, \*\*kwargs) Serializes the object and writes it to disk. * **Parameters:** * **path** – the output path * **pretty_print** – whether to render the JSON in human readable format with newlines and indentations. By default, this is False * **\*\*kwargs** – optional keyword arguments for `self.serialize()` ### *class* fiftyone.core.config.Configurable(config) Bases: `Configurable` Base class for classes that can be initialized with a [`Config`](#fiftyone.core.config.Config) instance that configures their behavior. [`Configurable`](#fiftyone.core.config.Configurable) subclasses must obey the following rules: > 1. Configurable class `Foo` has an associated Config class > `FooConfig` that is importable from the same namespace as `Foo` > 2. Configurable class `Foo` must be initializable via the syntax > `Foo(config)`, where config is a `FooConfig` instance * **Parameters:** **config** – a [`Config`](#fiftyone.core.config.Config) **Methods:** | [`from_config`](#fiftyone.core.config.Configurable.from_config)(config) | Instantiates a Configurable class from a Config instance. | |--------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| | [`from_dict`](#fiftyone.core.config.Configurable.from_dict)(d) | Instantiates a Configurable class from a Config dict. | | [`from_json`](#fiftyone.core.config.Configurable.from_json)(json_path) | Instantiates a Configurable class from a Config JSON file. | | [`from_kwargs`](#fiftyone.core.config.Configurable.from_kwargs)(\*\*kwargs) | Instantiates a Configurable class from keyword arguments defining the attributes of a Config. | | [`parse`](#fiftyone.core.config.Configurable.parse)(class_name[, module_name]) | Parses a Configurable subclass name string. | | [`validate`](#fiftyone.core.config.Configurable.validate)(config) | Validates that the given config is an instance of Config. | #### *classmethod* from_config(config) Instantiates a Configurable class from a Config instance. #### *classmethod* from_dict(d) Instantiates a Configurable class from a Config dict. * **Parameters:** **d** – a dict to construct a Config * **Returns:** an instance of cls #### *classmethod* from_json(json_path) Instantiates a Configurable class from a Config JSON file. * **Parameters:** **json_path** – path to a JSON file for type Config * **Returns:** an instance of cls #### *classmethod* from_kwargs(\*\*kwargs) Instantiates a Configurable class from keyword arguments defining the attributes of a Config. * **Parameters:** **\*\*kwargs** – keyword arguments that define the fields of a Config dict * **Returns:** an instance of cls #### *static* parse(class_name, module_name=None) Parses a Configurable subclass name string. Assumes both the Configurable class and the Config class are defined in the same module. The module containing the classes will be loaded if necessary. * **Parameters:** * **class_name** – a string containing the name of the Configurable class, e.g. “ClassName”, or a fully-qualified class name, e.g. “eta.core.config.ClassName” * **module_name** – a string containing the fully-qualified module name, e.g. “eta.core.config”, or None if class_name includes the module name. Set module_name = \_\_name_\_ to load a class from the calling module * **Returns:** the Configurable class config_cls: the Config class associated with cls * **Return type:** [cls](fiftyone.brain.internal.core.elasticsearch.md#fiftyone.brain.internal.core.elasticsearch.ElasticsearchSimilarityConfig.cls) #### *classmethod* validate(config) Validates that the given config is an instance of Config. * **Raises:** **ConfigurableError** – if config is not an instance of Config ### *class* fiftyone.core.config.EnvConfig Bases: `EnvConfig` **Methods:** | [`attributes`](#fiftyone.core.config.EnvConfig.attributes)() | Returns a list of class attributes to be serialized. | |--------------------------------------------------------------------------------------------------------|---------------------------------------------------------------| | [`copy`](#fiftyone.core.config.EnvConfig.copy)() | Returns a deep copy of the object. | | [`custom_attributes`](#fiftyone.core.config.EnvConfig.custom_attributes)([dynamic, private]) | Returns a customizable list of class attributes. | | [`from_dict`](#fiftyone.core.config.EnvConfig.from_dict)(d) | Constructs an EnvConfig object from a JSON dictionary. | | [`from_json`](#fiftyone.core.config.EnvConfig.from_json)(path) | Constructs an EnvConfig object from a JSON file. | | [`from_str`](#fiftyone.core.config.EnvConfig.from_str)(s, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON string. | | [`get_class_name`](#fiftyone.core.config.EnvConfig.get_class_name)() | Returns the fully-qualified class name string of this object. | | [`parse_bool`](#fiftyone.core.config.EnvConfig.parse_bool)(d, key[, env_var, default]) | Parses a boolean value. | | [`parse_dict`](#fiftyone.core.config.EnvConfig.parse_dict)(d, key[, env_var, default]) | Parses a dictionary attribute. | | [`parse_int`](#fiftyone.core.config.EnvConfig.parse_int)(d, key[, env_var, default]) | Parses an integer attribute. | | [`parse_number`](#fiftyone.core.config.EnvConfig.parse_number)(d, key[, env_var, default]) | Parses a number attribute. | | [`parse_path`](#fiftyone.core.config.EnvConfig.parse_path)(d, key[, env_var, default]) | Parses a path attribute. | | [`parse_path_array`](#fiftyone.core.config.EnvConfig.parse_path_array)(d, key[, env_var, default]) | Parses a path array attribute. | | [`parse_string`](#fiftyone.core.config.EnvConfig.parse_string)(d, key[, env_var, default]) | Parses a string attribute. | | [`parse_string_array`](#fiftyone.core.config.EnvConfig.parse_string_array)(d, key[, env_var, default]) | Parses a string array attribute. | | [`serialize`](#fiftyone.core.config.EnvConfig.serialize)([reflective]) | Serializes the object into a dictionary. | | [`to_str`](#fiftyone.core.config.EnvConfig.to_str)([pretty_print]) | Returns a string representation of this object. | | [`write_json`](#fiftyone.core.config.EnvConfig.write_json)(path[, pretty_print]) | Serializes the object and writes it to disk. | #### attributes() Returns a list of class attributes to be serialized. This method is called internally by `serialize()` to determine the class attributes to serialize. Subclasses can override this method, but, by default, all attributes in vars(self) are returned, minus private attributes, i.e., those starting with “_”. The order of the attributes in this list is preserved when serializing objects, so a common pattern is for subclasses to override this method if they want their JSON files to be organized in a particular way. * **Returns:** a list of class attributes to be serialized #### copy() Returns a deep copy of the object. * **Returns:** a Serializable instance #### custom_attributes(dynamic=False, private=False) Returns a customizable list of class attributes. By default, all attributes in vars(self) are returned, minus private attributes (those starting with “_”). * **Parameters:** * **dynamic** – whether to include dynamic properties, e.g., those defined by getter/setter methods or the `@property` decorator. By default, this is False * **private** – whether to include private properties, i.e., those starting with “_”. By default, this is False * **Returns:** a list of class attributes #### *classmethod* from_dict(d) Constructs an EnvConfig object from a JSON dictionary. EnvConfig subclass constructors accept JSON dictionaries, so this method simply passes the dictionary to cls(). * **Parameters:** **d** – a JSON dictionary containing the fields expected by cls * **Returns:** an instance of cls #### *classmethod* from_json(path) Constructs an EnvConfig object from a JSON file. EnvConfig instances allow their values to be overriden by environment variables, so, if the JSON file does not exist, this method silently loads an empty dictionary in its place. #### *classmethod* from_str(s, \*args, \*\*kwargs) Constructs a Serializable object from a JSON string. Subclasses may override this method, but, by default, this method simply parses the string and calls from_dict(), which subclasses must implement. * **Parameters:** * **s** – a JSON string representation of a Serializable object * **\*args** – optional positional arguments for `self.from_dict()` * **\*\*kwargs** – optional keyword arguments for `self.from_dict()` * **Returns:** an instance of the Serializable class #### *classmethod* get_class_name() Returns the fully-qualified class name string of this object. #### *static* parse_bool(d, key, env_var=None, default=) Parses a boolean value. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – a default bool to return if key is not present * **Returns:** True/False * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_dict(d, key, env_var=None, default=) Parses a dictionary attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – a default dict to return if key is not present * **Returns:** a dictionary * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_int(d, key, env_var=None, default=) Parses an integer attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default integer value to return if key is not present * **Returns:** an int * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_number(d, key, env_var=None, default=) Parses a number attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default numeric value to return if key is not present * **Returns:** a number (e.g. int, float) * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_path(d, key, env_var=None, default=) Parses a path attribute. The path is converted to an absolute path if necessary via `os.path.abspath(os.path.expanduser(value))`. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default string to return if key is not present * **Returns:** a path string * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_path_array(d, key, env_var=None, default=) Parses a path array attribute. Each path is converted to an absolute path if necessary via `os.path.abspath(os.path.expanduser(value))`. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default list to return if key is not present * **Returns:** a list of path strings * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_string(d, key, env_var=None, default=) Parses a string attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default string to return if key is not present * **Returns:** a string * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_string_array(d, key, env_var=None, default=) Parses a string array attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default list to return if key is not present * **Returns:** a list of strings * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### serialize(reflective=False) Serializes the object into a dictionary. Serialization is applied recursively to all attributes in the object, including element-wise serialization of lists and dictionary values. * **Parameters:** **reflective** – whether to include reflective attributes when serializing the object. By default, this is False * **Returns:** a JSON dictionary representation of the object #### to_str(pretty_print=True, \*\*kwargs) Returns a string representation of this object. * **Parameters:** * **pretty_print** – whether to render the JSON in human readable format with newlines and indentations. By default, this is True * **\*\*kwargs** – optional keyword arguments for `self.serialize()` * **Returns:** a string representation of the object #### write_json(path, pretty_print=False, \*\*kwargs) Serializes the object and writes it to disk. * **Parameters:** * **path** – the output path * **pretty_print** – whether to render the JSON in human readable format with newlines and indentations. By default, this is False * **\*\*kwargs** – optional keyword arguments for `self.serialize()` ### *class* fiftyone.core.config.FiftyOneConfig(d=None) Bases: [`EnvConfig`](#fiftyone.core.config.EnvConfig) FiftyOne configuration settings. **Attributes:** | [`show_progress_bars`](#fiftyone.core.config.FiftyOneConfig.show_progress_bars) | | |-----------------------------------------------------------------------------------|----| **Methods:** | [`attributes`](#fiftyone.core.config.FiftyOneConfig.attributes)() | Returns a list of class attributes to be serialized. | |-------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------| | [`copy`](#fiftyone.core.config.FiftyOneConfig.copy)() | Returns a deep copy of the object. | | [`custom_attributes`](#fiftyone.core.config.FiftyOneConfig.custom_attributes)([dynamic, private]) | Returns a customizable list of class attributes. | | [`from_dict`](#fiftyone.core.config.FiftyOneConfig.from_dict)(d) | Constructs an EnvConfig object from a JSON dictionary. | | [`from_json`](#fiftyone.core.config.FiftyOneConfig.from_json)(path) | Constructs an EnvConfig object from a JSON file. | | [`from_str`](#fiftyone.core.config.FiftyOneConfig.from_str)(s, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON string. | | [`get_class_name`](#fiftyone.core.config.FiftyOneConfig.get_class_name)() | Returns the fully-qualified class name string of this object. | | [`parse_bool`](#fiftyone.core.config.FiftyOneConfig.parse_bool)(d, key[, env_var, default]) | Parses a boolean value. | | [`parse_dict`](#fiftyone.core.config.FiftyOneConfig.parse_dict)(d, key[, env_var, default]) | Parses a dictionary attribute. | | [`parse_int`](#fiftyone.core.config.FiftyOneConfig.parse_int)(d, key[, env_var, default]) | Parses an integer attribute. | | [`parse_number`](#fiftyone.core.config.FiftyOneConfig.parse_number)(d, key[, env_var, default]) | Parses a number attribute. | | [`parse_path`](#fiftyone.core.config.FiftyOneConfig.parse_path)(d, key[, env_var, default]) | Parses a path attribute. | | [`parse_path_array`](#fiftyone.core.config.FiftyOneConfig.parse_path_array)(d, key[, env_var, default]) | Parses a path array attribute. | | [`parse_string`](#fiftyone.core.config.FiftyOneConfig.parse_string)(d, key[, env_var, default]) | Parses a string attribute. | | [`parse_string_array`](#fiftyone.core.config.FiftyOneConfig.parse_string_array)(d, key[, env_var, default]) | Parses a string array attribute. | | [`serialize`](#fiftyone.core.config.FiftyOneConfig.serialize)([reflective]) | Serializes the object into a dictionary. | | [`to_str`](#fiftyone.core.config.FiftyOneConfig.to_str)([pretty_print]) | Returns a string representation of this object. | | [`write_json`](#fiftyone.core.config.FiftyOneConfig.write_json)(path[, pretty_print]) | Serializes the object and writes it to disk. | #### *property* show_progress_bars #### attributes() Returns a list of class attributes to be serialized. This method is called internally by `serialize()` to determine the class attributes to serialize. Subclasses can override this method, but, by default, all attributes in vars(self) are returned, minus private attributes, i.e., those starting with “_”. The order of the attributes in this list is preserved when serializing objects, so a common pattern is for subclasses to override this method if they want their JSON files to be organized in a particular way. * **Returns:** a list of class attributes to be serialized #### copy() Returns a deep copy of the object. * **Returns:** a Serializable instance #### custom_attributes(dynamic=False, private=False) Returns a customizable list of class attributes. By default, all attributes in vars(self) are returned, minus private attributes (those starting with “_”). * **Parameters:** * **dynamic** – whether to include dynamic properties, e.g., those defined by getter/setter methods or the `@property` decorator. By default, this is False * **private** – whether to include private properties, i.e., those starting with “_”. By default, this is False * **Returns:** a list of class attributes #### *classmethod* from_dict(d) Constructs an EnvConfig object from a JSON dictionary. EnvConfig subclass constructors accept JSON dictionaries, so this method simply passes the dictionary to cls(). * **Parameters:** **d** – a JSON dictionary containing the fields expected by cls * **Returns:** an instance of cls #### *classmethod* from_json(path) Constructs an EnvConfig object from a JSON file. EnvConfig instances allow their values to be overriden by environment variables, so, if the JSON file does not exist, this method silently loads an empty dictionary in its place. #### *classmethod* from_str(s, \*args, \*\*kwargs) Constructs a Serializable object from a JSON string. Subclasses may override this method, but, by default, this method simply parses the string and calls from_dict(), which subclasses must implement. * **Parameters:** * **s** – a JSON string representation of a Serializable object * **\*args** – optional positional arguments for `self.from_dict()` * **\*\*kwargs** – optional keyword arguments for `self.from_dict()` * **Returns:** an instance of the Serializable class #### *classmethod* get_class_name() Returns the fully-qualified class name string of this object. #### *static* parse_bool(d, key, env_var=None, default=) Parses a boolean value. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – a default bool to return if key is not present * **Returns:** True/False * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_dict(d, key, env_var=None, default=) Parses a dictionary attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – a default dict to return if key is not present * **Returns:** a dictionary * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_int(d, key, env_var=None, default=) Parses an integer attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default integer value to return if key is not present * **Returns:** an int * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_number(d, key, env_var=None, default=) Parses a number attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default numeric value to return if key is not present * **Returns:** a number (e.g. int, float) * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_path(d, key, env_var=None, default=) Parses a path attribute. The path is converted to an absolute path if necessary via `os.path.abspath(os.path.expanduser(value))`. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default string to return if key is not present * **Returns:** a path string * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_path_array(d, key, env_var=None, default=) Parses a path array attribute. Each path is converted to an absolute path if necessary via `os.path.abspath(os.path.expanduser(value))`. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default list to return if key is not present * **Returns:** a list of path strings * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_string(d, key, env_var=None, default=) Parses a string attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default string to return if key is not present * **Returns:** a string * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_string_array(d, key, env_var=None, default=) Parses a string array attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default list to return if key is not present * **Returns:** a list of strings * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### serialize(reflective=False) Serializes the object into a dictionary. Serialization is applied recursively to all attributes in the object, including element-wise serialization of lists and dictionary values. * **Parameters:** **reflective** – whether to include reflective attributes when serializing the object. By default, this is False * **Returns:** a JSON dictionary representation of the object #### to_str(pretty_print=True, \*\*kwargs) Returns a string representation of this object. * **Parameters:** * **pretty_print** – whether to render the JSON in human readable format with newlines and indentations. By default, this is True * **\*\*kwargs** – optional keyword arguments for `self.serialize()` * **Returns:** a string representation of the object #### write_json(path, pretty_print=False, \*\*kwargs) Serializes the object and writes it to disk. * **Parameters:** * **path** – the output path * **pretty_print** – whether to render the JSON in human readable format with newlines and indentations. By default, this is False * **\*\*kwargs** – optional keyword arguments for `self.serialize()` ### *exception* fiftyone.core.config.FiftyOneConfigError Bases: `EnvConfigError` Exception raised when a FiftyOne configuration issue is encountered. **Methods:** | [`add_note`](#fiftyone.core.config.FiftyOneConfigError.add_note)(object, /) | Exception.add_note(note) -- add a note to the exception | |-----------------------------------------------------------------------------------------|---------------------------------------------------------------------------------| | [`with_traceback`](#fiftyone.core.config.FiftyOneConfigError.with_traceback)(object, /) | Exception.with_traceback(tb) -- set self._\_traceback_\_ to tb and return self. | **Attributes:** | [`args`](#fiftyone.core.config.FiftyOneConfigError.args) | | |------------------------------------------------------------|----| #### add_note(object,) Exception.add_note(note) – add a note to the exception #### args #### with_traceback(object,) Exception.with_traceback(tb) – set self._\_traceback_\_ to tb and return self. ### *class* fiftyone.core.config.AppConfig(d=None) Bases: [`EnvConfig`](#fiftyone.core.config.EnvConfig) FiftyOne App configuration settings. **Methods:** | [`get_colormap`](#fiftyone.core.config.AppConfig.get_colormap)([colorscale, n, hex_strs]) | Generates a continuous colormap with the specified number of colors from the given colorscale. | |--------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------| | [`attributes`](#fiftyone.core.config.AppConfig.attributes)() | Returns a list of class attributes to be serialized. | | [`copy`](#fiftyone.core.config.AppConfig.copy)() | Returns a deep copy of the object. | | [`custom_attributes`](#fiftyone.core.config.AppConfig.custom_attributes)([dynamic, private]) | Returns a customizable list of class attributes. | | [`from_dict`](#fiftyone.core.config.AppConfig.from_dict)(d) | Constructs an EnvConfig object from a JSON dictionary. | | [`from_json`](#fiftyone.core.config.AppConfig.from_json)(path) | Constructs an EnvConfig object from a JSON file. | | [`from_str`](#fiftyone.core.config.AppConfig.from_str)(s, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON string. | | [`get_class_name`](#fiftyone.core.config.AppConfig.get_class_name)() | Returns the fully-qualified class name string of this object. | | [`parse_bool`](#fiftyone.core.config.AppConfig.parse_bool)(d, key[, env_var, default]) | Parses a boolean value. | | [`parse_dict`](#fiftyone.core.config.AppConfig.parse_dict)(d, key[, env_var, default]) | Parses a dictionary attribute. | | [`parse_int`](#fiftyone.core.config.AppConfig.parse_int)(d, key[, env_var, default]) | Parses an integer attribute. | | [`parse_number`](#fiftyone.core.config.AppConfig.parse_number)(d, key[, env_var, default]) | Parses a number attribute. | | [`parse_path`](#fiftyone.core.config.AppConfig.parse_path)(d, key[, env_var, default]) | Parses a path attribute. | | [`parse_path_array`](#fiftyone.core.config.AppConfig.parse_path_array)(d, key[, env_var, default]) | Parses a path array attribute. | | [`parse_string`](#fiftyone.core.config.AppConfig.parse_string)(d, key[, env_var, default]) | Parses a string attribute. | | [`parse_string_array`](#fiftyone.core.config.AppConfig.parse_string_array)(d, key[, env_var, default]) | Parses a string array attribute. | | [`serialize`](#fiftyone.core.config.AppConfig.serialize)([reflective]) | Serializes the object into a dictionary. | | [`to_str`](#fiftyone.core.config.AppConfig.to_str)([pretty_print]) | Returns a string representation of this object. | | [`write_json`](#fiftyone.core.config.AppConfig.write_json)(path[, pretty_print]) | Serializes the object and writes it to disk. | #### get_colormap(colorscale=None, n=256, hex_strs=False) Generates a continuous colormap with the specified number of colors from the given colorscale. The provided `colorscale` can be any of the following: - The string name of any colorscale recognized by plotly. See [https://plotly.com/python/colorscales](https://plotly.com/python/colorscales) for possible options - A manually-defined colorscale like the following: ```default [ [0.000, "rgb(165,0,38)"], [0.111, "rgb(215,48,39)"], [0.222, "rgb(244,109,67)"], [0.333, "rgb(253,174,97)"], [0.444, "rgb(254,224,144)"], [0.555, "rgb(224,243,248)"], [0.666, "rgb(171,217,233)"], [0.777, "rgb(116,173,209)"], [0.888, "rgb(69,117,180)"], [1.000, "rgb(49,54,149)"], ] ``` The colorscale will be sampled evenly at the required resolution in order to generate the colormap. * **Parameters:** * **colorscale** (*None*) – a valid colorscale. See above for possible options. By default, `colorscale` is used * **n** (*256*) – the desired number of colors * **hex_strs** (*False*) – whether to return `#RRGGBB` hex strings rather than `(R, G, B)` tuples * **Returns:** a list of `(R, G, B)` tuples in `[0, 255]`, or, if `hex_strs` is True, a list of `#RRGGBB` strings #### attributes() Returns a list of class attributes to be serialized. This method is called internally by `serialize()` to determine the class attributes to serialize. Subclasses can override this method, but, by default, all attributes in vars(self) are returned, minus private attributes, i.e., those starting with “_”. The order of the attributes in this list is preserved when serializing objects, so a common pattern is for subclasses to override this method if they want their JSON files to be organized in a particular way. * **Returns:** a list of class attributes to be serialized #### copy() Returns a deep copy of the object. * **Returns:** a Serializable instance #### custom_attributes(dynamic=False, private=False) Returns a customizable list of class attributes. By default, all attributes in vars(self) are returned, minus private attributes (those starting with “_”). * **Parameters:** * **dynamic** – whether to include dynamic properties, e.g., those defined by getter/setter methods or the `@property` decorator. By default, this is False * **private** – whether to include private properties, i.e., those starting with “_”. By default, this is False * **Returns:** a list of class attributes #### *classmethod* from_dict(d) Constructs an EnvConfig object from a JSON dictionary. EnvConfig subclass constructors accept JSON dictionaries, so this method simply passes the dictionary to cls(). * **Parameters:** **d** – a JSON dictionary containing the fields expected by cls * **Returns:** an instance of cls #### *classmethod* from_json(path) Constructs an EnvConfig object from a JSON file. EnvConfig instances allow their values to be overriden by environment variables, so, if the JSON file does not exist, this method silently loads an empty dictionary in its place. #### *classmethod* from_str(s, \*args, \*\*kwargs) Constructs a Serializable object from a JSON string. Subclasses may override this method, but, by default, this method simply parses the string and calls from_dict(), which subclasses must implement. * **Parameters:** * **s** – a JSON string representation of a Serializable object * **\*args** – optional positional arguments for `self.from_dict()` * **\*\*kwargs** – optional keyword arguments for `self.from_dict()` * **Returns:** an instance of the Serializable class #### *classmethod* get_class_name() Returns the fully-qualified class name string of this object. #### *static* parse_bool(d, key, env_var=None, default=) Parses a boolean value. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – a default bool to return if key is not present * **Returns:** True/False * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_dict(d, key, env_var=None, default=) Parses a dictionary attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – a default dict to return if key is not present * **Returns:** a dictionary * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_int(d, key, env_var=None, default=) Parses an integer attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default integer value to return if key is not present * **Returns:** an int * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_number(d, key, env_var=None, default=) Parses a number attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default numeric value to return if key is not present * **Returns:** a number (e.g. int, float) * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_path(d, key, env_var=None, default=) Parses a path attribute. The path is converted to an absolute path if necessary via `os.path.abspath(os.path.expanduser(value))`. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default string to return if key is not present * **Returns:** a path string * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_path_array(d, key, env_var=None, default=) Parses a path array attribute. Each path is converted to an absolute path if necessary via `os.path.abspath(os.path.expanduser(value))`. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default list to return if key is not present * **Returns:** a list of path strings * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_string(d, key, env_var=None, default=) Parses a string attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default string to return if key is not present * **Returns:** a string * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_string_array(d, key, env_var=None, default=) Parses a string array attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default list to return if key is not present * **Returns:** a list of strings * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### serialize(reflective=False) Serializes the object into a dictionary. Serialization is applied recursively to all attributes in the object, including element-wise serialization of lists and dictionary values. * **Parameters:** **reflective** – whether to include reflective attributes when serializing the object. By default, this is False * **Returns:** a JSON dictionary representation of the object #### to_str(pretty_print=True, \*\*kwargs) Returns a string representation of this object. * **Parameters:** * **pretty_print** – whether to render the JSON in human readable format with newlines and indentations. By default, this is True * **\*\*kwargs** – optional keyword arguments for `self.serialize()` * **Returns:** a string representation of the object #### write_json(path, pretty_print=False, \*\*kwargs) Serializes the object and writes it to disk. * **Parameters:** * **path** – the output path * **pretty_print** – whether to render the JSON in human readable format with newlines and indentations. By default, this is False * **\*\*kwargs** – optional keyword arguments for `self.serialize()` ### *exception* fiftyone.core.config.AppConfigError Bases: `EnvConfigError` Exception raised when an invalid [`AppConfig`](#fiftyone.core.config.AppConfig) instance is encountered. **Methods:** | [`add_note`](#fiftyone.core.config.AppConfigError.add_note)(object, /) | Exception.add_note(note) -- add a note to the exception | |------------------------------------------------------------------------------------|---------------------------------------------------------------------------------| | [`with_traceback`](#fiftyone.core.config.AppConfigError.with_traceback)(object, /) | Exception.with_traceback(tb) -- set self._\_traceback_\_ to tb and return self. | **Attributes:** | [`args`](#fiftyone.core.config.AppConfigError.args) | | |-------------------------------------------------------|----| #### add_note(object,) Exception.add_note(note) – add a note to the exception #### args #### with_traceback(object,) Exception.with_traceback(tb) – set self._\_traceback_\_ to tb and return self. ### *class* fiftyone.core.config.AnnotationConfig(d=None) Bases: [`EnvConfig`](#fiftyone.core.config.EnvConfig) FiftyOne annotation configuration settings. **Methods:** | [`attributes`](#fiftyone.core.config.AnnotationConfig.attributes)() | Returns a list of class attributes to be serialized. | |---------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------| | [`copy`](#fiftyone.core.config.AnnotationConfig.copy)() | Returns a deep copy of the object. | | [`custom_attributes`](#fiftyone.core.config.AnnotationConfig.custom_attributes)([dynamic, private]) | Returns a customizable list of class attributes. | | [`from_dict`](#fiftyone.core.config.AnnotationConfig.from_dict)(d) | Constructs an EnvConfig object from a JSON dictionary. | | [`from_json`](#fiftyone.core.config.AnnotationConfig.from_json)(path) | Constructs an EnvConfig object from a JSON file. | | [`from_str`](#fiftyone.core.config.AnnotationConfig.from_str)(s, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON string. | | [`get_class_name`](#fiftyone.core.config.AnnotationConfig.get_class_name)() | Returns the fully-qualified class name string of this object. | | [`parse_bool`](#fiftyone.core.config.AnnotationConfig.parse_bool)(d, key[, env_var, default]) | Parses a boolean value. | | [`parse_dict`](#fiftyone.core.config.AnnotationConfig.parse_dict)(d, key[, env_var, default]) | Parses a dictionary attribute. | | [`parse_int`](#fiftyone.core.config.AnnotationConfig.parse_int)(d, key[, env_var, default]) | Parses an integer attribute. | | [`parse_number`](#fiftyone.core.config.AnnotationConfig.parse_number)(d, key[, env_var, default]) | Parses a number attribute. | | [`parse_path`](#fiftyone.core.config.AnnotationConfig.parse_path)(d, key[, env_var, default]) | Parses a path attribute. | | [`parse_path_array`](#fiftyone.core.config.AnnotationConfig.parse_path_array)(d, key[, env_var, default]) | Parses a path array attribute. | | [`parse_string`](#fiftyone.core.config.AnnotationConfig.parse_string)(d, key[, env_var, default]) | Parses a string attribute. | | [`parse_string_array`](#fiftyone.core.config.AnnotationConfig.parse_string_array)(d, key[, env_var, default]) | Parses a string array attribute. | | [`serialize`](#fiftyone.core.config.AnnotationConfig.serialize)([reflective]) | Serializes the object into a dictionary. | | [`to_str`](#fiftyone.core.config.AnnotationConfig.to_str)([pretty_print]) | Returns a string representation of this object. | | [`write_json`](#fiftyone.core.config.AnnotationConfig.write_json)(path[, pretty_print]) | Serializes the object and writes it to disk. | #### attributes() Returns a list of class attributes to be serialized. This method is called internally by `serialize()` to determine the class attributes to serialize. Subclasses can override this method, but, by default, all attributes in vars(self) are returned, minus private attributes, i.e., those starting with “_”. The order of the attributes in this list is preserved when serializing objects, so a common pattern is for subclasses to override this method if they want their JSON files to be organized in a particular way. * **Returns:** a list of class attributes to be serialized #### copy() Returns a deep copy of the object. * **Returns:** a Serializable instance #### custom_attributes(dynamic=False, private=False) Returns a customizable list of class attributes. By default, all attributes in vars(self) are returned, minus private attributes (those starting with “_”). * **Parameters:** * **dynamic** – whether to include dynamic properties, e.g., those defined by getter/setter methods or the `@property` decorator. By default, this is False * **private** – whether to include private properties, i.e., those starting with “_”. By default, this is False * **Returns:** a list of class attributes #### *classmethod* from_dict(d) Constructs an EnvConfig object from a JSON dictionary. EnvConfig subclass constructors accept JSON dictionaries, so this method simply passes the dictionary to cls(). * **Parameters:** **d** – a JSON dictionary containing the fields expected by cls * **Returns:** an instance of cls #### *classmethod* from_json(path) Constructs an EnvConfig object from a JSON file. EnvConfig instances allow their values to be overriden by environment variables, so, if the JSON file does not exist, this method silently loads an empty dictionary in its place. #### *classmethod* from_str(s, \*args, \*\*kwargs) Constructs a Serializable object from a JSON string. Subclasses may override this method, but, by default, this method simply parses the string and calls from_dict(), which subclasses must implement. * **Parameters:** * **s** – a JSON string representation of a Serializable object * **\*args** – optional positional arguments for `self.from_dict()` * **\*\*kwargs** – optional keyword arguments for `self.from_dict()` * **Returns:** an instance of the Serializable class #### *classmethod* get_class_name() Returns the fully-qualified class name string of this object. #### *static* parse_bool(d, key, env_var=None, default=) Parses a boolean value. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – a default bool to return if key is not present * **Returns:** True/False * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_dict(d, key, env_var=None, default=) Parses a dictionary attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – a default dict to return if key is not present * **Returns:** a dictionary * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_int(d, key, env_var=None, default=) Parses an integer attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default integer value to return if key is not present * **Returns:** an int * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_number(d, key, env_var=None, default=) Parses a number attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default numeric value to return if key is not present * **Returns:** a number (e.g. int, float) * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_path(d, key, env_var=None, default=) Parses a path attribute. The path is converted to an absolute path if necessary via `os.path.abspath(os.path.expanduser(value))`. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default string to return if key is not present * **Returns:** a path string * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_path_array(d, key, env_var=None, default=) Parses a path array attribute. Each path is converted to an absolute path if necessary via `os.path.abspath(os.path.expanduser(value))`. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default list to return if key is not present * **Returns:** a list of path strings * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_string(d, key, env_var=None, default=) Parses a string attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default string to return if key is not present * **Returns:** a string * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_string_array(d, key, env_var=None, default=) Parses a string array attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default list to return if key is not present * **Returns:** a list of strings * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### serialize(reflective=False) Serializes the object into a dictionary. Serialization is applied recursively to all attributes in the object, including element-wise serialization of lists and dictionary values. * **Parameters:** **reflective** – whether to include reflective attributes when serializing the object. By default, this is False * **Returns:** a JSON dictionary representation of the object #### to_str(pretty_print=True, \*\*kwargs) Returns a string representation of this object. * **Parameters:** * **pretty_print** – whether to render the JSON in human readable format with newlines and indentations. By default, this is True * **\*\*kwargs** – optional keyword arguments for `self.serialize()` * **Returns:** a string representation of the object #### write_json(path, pretty_print=False, \*\*kwargs) Serializes the object and writes it to disk. * **Parameters:** * **path** – the output path * **pretty_print** – whether to render the JSON in human readable format with newlines and indentations. By default, this is False * **\*\*kwargs** – optional keyword arguments for `self.serialize()` ### *class* fiftyone.core.config.EvaluationConfig(d=None) Bases: [`EnvConfig`](#fiftyone.core.config.EnvConfig) FiftyOne evaluation configuration settings. **Methods:** | [`attributes`](#fiftyone.core.config.EvaluationConfig.attributes)() | Returns a list of class attributes to be serialized. | |---------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------| | [`copy`](#fiftyone.core.config.EvaluationConfig.copy)() | Returns a deep copy of the object. | | [`custom_attributes`](#fiftyone.core.config.EvaluationConfig.custom_attributes)([dynamic, private]) | Returns a customizable list of class attributes. | | [`from_dict`](#fiftyone.core.config.EvaluationConfig.from_dict)(d) | Constructs an EnvConfig object from a JSON dictionary. | | [`from_json`](#fiftyone.core.config.EvaluationConfig.from_json)(path) | Constructs an EnvConfig object from a JSON file. | | [`from_str`](#fiftyone.core.config.EvaluationConfig.from_str)(s, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON string. | | [`get_class_name`](#fiftyone.core.config.EvaluationConfig.get_class_name)() | Returns the fully-qualified class name string of this object. | | [`parse_bool`](#fiftyone.core.config.EvaluationConfig.parse_bool)(d, key[, env_var, default]) | Parses a boolean value. | | [`parse_dict`](#fiftyone.core.config.EvaluationConfig.parse_dict)(d, key[, env_var, default]) | Parses a dictionary attribute. | | [`parse_int`](#fiftyone.core.config.EvaluationConfig.parse_int)(d, key[, env_var, default]) | Parses an integer attribute. | | [`parse_number`](#fiftyone.core.config.EvaluationConfig.parse_number)(d, key[, env_var, default]) | Parses a number attribute. | | [`parse_path`](#fiftyone.core.config.EvaluationConfig.parse_path)(d, key[, env_var, default]) | Parses a path attribute. | | [`parse_path_array`](#fiftyone.core.config.EvaluationConfig.parse_path_array)(d, key[, env_var, default]) | Parses a path array attribute. | | [`parse_string`](#fiftyone.core.config.EvaluationConfig.parse_string)(d, key[, env_var, default]) | Parses a string attribute. | | [`parse_string_array`](#fiftyone.core.config.EvaluationConfig.parse_string_array)(d, key[, env_var, default]) | Parses a string array attribute. | | [`serialize`](#fiftyone.core.config.EvaluationConfig.serialize)([reflective]) | Serializes the object into a dictionary. | | [`to_str`](#fiftyone.core.config.EvaluationConfig.to_str)([pretty_print]) | Returns a string representation of this object. | | [`write_json`](#fiftyone.core.config.EvaluationConfig.write_json)(path[, pretty_print]) | Serializes the object and writes it to disk. | #### attributes() Returns a list of class attributes to be serialized. This method is called internally by `serialize()` to determine the class attributes to serialize. Subclasses can override this method, but, by default, all attributes in vars(self) are returned, minus private attributes, i.e., those starting with “_”. The order of the attributes in this list is preserved when serializing objects, so a common pattern is for subclasses to override this method if they want their JSON files to be organized in a particular way. * **Returns:** a list of class attributes to be serialized #### copy() Returns a deep copy of the object. * **Returns:** a Serializable instance #### custom_attributes(dynamic=False, private=False) Returns a customizable list of class attributes. By default, all attributes in vars(self) are returned, minus private attributes (those starting with “_”). * **Parameters:** * **dynamic** – whether to include dynamic properties, e.g., those defined by getter/setter methods or the `@property` decorator. By default, this is False * **private** – whether to include private properties, i.e., those starting with “_”. By default, this is False * **Returns:** a list of class attributes #### *classmethod* from_dict(d) Constructs an EnvConfig object from a JSON dictionary. EnvConfig subclass constructors accept JSON dictionaries, so this method simply passes the dictionary to cls(). * **Parameters:** **d** – a JSON dictionary containing the fields expected by cls * **Returns:** an instance of cls #### *classmethod* from_json(path) Constructs an EnvConfig object from a JSON file. EnvConfig instances allow their values to be overriden by environment variables, so, if the JSON file does not exist, this method silently loads an empty dictionary in its place. #### *classmethod* from_str(s, \*args, \*\*kwargs) Constructs a Serializable object from a JSON string. Subclasses may override this method, but, by default, this method simply parses the string and calls from_dict(), which subclasses must implement. * **Parameters:** * **s** – a JSON string representation of a Serializable object * **\*args** – optional positional arguments for `self.from_dict()` * **\*\*kwargs** – optional keyword arguments for `self.from_dict()` * **Returns:** an instance of the Serializable class #### *classmethod* get_class_name() Returns the fully-qualified class name string of this object. #### *static* parse_bool(d, key, env_var=None, default=) Parses a boolean value. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – a default bool to return if key is not present * **Returns:** True/False * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_dict(d, key, env_var=None, default=) Parses a dictionary attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – a default dict to return if key is not present * **Returns:** a dictionary * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_int(d, key, env_var=None, default=) Parses an integer attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default integer value to return if key is not present * **Returns:** an int * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_number(d, key, env_var=None, default=) Parses a number attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default numeric value to return if key is not present * **Returns:** a number (e.g. int, float) * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_path(d, key, env_var=None, default=) Parses a path attribute. The path is converted to an absolute path if necessary via `os.path.abspath(os.path.expanduser(value))`. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default string to return if key is not present * **Returns:** a path string * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_path_array(d, key, env_var=None, default=) Parses a path array attribute. Each path is converted to an absolute path if necessary via `os.path.abspath(os.path.expanduser(value))`. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default list to return if key is not present * **Returns:** a list of path strings * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_string(d, key, env_var=None, default=) Parses a string attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default string to return if key is not present * **Returns:** a string * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### *static* parse_string_array(d, key, env_var=None, default=) Parses a string array attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **env_var** – an optional environment variable to load the attribute from rather than using the JSON dictionary * **default** – an optional default list to return if key is not present * **Returns:** a list of strings * **Raises:** **EnvConfigError** – if the environment variable, the dictionary key, or a default value was not provided #### serialize(reflective=False) Serializes the object into a dictionary. Serialization is applied recursively to all attributes in the object, including element-wise serialization of lists and dictionary values. * **Parameters:** **reflective** – whether to include reflective attributes when serializing the object. By default, this is False * **Returns:** a JSON dictionary representation of the object #### to_str(pretty_print=True, \*\*kwargs) Returns a string representation of this object. * **Parameters:** * **pretty_print** – whether to render the JSON in human readable format with newlines and indentations. By default, this is True * **\*\*kwargs** – optional keyword arguments for `self.serialize()` * **Returns:** a string representation of the object #### write_json(path, pretty_print=False, \*\*kwargs) Serializes the object and writes it to disk. * **Parameters:** * **path** – the output path * **pretty_print** – whether to render the JSON in human readable format with newlines and indentations. By default, this is False * **\*\*kwargs** – optional keyword arguments for `self.serialize()` ### fiftyone.core.config.locate_config() Returns the path to the [`FiftyOneConfig`](#fiftyone.core.config.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`](#fiftyone.core.config.FiftyOneConfig) on disk ### fiftyone.core.config.locate_app_config() Returns the path to the [`AppConfig`](#fiftyone.core.config.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`](#fiftyone.core.config.AppConfig) on disk ### fiftyone.core.config.locate_annotation_config() Returns the path to the [`AnnotationConfig`](#fiftyone.core.config.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`](#fiftyone.core.config.AnnotationConfig) on disk ### *class* fiftyone.core.config.HTTPRetryConfig Bases: `object` Values used to configure the behavior of the retry logic of HTTP calls made throughout the library. NOTE: calls made directly through storage clients (GCS, S3) use their own internal retry logic implementation and may not perfectly match this configuration. This configuration is for direct HTTP requests. **Attributes:** | [`RETRY_CODES`](#fiftyone.core.config.HTTPRetryConfig.RETRY_CODES) | | |----------------------------------------------------------------------|----| | [`FACTOR`](#fiftyone.core.config.HTTPRetryConfig.FACTOR) | | | [`MAX_TRIES`](#fiftyone.core.config.HTTPRetryConfig.MAX_TRIES) | | #### RETRY_CODES *= {408, 429, 500, 502, 503, 504, 509}* #### FACTOR *= 0.1* #### MAX_TRIES *= 10* ### fiftyone.core.config.locate_evaluation_config() Returns the path to the [`EvaluationConfig`](#fiftyone.core.config.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`](#fiftyone.core.config.EvaluationConfig) on disk ### fiftyone.core.config.load_config() Loads the FiftyOne config. * **Returns:** a [`FiftyOneConfig`](#fiftyone.core.config.FiftyOneConfig) instance ### fiftyone.core.config.load_app_config() Loads the FiftyOne App config. * **Returns:** an [`AppConfig`](#fiftyone.core.config.AppConfig) instance ### fiftyone.core.config.load_annotation_config() Loads the FiftyOne annotation config. * **Returns:** an [`AnnotationConfig`](#fiftyone.core.config.AnnotationConfig) instance ### fiftyone.core.config.load_evaluation_config() Loads the FiftyOne evaluation config. * **Returns:** an [`EvaluationConfig`](#fiftyone.core.config.EvaluationConfig) instance