fiftyone.utils.labelbox.LabelboxBackendConfig

class documentation

Class for configuring LabelboxBackend instances.

Parameters
name	the name of the backend
label_schema	a dictionary containing the description of label fields, classes and attribute to annotate
media_field	string field name containing the paths to media files on disk to upload
url	the url of the Labelbox server
api_key	the Labelbox API key
project_name	a name for the Labelbox project that will be created. The default is `"FiftyOne_<dataset_name>"`
members	an optional list of `(email, role)` tuples specifying the email addresses and roles of users to add to the project. If a user is not a member of the project's organization, an email invitation will be sent to them. The supported roles are `["LABELER", "REVIEWER", "TEAM_MANAGER", "ADMIN"]`
classes_as_attrs	whether to show every object class at the top level of the editor (False) or whether to show the label field at the top level and annotate the class as a required attribute of each object (True)
export_version	the Labelbox export format and API version to use. Supported values are `("v1", "v2")`

Method	`__init__`	Undocumented
Method	`api_key.setter`	Undocumented
Method	`load_credentials`	Loads any necessary credentials from the given keyword arguments or the relevant FiftyOne config.
Instance Variable	`classes_as_attrs`	Undocumented
Instance Variable	`export_version`	Undocumented
Instance Variable	`members`	Undocumented
Instance Variable	`project_name`	Undocumented
Instance Variable	`url`	Undocumented
Property	`api_key`	Undocumented
Instance Variable	`_api_key`	Undocumented
Property	`_experimental`	Undocumented

Method	`serialize`	Undocumented
Instance Variable	`label_schema`	Undocumented
Instance Variable	`name`	Undocumented
Property	`method`	The name of the annotation backend.
Method	`_load_parameters`	Undocumented
Method	`_sanitize_label_schema`	Undocumented

Property type The type of run.

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.

Method __repr__ Undocumented

def __init__(self, name, label_schema, media_field='filepath', url=None, api_key=None, project_name=None, members=None, classes_as_attrs=True, export_version=LabelboxExportVersion.V2, **kwargs): (source) ¶

overrides fiftyone.utils.annotations.AnnotationBackendConfig.__init__

Undocumented

Undocumented

def load_credentials(self, url=None, api_key=None): (source) ¶

overrides fiftyone.utils.annotations.AnnotationBackendConfig.load_credentials

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