fiftyone.core.session.events¶

Session events.

Copyright 2017-2025, Voxel51, Inc.
voxel51.com

Classes:

`Event`()	Base server event
`LabelData`(label_id, field, sample_id, …)
`Screenshot`(bytes, max_width)
`CaptureNotebookCell`(subscription, src, width)	Capture notebook cell screenshot event
`CloseSession`()	Close session event
`DeactivateNotebookCell`()	Deactivate notebook cell event
`Ping`()	Ping (builtin) event
`ReactivateNotebookCell`(subscription)	Reactivate notebook cell event
`Refresh`(state)	Refresh event
`SelectLabels`(labels)	Select labels event
`SelectSamples`(sample_ids)	Select samples event
`ValueColor`(color, value)
`MaskColor`(color, intTarget)
`CustomizeColor`(path, fieldColor, …)
`ColorscaleList`(value, color)
`Colorscale`(path, name, list)
`DefaultColorscale`(name, list)
`LabelTagsColors`(fieldColor, valueColors)
`ColorScheme`(color_pool, color_by, …)
`SetColorScheme`(color_scheme)	Set color scheme event
`SetDatasetColorScheme`()	Set dataset color scheme event
`SetSample`(group_id, sample_id)	Set sample event
`SetSpaces`(spaces)	Set spaces event
`SetGroupSlice`(slice)	Set group slice eventt
`SetFieldVisibilityStage`(stage)
`StateUpdate`(state)	State update event
`AppInitializer`(dataset, group_id, …)
`ListenPayload`(initializer, None, …)	An initialization payload for an event listener request

Functions:

`add_screenshot`(event)
`dict_factory`(data)
`get_screenshot`(subscription[, pop])

class fiftyone.core.session.events.Event¶

Bases: object

Base server event

Methods:

`get_event_name`()
`from_data`(event_name, data)
`from_data_async`(event_name, data)
`serialize`()

classmethod get_event_name() → str¶

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

serialize()¶

class fiftyone.core.session.events.LabelData(label_id: str, field: str, sample_id: str, frame_number: Optional[int] = None, instance_id: Optional[str] = None)¶

Bases: object

Attributes:

`frame_number`
`instance_id`

label_id: str¶

field: str¶

sample_id: str¶

frame_number: Optional[int] = None¶

instance_id: Optional[str] = None¶

class fiftyone.core.session.events.Screenshot(bytes: bytes, max_width: int)¶

Bases: object

Attributes:

bytes: bytes¶

max_width: int¶

class fiftyone.core.session.events.CaptureNotebookCell(subscription: str, src: str, width: int)¶

Bases: fiftyone.core.session.events.Event

Capture notebook cell screenshot event

Attributes:

Methods:

`from_data`(event_name, data)
`from_data_async`(event_name, data)
`get_event_name`()
`serialize`()

subscription: str¶

src: str¶

width: int¶

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

classmethod get_event_name() → str¶

serialize()¶

class fiftyone.core.session.events.CloseSession¶

Bases: fiftyone.core.session.events.Event

Close session event

Methods:

`from_data`(event_name, data)
`from_data_async`(event_name, data)
`get_event_name`()
`serialize`()

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

classmethod get_event_name() → str¶

serialize()¶

class fiftyone.core.session.events.DeactivateNotebookCell¶

Bases: fiftyone.core.session.events.Event

Deactivate notebook cell event

Methods:

`from_data`(event_name, data)
`from_data_async`(event_name, data)
`get_event_name`()
`serialize`()

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

classmethod get_event_name() → str¶

serialize()¶

class fiftyone.core.session.events.Ping¶

Bases: fiftyone.core.session.events.Event

Ping (builtin) event

Methods:

`from_data`(event_name, data)
`from_data_async`(event_name, data)
`get_event_name`()
`serialize`()

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

classmethod get_event_name() → str¶

serialize()¶

class fiftyone.core.session.events.ReactivateNotebookCell(subscription: str)¶

Bases: fiftyone.core.session.events.Event

Reactivate notebook cell event

Attributes:

Methods:

`from_data`(event_name, data)
`from_data_async`(event_name, data)
`get_event_name`()
`serialize`()

subscription: str¶

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

classmethod get_event_name() → str¶

serialize()¶

class fiftyone.core.session.events.Refresh(state: fiftyone.core.state.StateDescription)¶

Bases: fiftyone.core.session.events.Event

Refresh event

Attributes:

Methods:

`from_data`(event_name, data)
`from_data_async`(event_name, data)
`get_event_name`()
`serialize`()

state: fiftyone.core.state.StateDescription¶

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

classmethod get_event_name() → str¶

serialize()¶

class fiftyone.core.session.events.SelectLabels(labels: List[fiftyone.core.session.events.LabelData])¶

Bases: fiftyone.core.session.events.Event

Select labels event

Attributes:

Methods:

`from_data`(event_name, data)
`from_data_async`(event_name, data)
`get_event_name`()
`serialize`()

labels: List[fiftyone.core.session.events.LabelData]¶

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

classmethod get_event_name() → str¶

serialize()¶

class fiftyone.core.session.events.SelectSamples(sample_ids: List[str])¶

Bases: fiftyone.core.session.events.Event

Select samples event

Attributes:

Methods:

`from_data`(event_name, data)
`from_data_async`(event_name, data)
`get_event_name`()
`serialize`()

sample_ids: List[str]¶

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

classmethod get_event_name() → str¶

serialize()¶

class fiftyone.core.session.events.ValueColor(color: str, value: str)¶

Bases: object

Attributes:

color: str¶

value: str¶

class fiftyone.core.session.events.MaskColor(color: str, intTarget: Optional[int])¶

Bases: object

Attributes:

color: str¶

intTarget: Optional[int]¶

class fiftyone.core.session.events.CustomizeColor(path: str, fieldColor: Optional[str] = None, colorByAttribute: Optional[str] = None, valueColors: Optional[List[fiftyone.core.session.events.ValueColor]] = None, maskTargetsColors: Optional[List[fiftyone.core.session.events.MaskColor]] = None)¶

Bases: object

Attributes:

`fieldColor`
`colorByAttribute`
`valueColors`
`maskTargetsColors`

path: str¶

fieldColor: Optional[str] = None¶

colorByAttribute: Optional[str] = None¶

valueColors: Optional[List[fiftyone.core.session.events.ValueColor]] = None¶

maskTargetsColors: Optional[List[fiftyone.core.session.events.MaskColor]] = None¶

class fiftyone.core.session.events.ColorscaleList(value: float, color: str)¶

Bases: object

Attributes:

value: float¶

color: str¶

class fiftyone.core.session.events.Colorscale(path: str, name: Optional[str] = None, list: Optional[List[fiftyone.core.session.events.ColorscaleList]] = None)¶

Bases: object

Attributes:

`name`
`list`

Methods:

serialize()

path: str¶

name: Optional[str] = None¶

list: Optional[List[fiftyone.core.session.events.ColorscaleList]] = None¶

serialize()¶

class fiftyone.core.session.events.DefaultColorscale(name: Optional[str] = None, list: Optional[List[fiftyone.core.session.events.ColorscaleList]] = None)¶

Bases: object

Attributes:

`name`
`list`

Methods:

serialize()

name: Optional[str] = None¶

list: Optional[List[fiftyone.core.session.events.ColorscaleList]] = None¶

serialize()¶

class fiftyone.core.session.events.LabelTagsColors(fieldColor: Optional[str] = None, valueColors: Optional[List[fiftyone.core.session.events.ValueColor]] = None)¶

Bases: object

Attributes:

`fieldColor`
`valueColors`

fieldColor: Optional[str] = None¶

valueColors: Optional[List[fiftyone.core.session.events.ValueColor]] = None¶

class fiftyone.core.session.events.ColorScheme(color_pool: Optional[List[str]] = None, color_by: Optional[str] = None, multicolor_keypoints: Optional[bool] = None, opacity: Optional[float] = None, show_skeletons: Optional[bool] = None, fields: Optional[List[fiftyone.core.session.events.CustomizeColor]] = None, default_mask_targets_colors: Optional[List[fiftyone.core.session.events.MaskColor]] = None, colorscales: Optional[List[fiftyone.core.session.events.Colorscale]] = None, default_colorscale: Optional[fiftyone.core.session.events.DefaultColorscale] = None, label_tags: Optional[fiftyone.core.session.events.LabelTagsColors] = None)¶

Bases: object

Attributes:

`color_pool`
`color_by`
`multicolor_keypoints`
`opacity`
`show_skeletons`
`fields`
`default_mask_targets_colors`
`colorscales`
`default_colorscale`
`label_tags`

Methods:

serialize()

color_pool: Optional[List[str]] = None¶

color_by: Optional[str] = None¶

multicolor_keypoints: Optional[bool] = None¶

opacity: Optional[float] = None¶

show_skeletons: Optional[bool] = None¶

fields: Optional[List[fiftyone.core.session.events.CustomizeColor]] = None¶

default_mask_targets_colors: Optional[List[fiftyone.core.session.events.MaskColor]] = None¶

colorscales: Optional[List[fiftyone.core.session.events.Colorscale]] = None¶

default_colorscale: Optional[fiftyone.core.session.events.DefaultColorscale] = None¶

label_tags: Optional[fiftyone.core.session.events.LabelTagsColors] = None¶

serialize()¶

class fiftyone.core.session.events.SetColorScheme(color_scheme: fiftyone.core.session.events.ColorScheme)¶

Bases: fiftyone.core.session.events.Event

Set color scheme event

Attributes:

Methods:

`from_odm`(color_scheme)
`to_odm`()
`from_data`(event_name, data)
`from_data_async`(event_name, data)
`get_event_name`()
`serialize`()

color_scheme: fiftyone.core.session.events.ColorScheme¶

classmethod from_odm(color_scheme: fiftyone.core.odm.dataset.ColorScheme)¶

to_odm()¶

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

classmethod get_event_name() → str¶

serialize()¶

class fiftyone.core.session.events.SetDatasetColorScheme¶

Bases: fiftyone.core.session.events.Event

Set dataset color scheme event

Methods:

`from_data`(event_name, data)
`from_data_async`(event_name, data)
`get_event_name`()
`serialize`()

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

classmethod get_event_name() → str¶

serialize()¶

class fiftyone.core.session.events.SetSample(group_id: Optional[str] = None, sample_id: Optional[str] = None)¶

Bases: fiftyone.core.session.events.Event

Set sample event

Attributes:

`group_id`
`sample_id`

Methods:

`from_data`(event_name, data)
`from_data_async`(event_name, data)
`get_event_name`()
`serialize`()

group_id: Optional[str] = None¶

sample_id: Optional[str] = None¶

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

classmethod get_event_name() → str¶

serialize()¶

class fiftyone.core.session.events.SetSpaces(spaces: Dict)¶

Bases: fiftyone.core.session.events.Event

Set spaces event

Attributes:

Methods:

`from_data`(event_name, data)
`from_data_async`(event_name, data)
`get_event_name`()
`serialize`()

spaces: Dict¶

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

classmethod get_event_name() → str¶

serialize()¶

class fiftyone.core.session.events.SetGroupSlice(slice: str)¶

Bases: fiftyone.core.session.events.Event

Set group slice eventt

Attributes:

Methods:

`from_data`(event_name, data)
`from_data_async`(event_name, data)
`get_event_name`()
`serialize`()

slice: str¶

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

classmethod get_event_name() → str¶

serialize()¶

class fiftyone.core.session.events.SetFieldVisibilityStage(stage: Optional[Dict] = None)¶

Bases: fiftyone.core.session.events.Event

Attributes:

stage

Methods:

`from_data`(event_name, data)
`from_data_async`(event_name, data)
`get_event_name`()
`serialize`()

stage: Optional[Dict] = None¶

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

classmethod get_event_name() → str¶

serialize()¶

class fiftyone.core.session.events.StateUpdate(state: fiftyone.core.state.StateDescription)¶

Bases: fiftyone.core.session.events.Event

State update event

Attributes:

Methods:

`from_data`(event_name, data)
`from_data_async`(event_name, data)
`get_event_name`()
`serialize`()

state: fiftyone.core.state.StateDescription¶

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.SelectSamples, fiftyone.core.session.events.SelectLabels, fiftyone.core.session.events.SetColorScheme, fiftyone.core.session.events.SetGroupSlice, fiftyone.core.session.events.SetSample, fiftyone.core.session.events.SetSpaces, fiftyone.core.session.events.StateUpdate, fiftyone.core.session.events.SetFieldVisibilityStage]¶

classmethod get_event_name() → str¶

serialize()¶

class fiftyone.core.session.events.AppInitializer(dataset: Optional[str] = None, group_id: Optional[str] = None, group_slice: Optional[str] = None, sample_id: Optional[str] = None, view: Optional[str] = None, workspace: Optional[str] = None)¶

Bases: object

Attributes:

`dataset`
`group_id`
`group_slice`
`sample_id`
`view`
`workspace`

dataset: Optional[str] = None¶

group_id: Optional[str] = None¶

group_slice: Optional[str] = None¶

sample_id: Optional[str] = None¶

view: Optional[str] = None¶

workspace: Optional[str] = None¶

class fiftyone.core.session.events.ListenPayload(initializer: Union[fiftyone.core.session.events.AppInitializer, None, fiftyone.core.state.StateDescription], events: List[str], subscription: str, polling: Optional[bool] = False)¶

Bases: object

An initialization payload for an event listener request

Attributes:

polling

Methods:

from_dict(d)

initializer: Union[fiftyone.core.session.events.AppInitializer, None, fiftyone.core.state.StateDescription]¶

events: List[str]¶

subscription: str¶

polling: Optional[bool] = False¶

async classmethod from_dict(d: dict) → fiftyone.core.session.events.ListenPayload ¶

fiftyone.core.session.events.add_screenshot(event: fiftyone.core.session.events.CaptureNotebookCell) → None¶

fiftyone.core.session.events.dict_factory(data: List[Tuple[str, Any]]) → Dict[str, Any]¶

fiftyone.core.session.events.get_screenshot(subscription: str, pop=False) → fiftyone.core.session.events.Screenshot ¶