fiftyone.core.runs.BaseRunConfig

class documentation

class BaseRunConfig(Config): (source)

Known subclasses: fiftyone.core.annotation.AnnotationMethodConfig, fiftyone.core.brain.BrainMethodConfig, fiftyone.core.evaluation.EvaluationMethodConfig, fiftyone.core.runs.RunConfig

Constructor: BaseRunConfig(**kwargs)

View In Hierarchy

Base class for configuring BaseRun instances.

Parameters
**kwargs	any leftover keyword arguments after subclasses have done their parsing

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	`__init__`	Undocumented
Method	`attributes`	Returns the list of class attributes that will be serialized by `serialize`.
Method	`build`	Builds the `BaseRun` instance associated with this config.
Method	`load_credentials`	Loads any necessary credentials from the given keyword arguments or the relevant FiftyOne config.
Property	`cls`	The fully-qualified name of this `BaseRunConfig` class.
Property	`method`	The name of the method.
Property	`run_cls`	The `BaseRun` class associated with this config.
Property	`type`	The type of run.
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:

Method __repr__ Undocumented

@classmethod
def from_dict(cls, d): (source) ¶

Constructs a BaseRunConfig from a serialized JSON dict representation of it.

Parameters
d	a JSON dict
Returns
a `BaseRunConfig`

@staticmethod
def base_config_cls(type): (source) ¶

Returns the config class for the given run type.

Parameters
type	a `BaseRunConfig.type`
Returns
a `BaseRunConfig` subclass

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

overridden in fiftyone.core.runs.RunConfig, fiftyone.utils.annotations.AnnotationBackendConfig, fiftyone.utils.eval.classification.ClassificationEvaluationConfig, fiftyone.utils.eval.detection.DetectionEvaluationConfig, fiftyone.utils.eval.regression.RegressionEvaluationConfig, fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig

Undocumented

def attributes(self): (source) ¶

overridden in fiftyone.utils.eval.regression.SimpleEvaluationConfig

Returns the list of class attributes that will be serialized by serialize.

Returns
a list of attributes

def build(self): (source) ¶

Builds the BaseRun instance associated with this config.

Returns
a `BaseRun` instance

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

overridden in fiftyone.utils.annotations.AnnotationBackendConfig

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

Parameters
**kwargs	subclass-specific credentials

@property
cls = (source) ¶

The fully-qualified name of this BaseRunConfig class.

@property
method = (source) ¶

overridden in fiftyone.core.annotation.AnnotationMethodConfig, fiftyone.core.brain.BrainMethodConfig, fiftyone.core.evaluation.EvaluationMethodConfig, fiftyone.core.runs.RunConfig

The name of the method.

@property
run_cls = (source) ¶

The BaseRun class associated with this config.

@property
type = (source) ¶

overridden in fiftyone.core.annotation.AnnotationMethodConfig, fiftyone.core.brain.BrainMethodConfig, fiftyone.core.evaluation.EvaluationMethodConfig, fiftyone.core.runs.RunConfig

The type of run.

@classmethod
def _virtual_attributes(cls): (source) ¶

overridden in fiftyone.core.runs.RunConfig

A list of attributes that are serialized but should not be treated as parameters when loading the config class from the database.