fiftyone.core.runs.BaseRunResults

class documentation

class BaseRunResults(etas.Serializable): (source)

Known subclasses: fiftyone.core.annotation.AnnotationResults, fiftyone.core.brain.BrainResults, fiftyone.core.evaluation.EvaluationResults, fiftyone.core.runs.RunResults

Constructor: BaseRunResults(samples, config, key, backend)

View In Hierarchy

Base class for storing the results of a run.

Parameters
samples	the `fiftyone.core.collections.SampleCollection` used
config	the `BaseRunConfig` used
key	the key for the run
backend	a `BaseRun` instance. If not provided, one is instantiated from `config`

Class Method	`from_dict`	Builds a `BaseRunResults` from a JSON dict representation of it.
Static Method	`base_results_cls`	Returns the results class for the given run type.
Method	`__init__`	Undocumented
Method	`attributes`	Returns the list of class attributes that will be serialized by `serialize`.
Method	`save`	Saves the results to the database.
Method	`save_config`	Saves these results config to the database.
Property	`backend`	The `BaseRun` for these results.
Property	`cls`	The fully-qualified name of this `BaseRunResults` class.
Property	`config`	The `BaseRunConfig` for these results.
Property	`key`	The run key for these results.
Property	`samples`	The `fiftyone.core.collections.SampleCollection` associated with these results.
Class Method	`_from_dict`	Subclass implementation of `from_dict`.
Instance Variable	`_backend`	Undocumented
Instance Variable	`_config`	Undocumented
Instance Variable	`_key`	Undocumented
Instance Variable	`_samples`	Undocumented

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

Builds a BaseRunResults from a JSON dict representation of it.

Parameters
d	a JSON dict
samples	the `fiftyone.core.collections.SampleCollection` for the run
config	the `BaseRunConfig` for the run
key	the run key
Returns
a `BaseRunResults`

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

Returns the results class for the given run type.

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

def __init__(self, samples, config, key, backend=None): (source) ¶

overridden in fiftyone.core.runs.RunResults, fiftyone.utils.annotations.AnnotationResults, fiftyone.utils.eval.base.BaseEvaluationResults

Undocumented

def attributes(self): (source) ¶

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

Returns
a list of attributes

def save(self): (source) ¶

Saves the results to the database.

def save_config(self): (source) ¶

Saves these results config to the database.

@property
backend = (source) ¶

overridden in fiftyone.core.runs.RunResults, fiftyone.utils.annotations.AnnotationResults, fiftyone.utils.eval.base.BaseEvaluationResults

The BaseRun for these results.

@property
cls = (source) ¶

The fully-qualified name of this BaseRunResults class.

@property
config = (source) ¶

The BaseRunConfig for these results.

@property
key = (source) ¶

The run key for these results.

@property
samples = (source) ¶

The fiftyone.core.collections.SampleCollection associated with these results.

@classmethod
def _from_dict(cls, d, samples, config, key): (source) ¶

overridden in fiftyone.core.runs.RunResults, fiftyone.utils.annotations.AnnotationResults, fiftyone.utils.eval.base.BaseClassificationResults, fiftyone.utils.eval.regression.RegressionResults

Subclass implementation of from_dict.

Parameters
d	a JSON dict
samples	the `fiftyone.core.collections.SampleCollection` for the run
config	the `BaseRunConfig` for the run
key	the run key
Returns
a `BaseRunResults`

_backend = (source) ¶

Undocumented

_config = (source) ¶

Undocumented

_key = (source) ¶

Undocumented

_samples = (source) ¶

Undocumented