fiftyone.core.state.StateDescription

class documentation

class StateDescription(etas.Serializable): (source)

Constructor: StateDescription(color_scheme, config, dataset, field_visibility_stage, ...)

View In Hierarchy

Class that describes the shared state between the FiftyOne App and a corresponding fiftyone.core.session.Session.

Parameters
color_schemea fiftyone.core.odm.dataset.ColorScheme
configan optional fiftyone.core.config.AppConfig
datasetthe current fiftyone.core.dataset.Dataset
field_visibility_stagea field visibility stage
group_ida fiftyone.core.groups.Group.id
group_slicea fiftyone.core.groups.Group.name
sample_ida fiftyone.core.sample.Sample.id
selectedthe list of currently selected samples
selected_labelsthe list of currently selected labels
spacesa fiftyone.core.odm.workspace.Space
viewthe current fiftyone.core.view.DatasetView
view_namethe name of the view if the current view is a saved view
Class Method from_dict Constructs a StateDescription from a JSON dictionary.
Method __init__ Undocumented
Method attributes Undocumented
Method serialize Undocumented
Instance Variable color_scheme Undocumented
Instance Variable config Undocumented
Instance Variable dataset Undocumented
Instance Variable field_visibility_stage Undocumented
Instance Variable group_id Undocumented
Instance Variable group_slice Undocumented
Instance Variable sample_id Undocumented
Instance Variable selected Undocumented
Instance Variable selected_labels Undocumented
Instance Variable spaces Undocumented
Instance Variable view Undocumented
@classmethod
def from_dict(cls, d): (source)

Constructs a StateDescription from a JSON dictionary.

Parameters
da JSON dictionary
Returns
StateDescription
def __init__(self, color_scheme=None, config=None, dataset=None, field_visibility_stage=None, group_id=None, group_slice=None, sample_id=None, selected=None, selected_labels=None, spaces=None, view=None, view_name=None): (source)

Undocumented

def attributes(self): (source)

Undocumented

def serialize(self, reflective=True): (source)

Undocumented

color_scheme: None = (source)

Undocumented

config: None = (source)

Undocumented

dataset: None = (source)

Undocumented

field_visibility_stage: None = (source)

Undocumented

group_id: None = (source)

Undocumented

group_slice: None = (source)

Undocumented

sample_id: None = (source)

Undocumented

selected: None = (source)

Undocumented

selected_labels: None = (source)

Undocumented

spaces: None = (source)

Undocumented

view: None = (source)

Undocumented