fiftyone.utils.annotations.AnnotationBackendConfig

class documentation

class AnnotationBackendConfig(foa.AnnotationMethodConfig): (source)

Known subclasses: fiftyone.utils.cvat.CVATBackendConfig, fiftyone.utils.labelbox.LabelboxBackendConfig, fiftyone.utils.labelstudio.LabelStudioBackendConfig

Constructor: AnnotationBackendConfig(name, label_schema, media_field, **kwargs)

View In Hierarchy

Base class for configuring an AnnotationBackend instances.

Subclasses are free to define additional keyword arguments if they desire.

Parameters
name	the name of the backend
label_schema	a dictionary containing the description of label fields, classes and attributes to annotate
media_field	string field name containing the paths to media files on disk to upload
**kwargs	any leftover keyword arguments after subclasses have done their parsing

Method	`__init__`	Undocumented
Method	`load_credentials`	Loads any necessary credentials from the given keyword arguments or the relevant FiftyOne config.
Method	`serialize`	Undocumented
Instance Variable	`label_schema`	Undocumented
Instance Variable	`media_field`	Undocumented
Instance Variable	`name`	Undocumented
Property	`method`	The name of the annotation backend.
Method	`_load_parameters`	Undocumented
Method	`_sanitize_label_schema`	Undocumented

Inherited from AnnotationMethodConfig:

Property type The type of run.

Inherited from BaseRunConfig (via AnnotationMethodConfig):

Class Method	`from_dict`	Constructs a `BaseRunConfig` from a serialized JSON dict representation of it.
Static Method	`base_config_cls`	Returns the config class for the given run type.
Method	`attributes`	Returns the list of class attributes that will be serialized by `serialize`.
Method	`build`	Builds the `BaseRun` instance associated with this config.
Property	`cls`	The fully-qualified name of this `BaseRunConfig` class.
Property	`run_cls`	The `BaseRun` class associated with this config.
Class Method	`_virtual_attributes`	A list of attributes that are serialized but should not be treated as parameters when loading the config class from the database.

Inherited from Config (via AnnotationMethodConfig, BaseRunConfig):

Method __repr__ Undocumented

def __init__(self, name, label_schema, media_field='filepath', **kwargs): (source) ¶

overrides fiftyone.core.runs.BaseRunConfig.__init__

overridden in fiftyone.utils.cvat.CVATBackendConfig, fiftyone.utils.labelbox.LabelboxBackendConfig, fiftyone.utils.labelstudio.LabelStudioBackendConfig

Undocumented

def load_credentials(self, **kwargs): (source) ¶

overrides fiftyone.core.runs.BaseRunConfig.load_credentials

overridden in fiftyone.utils.cvat.CVATBackendConfig, fiftyone.utils.labelbox.LabelboxBackendConfig, fiftyone.utils.labelstudio.LabelStudioBackendConfig

Loads any necessary credentials from the given keyword arguments or the relevant FiftyOne config.

Parameters
**kwargs	subclass-specific credentials

def serialize(self, *args, **kwargs): (source) ¶

Undocumented

label_schema = (source) ¶

Undocumented

media_field: "filepath" = (source) ¶

overridden in fiftyone.utils.cvat.CVATBackendConfig, fiftyone.utils.labelbox.LabelboxBackendConfig, fiftyone.utils.labelstudio.LabelStudioBackendConfig

Undocumented

name = (source) ¶

Undocumented

@property
method = (source) ¶

overrides fiftyone.core.annotation.AnnotationMethodConfig.method

The name of the annotation backend.

def _load_parameters(self, **kwargs): (source) ¶

Undocumented

def _sanitize_label_schema(self, label_schema): (source) ¶

Undocumented