<!-- # hard line break macro for HTML -->

# fiftyone.core.session

* [fiftyone.core.session.client](fiftyone.core.session.client.md)
  * [`Client`](fiftyone.core.session.client.md#fiftyone.core.session.client.Client)
    * [`Client.address`](fiftyone.core.session.client.md#fiftyone.core.session.client.Client.address)
    * [`Client.auto`](fiftyone.core.session.client.md#fiftyone.core.session.client.Client.auto)
    * [`Client.port`](fiftyone.core.session.client.md#fiftyone.core.session.client.Client.port)
    * [`Client.remote`](fiftyone.core.session.client.md#fiftyone.core.session.client.Client.remote)
    * [`Client.start_time`](fiftyone.core.session.client.md#fiftyone.core.session.client.Client.start_time)
    * [`Client.origin`](fiftyone.core.session.client.md#fiftyone.core.session.client.Client.origin)
    * [`Client.is_open`](fiftyone.core.session.client.md#fiftyone.core.session.client.Client.is_open)
    * [`Client.open()`](fiftyone.core.session.client.md#fiftyone.core.session.client.Client.open)
    * [`Client.close()`](fiftyone.core.session.client.md#fiftyone.core.session.client.Client.close)
    * [`Client.send_event()`](fiftyone.core.session.client.md#fiftyone.core.session.client.Client.send_event)
    * [`Client.add_event_listener()`](fiftyone.core.session.client.md#fiftyone.core.session.client.Client.add_event_listener)
    * [`Client.remove_event_listener()`](fiftyone.core.session.client.md#fiftyone.core.session.client.Client.remove_event_listener)
* [fiftyone.core.session.constants](fiftyone.core.session.constants.md)
* [fiftyone.core.session.events](fiftyone.core.session.events.md)
  * [`Event`](fiftyone.core.session.events.md#fiftyone.core.session.events.Event)
    * [`Event.get_event_name()`](fiftyone.core.session.events.md#fiftyone.core.session.events.Event.get_event_name)
    * [`Event.from_data()`](fiftyone.core.session.events.md#fiftyone.core.session.events.Event.from_data)
    * [`Event.from_data_async()`](fiftyone.core.session.events.md#fiftyone.core.session.events.Event.from_data_async)
    * [`Event.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.Event.serialize)
  * [`LabelData`](fiftyone.core.session.events.md#fiftyone.core.session.events.LabelData)
    * [`LabelData.label_id`](fiftyone.core.session.events.md#fiftyone.core.session.events.LabelData.label_id)
    * [`LabelData.field`](fiftyone.core.session.events.md#fiftyone.core.session.events.LabelData.field)
    * [`LabelData.sample_id`](fiftyone.core.session.events.md#fiftyone.core.session.events.LabelData.sample_id)
    * [`LabelData.frame_number`](fiftyone.core.session.events.md#fiftyone.core.session.events.LabelData.frame_number)
    * [`LabelData.instance_id`](fiftyone.core.session.events.md#fiftyone.core.session.events.LabelData.instance_id)
    * [`LabelData.type`](fiftyone.core.session.events.md#fiftyone.core.session.events.LabelData.type)
  * [`Screenshot`](fiftyone.core.session.events.md#fiftyone.core.session.events.Screenshot)
    * [`Screenshot.bytes`](fiftyone.core.session.events.md#fiftyone.core.session.events.Screenshot.bytes)
    * [`Screenshot.max_width`](fiftyone.core.session.events.md#fiftyone.core.session.events.Screenshot.max_width)
  * [`CaptureNotebookCell`](fiftyone.core.session.events.md#fiftyone.core.session.events.CaptureNotebookCell)
    * [`CaptureNotebookCell.subscription`](fiftyone.core.session.events.md#fiftyone.core.session.events.CaptureNotebookCell.subscription)
    * [`CaptureNotebookCell.src`](fiftyone.core.session.events.md#fiftyone.core.session.events.CaptureNotebookCell.src)
    * [`CaptureNotebookCell.width`](fiftyone.core.session.events.md#fiftyone.core.session.events.CaptureNotebookCell.width)
    * [`CaptureNotebookCell.from_data()`](fiftyone.core.session.events.md#fiftyone.core.session.events.CaptureNotebookCell.from_data)
    * [`CaptureNotebookCell.from_data_async()`](fiftyone.core.session.events.md#fiftyone.core.session.events.CaptureNotebookCell.from_data_async)
    * [`CaptureNotebookCell.get_event_name()`](fiftyone.core.session.events.md#fiftyone.core.session.events.CaptureNotebookCell.get_event_name)
    * [`CaptureNotebookCell.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.CaptureNotebookCell.serialize)
  * [`CloseSession`](fiftyone.core.session.events.md#fiftyone.core.session.events.CloseSession)
    * [`CloseSession.from_data()`](fiftyone.core.session.events.md#fiftyone.core.session.events.CloseSession.from_data)
    * [`CloseSession.from_data_async()`](fiftyone.core.session.events.md#fiftyone.core.session.events.CloseSession.from_data_async)
    * [`CloseSession.get_event_name()`](fiftyone.core.session.events.md#fiftyone.core.session.events.CloseSession.get_event_name)
    * [`CloseSession.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.CloseSession.serialize)
  * [`DeactivateNotebookCell`](fiftyone.core.session.events.md#fiftyone.core.session.events.DeactivateNotebookCell)
    * [`DeactivateNotebookCell.from_data()`](fiftyone.core.session.events.md#fiftyone.core.session.events.DeactivateNotebookCell.from_data)
    * [`DeactivateNotebookCell.from_data_async()`](fiftyone.core.session.events.md#fiftyone.core.session.events.DeactivateNotebookCell.from_data_async)
    * [`DeactivateNotebookCell.get_event_name()`](fiftyone.core.session.events.md#fiftyone.core.session.events.DeactivateNotebookCell.get_event_name)
    * [`DeactivateNotebookCell.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.DeactivateNotebookCell.serialize)
  * [`Ping`](fiftyone.core.session.events.md#fiftyone.core.session.events.Ping)
    * [`Ping.from_data()`](fiftyone.core.session.events.md#fiftyone.core.session.events.Ping.from_data)
    * [`Ping.from_data_async()`](fiftyone.core.session.events.md#fiftyone.core.session.events.Ping.from_data_async)
    * [`Ping.get_event_name()`](fiftyone.core.session.events.md#fiftyone.core.session.events.Ping.get_event_name)
    * [`Ping.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.Ping.serialize)
  * [`ReactivateNotebookCell`](fiftyone.core.session.events.md#fiftyone.core.session.events.ReactivateNotebookCell)
    * [`ReactivateNotebookCell.subscription`](fiftyone.core.session.events.md#fiftyone.core.session.events.ReactivateNotebookCell.subscription)
    * [`ReactivateNotebookCell.from_data()`](fiftyone.core.session.events.md#fiftyone.core.session.events.ReactivateNotebookCell.from_data)
    * [`ReactivateNotebookCell.from_data_async()`](fiftyone.core.session.events.md#fiftyone.core.session.events.ReactivateNotebookCell.from_data_async)
    * [`ReactivateNotebookCell.get_event_name()`](fiftyone.core.session.events.md#fiftyone.core.session.events.ReactivateNotebookCell.get_event_name)
    * [`ReactivateNotebookCell.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.ReactivateNotebookCell.serialize)
  * [`Refresh`](fiftyone.core.session.events.md#fiftyone.core.session.events.Refresh)
    * [`Refresh.state`](fiftyone.core.session.events.md#fiftyone.core.session.events.Refresh.state)
    * [`Refresh.from_data()`](fiftyone.core.session.events.md#fiftyone.core.session.events.Refresh.from_data)
    * [`Refresh.from_data_async()`](fiftyone.core.session.events.md#fiftyone.core.session.events.Refresh.from_data_async)
    * [`Refresh.get_event_name()`](fiftyone.core.session.events.md#fiftyone.core.session.events.Refresh.get_event_name)
    * [`Refresh.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.Refresh.serialize)
  * [`SelectLabels`](fiftyone.core.session.events.md#fiftyone.core.session.events.SelectLabels)
    * [`SelectLabels.labels`](fiftyone.core.session.events.md#fiftyone.core.session.events.SelectLabels.labels)
    * [`SelectLabels.from_data()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SelectLabels.from_data)
    * [`SelectLabels.from_data_async()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SelectLabels.from_data_async)
    * [`SelectLabels.get_event_name()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SelectLabels.get_event_name)
    * [`SelectLabels.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SelectLabels.serialize)
  * [`SelectSamples`](fiftyone.core.session.events.md#fiftyone.core.session.events.SelectSamples)
    * [`SelectSamples.samples`](fiftyone.core.session.events.md#fiftyone.core.session.events.SelectSamples.samples)
    * [`SelectSamples.from_data()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SelectSamples.from_data)
    * [`SelectSamples.from_data_async()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SelectSamples.from_data_async)
    * [`SelectSamples.get_event_name()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SelectSamples.get_event_name)
    * [`SelectSamples.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SelectSamples.serialize)
  * [`SetSampleSelectionStyle`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetSampleSelectionStyle)
    * [`SetSampleSelectionStyle.style`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetSampleSelectionStyle.style)
    * [`SetSampleSelectionStyle.style`](fiftyone.core.session.events.md#id0)
    * [`SetSampleSelectionStyle.from_data()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetSampleSelectionStyle.from_data)
    * [`SetSampleSelectionStyle.from_data_async()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetSampleSelectionStyle.from_data_async)
    * [`SetSampleSelectionStyle.get_event_name()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetSampleSelectionStyle.get_event_name)
    * [`SetSampleSelectionStyle.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetSampleSelectionStyle.serialize)
  * [`SetLabelSelectionStyle`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetLabelSelectionStyle)
    * [`SetLabelSelectionStyle.style`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetLabelSelectionStyle.style)
    * [`SetLabelSelectionStyle.style`](fiftyone.core.session.events.md#id1)
    * [`SetLabelSelectionStyle.from_data()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetLabelSelectionStyle.from_data)
    * [`SetLabelSelectionStyle.from_data_async()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetLabelSelectionStyle.from_data_async)
    * [`SetLabelSelectionStyle.get_event_name()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetLabelSelectionStyle.get_event_name)
    * [`SetLabelSelectionStyle.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetLabelSelectionStyle.serialize)
  * [`ValueColor`](fiftyone.core.session.events.md#fiftyone.core.session.events.ValueColor)
    * [`ValueColor.color`](fiftyone.core.session.events.md#fiftyone.core.session.events.ValueColor.color)
    * [`ValueColor.value`](fiftyone.core.session.events.md#fiftyone.core.session.events.ValueColor.value)
  * [`MaskColor`](fiftyone.core.session.events.md#fiftyone.core.session.events.MaskColor)
    * [`MaskColor.color`](fiftyone.core.session.events.md#fiftyone.core.session.events.MaskColor.color)
    * [`MaskColor.intTarget`](fiftyone.core.session.events.md#fiftyone.core.session.events.MaskColor.intTarget)
  * [`CustomizeColor`](fiftyone.core.session.events.md#fiftyone.core.session.events.CustomizeColor)
    * [`CustomizeColor.path`](fiftyone.core.session.events.md#fiftyone.core.session.events.CustomizeColor.path)
    * [`CustomizeColor.fieldColor`](fiftyone.core.session.events.md#fiftyone.core.session.events.CustomizeColor.fieldColor)
    * [`CustomizeColor.colorByAttribute`](fiftyone.core.session.events.md#fiftyone.core.session.events.CustomizeColor.colorByAttribute)
    * [`CustomizeColor.valueColors`](fiftyone.core.session.events.md#fiftyone.core.session.events.CustomizeColor.valueColors)
    * [`CustomizeColor.maskTargetsColors`](fiftyone.core.session.events.md#fiftyone.core.session.events.CustomizeColor.maskTargetsColors)
  * [`ColorscaleList`](fiftyone.core.session.events.md#fiftyone.core.session.events.ColorscaleList)
    * [`ColorscaleList.value`](fiftyone.core.session.events.md#fiftyone.core.session.events.ColorscaleList.value)
    * [`ColorscaleList.color`](fiftyone.core.session.events.md#fiftyone.core.session.events.ColorscaleList.color)
  * [`Colorscale`](fiftyone.core.session.events.md#fiftyone.core.session.events.Colorscale)
    * [`Colorscale.path`](fiftyone.core.session.events.md#fiftyone.core.session.events.Colorscale.path)
    * [`Colorscale.name`](fiftyone.core.session.events.md#fiftyone.core.session.events.Colorscale.name)
    * [`Colorscale.list`](fiftyone.core.session.events.md#fiftyone.core.session.events.Colorscale.list)
    * [`Colorscale.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.Colorscale.serialize)
  * [`DefaultColorscale`](fiftyone.core.session.events.md#fiftyone.core.session.events.DefaultColorscale)
    * [`DefaultColorscale.name`](fiftyone.core.session.events.md#fiftyone.core.session.events.DefaultColorscale.name)
    * [`DefaultColorscale.list`](fiftyone.core.session.events.md#fiftyone.core.session.events.DefaultColorscale.list)
    * [`DefaultColorscale.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.DefaultColorscale.serialize)
  * [`LabelTagsColors`](fiftyone.core.session.events.md#fiftyone.core.session.events.LabelTagsColors)
    * [`LabelTagsColors.fieldColor`](fiftyone.core.session.events.md#fiftyone.core.session.events.LabelTagsColors.fieldColor)
    * [`LabelTagsColors.valueColors`](fiftyone.core.session.events.md#fiftyone.core.session.events.LabelTagsColors.valueColors)
  * [`ColorScheme`](fiftyone.core.session.events.md#fiftyone.core.session.events.ColorScheme)
    * [`ColorScheme.color_pool`](fiftyone.core.session.events.md#fiftyone.core.session.events.ColorScheme.color_pool)
    * [`ColorScheme.color_by`](fiftyone.core.session.events.md#fiftyone.core.session.events.ColorScheme.color_by)
    * [`ColorScheme.multicolor_keypoints`](fiftyone.core.session.events.md#fiftyone.core.session.events.ColorScheme.multicolor_keypoints)
    * [`ColorScheme.opacity`](fiftyone.core.session.events.md#fiftyone.core.session.events.ColorScheme.opacity)
    * [`ColorScheme.show_skeletons`](fiftyone.core.session.events.md#fiftyone.core.session.events.ColorScheme.show_skeletons)
    * [`ColorScheme.fields`](fiftyone.core.session.events.md#fiftyone.core.session.events.ColorScheme.fields)
    * [`ColorScheme.default_mask_targets_colors`](fiftyone.core.session.events.md#fiftyone.core.session.events.ColorScheme.default_mask_targets_colors)
    * [`ColorScheme.colorscales`](fiftyone.core.session.events.md#fiftyone.core.session.events.ColorScheme.colorscales)
    * [`ColorScheme.default_colorscale`](fiftyone.core.session.events.md#fiftyone.core.session.events.ColorScheme.default_colorscale)
    * [`ColorScheme.label_tags`](fiftyone.core.session.events.md#fiftyone.core.session.events.ColorScheme.label_tags)
    * [`ColorScheme.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.ColorScheme.serialize)
  * [`SetColorScheme`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetColorScheme)
    * [`SetColorScheme.color_scheme`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetColorScheme.color_scheme)
    * [`SetColorScheme.from_odm()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetColorScheme.from_odm)
    * [`SetColorScheme.to_odm()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetColorScheme.to_odm)
    * [`SetColorScheme.from_data()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetColorScheme.from_data)
    * [`SetColorScheme.from_data_async()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetColorScheme.from_data_async)
    * [`SetColorScheme.get_event_name()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetColorScheme.get_event_name)
    * [`SetColorScheme.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetColorScheme.serialize)
  * [`SetDatasetColorScheme`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetDatasetColorScheme)
    * [`SetDatasetColorScheme.from_data()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetDatasetColorScheme.from_data)
    * [`SetDatasetColorScheme.from_data_async()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetDatasetColorScheme.from_data_async)
    * [`SetDatasetColorScheme.get_event_name()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetDatasetColorScheme.get_event_name)
    * [`SetDatasetColorScheme.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetDatasetColorScheme.serialize)
  * [`SetSample`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetSample)
    * [`SetSample.group_id`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetSample.group_id)
    * [`SetSample.sample_id`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetSample.sample_id)
    * [`SetSample.from_data()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetSample.from_data)
    * [`SetSample.from_data_async()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetSample.from_data_async)
    * [`SetSample.get_event_name()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetSample.get_event_name)
    * [`SetSample.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetSample.serialize)
  * [`SetSpaces`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetSpaces)
    * [`SetSpaces.spaces`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetSpaces.spaces)
    * [`SetSpaces.from_data()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetSpaces.from_data)
    * [`SetSpaces.from_data_async()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetSpaces.from_data_async)
    * [`SetSpaces.get_event_name()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetSpaces.get_event_name)
    * [`SetSpaces.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetSpaces.serialize)
  * [`SetGroupSlice`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetGroupSlice)
    * [`SetGroupSlice.slice`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetGroupSlice.slice)
    * [`SetGroupSlice.from_data()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetGroupSlice.from_data)
    * [`SetGroupSlice.from_data_async()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetGroupSlice.from_data_async)
    * [`SetGroupSlice.get_event_name()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetGroupSlice.get_event_name)
    * [`SetGroupSlice.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetGroupSlice.serialize)
  * [`SetFieldVisibilityStage`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetFieldVisibilityStage)
    * [`SetFieldVisibilityStage.stage`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetFieldVisibilityStage.stage)
    * [`SetFieldVisibilityStage.from_data()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetFieldVisibilityStage.from_data)
    * [`SetFieldVisibilityStage.from_data_async()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetFieldVisibilityStage.from_data_async)
    * [`SetFieldVisibilityStage.get_event_name()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetFieldVisibilityStage.get_event_name)
    * [`SetFieldVisibilityStage.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.SetFieldVisibilityStage.serialize)
  * [`StateUpdate`](fiftyone.core.session.events.md#fiftyone.core.session.events.StateUpdate)
    * [`StateUpdate.state`](fiftyone.core.session.events.md#fiftyone.core.session.events.StateUpdate.state)
    * [`StateUpdate.from_data()`](fiftyone.core.session.events.md#fiftyone.core.session.events.StateUpdate.from_data)
    * [`StateUpdate.from_data_async()`](fiftyone.core.session.events.md#fiftyone.core.session.events.StateUpdate.from_data_async)
    * [`StateUpdate.get_event_name()`](fiftyone.core.session.events.md#fiftyone.core.session.events.StateUpdate.get_event_name)
    * [`StateUpdate.serialize()`](fiftyone.core.session.events.md#fiftyone.core.session.events.StateUpdate.serialize)
  * [`AppInitializer`](fiftyone.core.session.events.md#fiftyone.core.session.events.AppInitializer)
    * [`AppInitializer.dataset`](fiftyone.core.session.events.md#fiftyone.core.session.events.AppInitializer.dataset)
    * [`AppInitializer.group_id`](fiftyone.core.session.events.md#fiftyone.core.session.events.AppInitializer.group_id)
    * [`AppInitializer.group_slice`](fiftyone.core.session.events.md#fiftyone.core.session.events.AppInitializer.group_slice)
    * [`AppInitializer.sample_id`](fiftyone.core.session.events.md#fiftyone.core.session.events.AppInitializer.sample_id)
    * [`AppInitializer.view`](fiftyone.core.session.events.md#fiftyone.core.session.events.AppInitializer.view)
    * [`AppInitializer.workspace`](fiftyone.core.session.events.md#fiftyone.core.session.events.AppInitializer.workspace)
  * [`ListenPayload`](fiftyone.core.session.events.md#fiftyone.core.session.events.ListenPayload)
    * [`ListenPayload.initializer`](fiftyone.core.session.events.md#fiftyone.core.session.events.ListenPayload.initializer)
    * [`ListenPayload.events`](fiftyone.core.session.events.md#fiftyone.core.session.events.ListenPayload.events)
    * [`ListenPayload.subscription`](fiftyone.core.session.events.md#fiftyone.core.session.events.ListenPayload.subscription)
    * [`ListenPayload.polling`](fiftyone.core.session.events.md#fiftyone.core.session.events.ListenPayload.polling)
    * [`ListenPayload.from_dict()`](fiftyone.core.session.events.md#fiftyone.core.session.events.ListenPayload.from_dict)
  * [`add_screenshot()`](fiftyone.core.session.events.md#fiftyone.core.session.events.add_screenshot)
  * [`dict_factory()`](fiftyone.core.session.events.md#fiftyone.core.session.events.dict_factory)
  * [`get_screenshot()`](fiftyone.core.session.events.md#fiftyone.core.session.events.get_screenshot)
* [fiftyone.core.session.notebooks](fiftyone.core.session.notebooks.md)
  * [`NotebookCell`](fiftyone.core.session.notebooks.md#fiftyone.core.session.notebooks.NotebookCell)
    * [`NotebookCell.address`](fiftyone.core.session.notebooks.md#fiftyone.core.session.notebooks.NotebookCell.address)
    * [`NotebookCell.height`](fiftyone.core.session.notebooks.md#fiftyone.core.session.notebooks.NotebookCell.height)
    * [`NotebookCell.handle`](fiftyone.core.session.notebooks.md#fiftyone.core.session.notebooks.NotebookCell.handle)
    * [`NotebookCell.port`](fiftyone.core.session.notebooks.md#fiftyone.core.session.notebooks.NotebookCell.port)
    * [`NotebookCell.subscription`](fiftyone.core.session.notebooks.md#fiftyone.core.session.notebooks.NotebookCell.subscription)
  * [`capture()`](fiftyone.core.session.notebooks.md#fiftyone.core.session.notebooks.capture)
  * [`display()`](fiftyone.core.session.notebooks.md#fiftyone.core.session.notebooks.display)
  * [`display_ipython()`](fiftyone.core.session.notebooks.md#fiftyone.core.session.notebooks.display_ipython)
  * [`display_colab()`](fiftyone.core.session.notebooks.md#fiftyone.core.session.notebooks.display_colab)
  * [`display_databricks()`](fiftyone.core.session.notebooks.md#fiftyone.core.session.notebooks.display_databricks)
* [fiftyone.core.session.session](fiftyone.core.session.session.md)
  * [`launch_app()`](fiftyone.core.session.session.md#fiftyone.core.session.session.launch_app)
  * [`close_app()`](fiftyone.core.session.session.md#fiftyone.core.session.session.close_app)
  * [`update_state()`](fiftyone.core.session.session.md#fiftyone.core.session.session.update_state)
  * [`Session`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session)
    * [`Session.auto`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.auto)
    * [`Session.server_port`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.server_port)
    * [`Session.server_address`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.server_address)
    * [`Session.remote`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.remote)
    * [`Session.url`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.url)
    * [`Session.config`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.config)
    * [`Session.group_id`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.group_id)
    * [`Session.sample_id`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.sample_id)
    * [`Session.spaces`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.spaces)
    * [`Session.load_workspace()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.load_workspace)
    * [`Session.color_scheme`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.color_scheme)
    * [`Session.dataset`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.dataset)
    * [`Session.clear_dataset()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.clear_dataset)
    * [`Session.view`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.view)
    * [`Session.clear_view()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.clear_view)
    * [`Session.has_plots`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.has_plots)
    * [`Session.plots`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.plots)
    * [`Session.refresh()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.refresh)
    * [`Session.selected`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.selected)
    * [`Session.selected_samples`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.selected_samples)
    * [`Session.clear_selected()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.clear_selected)
    * [`Session.select_samples()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.select_samples)
    * [`Session.sample_selection_style`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.sample_selection_style)
    * [`Session.set_sample_selection_style()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.set_sample_selection_style)
    * [`Session.clear_sample_selection_style()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.clear_sample_selection_style)
    * [`Session.label_selection_style`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.label_selection_style)
    * [`Session.set_label_selection_style()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.set_label_selection_style)
    * [`Session.clear_label_selection_style()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.clear_label_selection_style)
    * [`Session.selected_labels`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.selected_labels)
    * [`Session.select_labels()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.select_labels)
    * [`Session.clear_selected_labels()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.clear_selected_labels)
    * [`Session.tag_selected_samples()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.tag_selected_samples)
    * [`Session.untag_selected_samples()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.untag_selected_samples)
    * [`Session.tag_selected_labels()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.tag_selected_labels)
    * [`Session.untag_selected_labels()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.untag_selected_labels)
    * [`Session.selected_view`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.selected_view)
    * [`Session.summary()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.summary)
    * [`Session.open()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.open)
    * [`Session.open_tab()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.open_tab)
    * [`Session.show()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.show)
    * [`Session.no_show()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.no_show)
    * [`Session.wait()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.wait)
    * [`Session.close()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.close)
    * [`Session.freeze()`](fiftyone.core.session.session.md#fiftyone.core.session.session.Session.freeze)
* [fiftyone.core.session.templates](fiftyone.core.session.templates.md)
* [fiftyone.core.session.utils](fiftyone.core.session.utils.md)
  * [`normalize_selected_samples()`](fiftyone.core.session.utils.md#fiftyone.core.session.utils.normalize_selected_samples)

## Module contents

Session definitions for interacting with the FiftyOne App.

Copyright 2017-2026, Voxel51, Inc.
<br/>
[voxel51.com](https://voxel51.com/)
<br/>
<br/>

**Functions:**

| [`close_app`](#fiftyone.core.session.close_app)()                                  | Closes the FiftyOne App, if necessary.   |
|------------------------------------------------------------------------------------|------------------------------------------|
| [`launch_app`](#fiftyone.core.session.launch_app)([dataset, view, sample_id, ...]) | Launches the FiftyOne App.               |

**Classes:**

| [`Session`](#fiftyone.core.session.Session)([dataset, view, sample_id, ...])   | Session that maintains a 1-1 shared state with the FiftyOne App.   |
|--------------------------------------------------------------------------------|--------------------------------------------------------------------|

### fiftyone.core.session.close_app() → None

Closes the FiftyOne App, if necessary.

If no App is currently open, this method has no effect.

### fiftyone.core.session.launch_app(dataset: [Dataset](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset) = None, view: [DatasetView](fiftyone.core.view.md#fiftyone.core.view.DatasetView) = None, sample_id: str = None, group_id: str = None, spaces: [Space](fiftyone.core.odm.workspace.md#fiftyone.core.odm.workspace.Space) = None, color_scheme: [ColorScheme](fiftyone.core.odm.dataset.md#fiftyone.core.odm.dataset.ColorScheme) = None, plots: [PlotManager](fiftyone.core.plots.manager.md#fiftyone.core.plots.manager.PlotManager) = None, port: int = None, address: str = None, remote: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) = False, browser: str = None, height: int = None, auto: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) = True, config: [AppConfig](fiftyone.core.config.md#fiftyone.core.config.AppConfig) = None) → [Session](fiftyone.core.session.session.md#fiftyone.core.session.session.Session)

Launches the FiftyOne App.

Note that only one App instance can be opened at a time. If this method is
called when another App exists, the existing App will be closed.

* **Parameters:**
  * **dataset** (*None*) – an optional [`fiftyone.core.dataset.Dataset`](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset) or
    [`fiftyone.core.view.DatasetView`](fiftyone.core.view.md#fiftyone.core.view.DatasetView) to load
  * **view** (*None*) – an optional [`fiftyone.core.view.DatasetView`](fiftyone.core.view.md#fiftyone.core.view.DatasetView) to
    load
  * **sample_id** (*None*) – an optional [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) ID
    to load in the modal
  * **group_id** (*None*) – an optional [`fiftyone.core.groups.Group`](fiftyone.core.groups.md#fiftyone.core.groups.Group) ID
    to load in the modal
  * **spaces** (*None*) – an optional [`fiftyone.core.odm.workspace.Space`](fiftyone.core.odm.workspace.md#fiftyone.core.odm.workspace.Space)
    instance defining a space configuration to load
  * **color_scheme** (*None*) – an optional
    [`fiftyone.core.odm.dataset.ColorScheme`](fiftyone.core.odm.dataset.md#fiftyone.core.odm.dataset.ColorScheme) defining a custom
    color scheme to use
  * **plots** (*None*) – an optional
    [`fiftyone.core.plots.manager.PlotManager`](fiftyone.core.plots.manager.md#fiftyone.core.plots.manager.PlotManager) to connect to this
    session
  * **port** (*None*) – the port number to serve the App. If None,
    `fiftyone.config.default_app_port` is used
  * **address** (*None*) – the address to serve the App. If None,
    `fiftyone.config.default_app_address` is used
  * **remote** (*False*) – whether this is a remote session, and opening the App
    should not be attempted
  * **browser** (*None*) – an optional browser to use to open the App. If None,
    the default browser will be used. Refer to list of supported
    browsers at [https://docs.python.org/3/library/webbrowser.html](https://docs.python.org/3/library/webbrowser.html)
  * **height** (*None*) – an optional height, in pixels, at which to render App
    instances in notebook cells. Only applicable in notebook contexts
  * **auto** (*True*) – whether to automatically show a new App window
    whenever the state of the session is updated. Only applicable
    in notebook contexts
  * **config** (*None*) – an optional [`fiftyone.core.config.AppConfig`](fiftyone.core.config.md#fiftyone.core.config.AppConfig) to
    control fine-grained default App settings
* **Returns:**
  a [`Session`](#fiftyone.core.session.Session)

### *class* fiftyone.core.session.Session(dataset: [Dataset](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset) | [DatasetView](fiftyone.core.view.md#fiftyone.core.view.DatasetView) = None, view: [DatasetView](fiftyone.core.view.md#fiftyone.core.view.DatasetView) = None, sample_id: str = None, group_id: str = None, spaces: [Space](fiftyone.core.odm.workspace.md#fiftyone.core.odm.workspace.Space) = None, color_scheme: [ColorScheme](fiftyone.core.odm.dataset.md#fiftyone.core.odm.dataset.ColorScheme) = None, plots: [PlotManager](fiftyone.core.plots.manager.md#fiftyone.core.plots.manager.PlotManager) = None, port: int = None, address: str = None, remote: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) = False, browser: str = None, height: int = None, auto: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) = True, config: [AppConfig](fiftyone.core.config.md#fiftyone.core.config.AppConfig) = None, view_name: str = None)

Bases: `object`

Session that maintains a 1-1 shared state with the FiftyOne App.

**Basic Usage**

- Use [`launch_app()`](#fiftyone.core.session.launch_app) to launch the App and retrieve its
  corresponding [`Session`](#fiftyone.core.session.Session) instance.
- To open a dataset in the App, simply set the
  [`Session.dataset`](#fiftyone.core.session.Session.dataset) property of the session to your
  [`fiftyone.core.dataset.Dataset`](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset).
- To load a specific view into your dataset, simply set the
  [`Session.view`](#fiftyone.core.session.Session.view) property of the session to your
  [`fiftyone.core.view.DatasetView`](fiftyone.core.view.md#fiftyone.core.view.DatasetView).
- To load a specific sample in the modal, simply set the
  [`Session.sample_id`](#fiftyone.core.session.Session.sample_id) property of the session to the ID of the
  [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample).
- To load a specific group in the modal, simply set the
  [`Session.group_id`](#fiftyone.core.session.Session.group_id) property of the session to the ID of the
  [`fiftyone.core.groups.Group`](fiftyone.core.groups.md#fiftyone.core.groups.Group).
- To attach/remove interactive plots, use the methods exposed on the
  [`Session.plots`](#fiftyone.core.session.Session.plots) property of the session.
- Use [`Session.refresh()`](#fiftyone.core.session.Session.refresh) to refresh the App if you update a dataset
  outside of the App
- Use [`Session.selected`](#fiftyone.core.session.Session.selected) to retrieve the IDs of the currently
  selected samples in the App.
- Use [`Session.selected_labels`](#fiftyone.core.session.Session.selected_labels) to retrieve the IDs of the
  currently selected labels in the App.
- In notebook contexts, use [`Session.freeze()`](#fiftyone.core.session.Session.freeze) to replace the App and
  any attached plots with static images.
- Use [`Session.close()`](#fiftyone.core.session.Session.close) and [`Session.open()`](#fiftyone.core.session.Session.open) to temporarily close
  and reopen the App without creating a new [`Session`](#fiftyone.core.session.Session)
  instance.
- Use [`close_app()`](#fiftyone.core.session.close_app) to programmatically close the App and
  terminate the session.

* **Parameters:**
  * **dataset** (*None*) – an optional [`fiftyone.core.dataset.Dataset`](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset) or
    [`fiftyone.core.view.DatasetView`](fiftyone.core.view.md#fiftyone.core.view.DatasetView) to load
  * **view** (*None*) – an optional [`fiftyone.core.view.DatasetView`](fiftyone.core.view.md#fiftyone.core.view.DatasetView) to
    load
  * **sample_id** (*None*) – an optional [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) ID
    to load in the modal
  * **group_id** (*None*) – an optional [`fiftyone.core.groups.Group`](fiftyone.core.groups.md#fiftyone.core.groups.Group) ID
    to load in the modal
  * **spaces** (*None*) – an optional [`fiftyone.core.odm.workspace.Space`](fiftyone.core.odm.workspace.md#fiftyone.core.odm.workspace.Space)
    instance defining a space configuration to load
  * **color_scheme** (*None*) – an optional
    [`fiftyone.core.odm.dataset.ColorScheme`](fiftyone.core.odm.dataset.md#fiftyone.core.odm.dataset.ColorScheme) defining a custom
    color scheme to use
  * **plots** (*None*) – an optional
    [`fiftyone.core.plots.manager.PlotManager`](fiftyone.core.plots.manager.md#fiftyone.core.plots.manager.PlotManager) to connect to this
    session
  * **port** (*None*) – the port number to serve the App. If None,
    `fiftyone.config.default_app_port` is used
  * **address** (*None*) – the address to serve the App. If None,
    `fiftyone.config.default_app_address` is used
  * **remote** (*False*) – whether this is a remote session, and opening the App
    should not be attempted
  * **browser** (*None*) – an optional browser to use to open the App. If None,
    the default browser will be used. Refer to list of supported
    browsers at [https://docs.python.org/3/library/webbrowser.html](https://docs.python.org/3/library/webbrowser.html)
  * **height** (*None*) – an optional height, in pixels, at which to render App
    instances in notebook cells. Only applicable in notebook contexts
  * **auto** (*True*) – whether to automatically show a new App window
    whenever the state of the session is updated. Only applicable
    in notebook contexts
  * **config** (*None*) – an optional [`fiftyone.core.config.AppConfig`](fiftyone.core.config.md#fiftyone.core.config.AppConfig) to
    control fine-grained default App settings

**Attributes:**

| [`auto`](#fiftyone.core.session.Session.auto)                                     | The auto setting for the session.                                                                                                                                                                          |
|-----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`server_port`](#fiftyone.core.session.Session.server_port)                       | The server port for the session.                                                                                                                                                                           |
| [`server_address`](#fiftyone.core.session.Session.server_address)                 | The server address for the session, or None if not specified.                                                                                                                                              |
| [`remote`](#fiftyone.core.session.Session.remote)                                 | Whether the session is remote.                                                                                                                                                                             |
| [`url`](#fiftyone.core.session.Session.url)                                       | The URL of the session.                                                                                                                                                                                    |
| [`config`](#fiftyone.core.session.Session.config)                                 | The current [`fiftyone.core.config.AppConfig`](fiftyone.core.config.md#fiftyone.core.config.AppConfig).                                                                                                    |
| [`group_id`](#fiftyone.core.session.Session.group_id)                             | The current [`fiftyone.core.groups.Group`](fiftyone.core.groups.md#fiftyone.core.groups.Group) ID in the modal, if any.                                                                                    |
| [`sample_id`](#fiftyone.core.session.Session.sample_id)                           | The current [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) ID in the modal, if any.                                                                                  |
| [`spaces`](#fiftyone.core.session.Session.spaces)                                 | The layout state for the session.                                                                                                                                                                          |
| [`color_scheme`](#fiftyone.core.session.Session.color_scheme)                     | The color scheme for the session.                                                                                                                                                                          |
| [`dataset`](#fiftyone.core.session.Session.dataset)                               | The [`fiftyone.core.dataset.Dataset`](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset) connected to the session.                                                                                    |
| [`view`](#fiftyone.core.session.Session.view)                                     | The [`fiftyone.core.view.DatasetView`](fiftyone.core.view.md#fiftyone.core.view.DatasetView) connected to the session, or `None` if no view is connected.                                                  |
| [`has_plots`](#fiftyone.core.session.Session.has_plots)                           | Whether this session has any attached plots.                                                                                                                                                               |
| [`plots`](#fiftyone.core.session.Session.plots)                                   | The [`fiftyone.core.plots.manager.PlotManager`](fiftyone.core.plots.manager.md#fiftyone.core.plots.manager.PlotManager) instance that manages plots attached to this session.                              |
| [`selected`](#fiftyone.core.session.Session.selected)                             | A list of IDs of the currently selected samples in the App, if any.                                                                                                                                        |
| [`selected_samples`](#fiftyone.core.session.Session.selected_samples)             | A list of selected sample dicts, each with `id` and `type` (`"default"` or `"alt"`), where type corresponds to a key in [`sample_selection_style`](#fiftyone.core.session.Session.sample_selection_style). |
| [`sample_selection_style`](#fiftyone.core.session.Session.sample_selection_style) | The current sample grid selection style config.                                                                                                                                                            |
| [`label_selection_style`](#fiftyone.core.session.Session.label_selection_style)   | The current label selection style config.                                                                                                                                                                  |
| [`selected_labels`](#fiftyone.core.session.Session.selected_labels)               | A list of labels currently selected in the App.                                                                                                                                                            |
| [`selected_view`](#fiftyone.core.session.Session.selected_view)                   | A [`fiftyone.core.view.DatasetView`](fiftyone.core.view.md#fiftyone.core.view.DatasetView) containing the currently selected content in the App.                                                           |

**Methods:**

| [`load_workspace`](#fiftyone.core.session.Session.load_workspace)(workspace)                              | Loads the given saved workspace.                                                                                                                                                    |
|-----------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`clear_dataset`](#fiftyone.core.session.Session.clear_dataset)()                                         | Clears the current [`fiftyone.core.dataset.Dataset`](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset) from the session, if any.                                              |
| [`clear_view`](#fiftyone.core.session.Session.clear_view)()                                               | Clears the current [`fiftyone.core.view.DatasetView`](fiftyone.core.view.md#fiftyone.core.view.DatasetView) from the session, if any.                                               |
| [`refresh`](#fiftyone.core.session.Session.refresh)()                                                     | Refreshes the current App window.                                                                                                                                                   |
| [`clear_selected`](#fiftyone.core.session.Session.clear_selected)()                                       | Clears the currently selected samples, if any.                                                                                                                                      |
| [`select_samples`](#fiftyone.core.session.Session.select_samples)([ids, tags])                            | Selects the specified samples in the current view in the App.                                                                                                                       |
| [`set_sample_selection_style`](#fiftyone.core.session.Session.set_sample_selection_style)([default, alt]) | Sets the sample grid selection style in the App.                                                                                                                                    |
| [`clear_sample_selection_style`](#fiftyone.core.session.Session.clear_sample_selection_style)()           | Clears the sample grid selection style, reverting to default checkmark.                                                                                                             |
| [`set_label_selection_style`](#fiftyone.core.session.Session.set_label_selection_style)([default, alt])   | Sets the label selection style in the App.                                                                                                                                          |
| [`clear_label_selection_style`](#fiftyone.core.session.Session.clear_label_selection_style)()             | Clears the label selection style, reverting to default dashed.                                                                                                                      |
| [`select_labels`](#fiftyone.core.session.Session.select_labels)([labels, ids, instance_ids, ...])         | Selects the specified labels in the current view in the App.                                                                                                                        |
| [`clear_selected_labels`](#fiftyone.core.session.Session.clear_selected_labels)()                         | Clears the currently selected labels, if any.                                                                                                                                       |
| [`tag_selected_samples`](#fiftyone.core.session.Session.tag_selected_samples)(tag)                        | Adds the tag to the currently selected samples, if necessary.                                                                                                                       |
| [`untag_selected_samples`](#fiftyone.core.session.Session.untag_selected_samples)(tag)                    | Removes the tag from the currently selected samples, if necessary.                                                                                                                  |
| [`tag_selected_labels`](#fiftyone.core.session.Session.tag_selected_labels)(tag)                          | Adds the tag to the currently selected labels, if necessary.                                                                                                                        |
| [`untag_selected_labels`](#fiftyone.core.session.Session.untag_selected_labels)(tag)                      | Removes the tag from the currently selected labels, if necessary.                                                                                                                   |
| [`summary`](#fiftyone.core.session.Session.summary)()                                                     | Returns a string summary of the session.                                                                                                                                            |
| [`open`](#fiftyone.core.session.Session.open)()                                                           | Opens the App, if necessary.                                                                                                                                                        |
| [`open_tab`](#fiftyone.core.session.Session.open_tab)()                                                   | Opens the App in a new tab of your browser.                                                                                                                                         |
| [`show`](#fiftyone.core.session.Session.show)([height])                                                   | Opens the App in the output of the current notebook cell.                                                                                                                           |
| [`no_show`](#fiftyone.core.session.Session.no_show)()                                                     | Returns a context manager that temporarily prevents new App instances from being opened in the current notebook cell when methods are run that normally would show new App windows. |
| [`wait`](#fiftyone.core.session.Session.wait)([wait])                                                     | Blocks execution until the App is closed by the user.                                                                                                                               |
| [`close`](#fiftyone.core.session.Session.close)()                                                         | Closes the session and terminates the App, if necessary.                                                                                                                            |
| [`freeze`](#fiftyone.core.session.Session.freeze)()                                                       | Screenshots the active App cell, replacing it with a static image.                                                                                                                  |

#### *property* auto *: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)*

The auto setting for the session.

#### *property* server_port *: int*

The server port for the session.

#### *property* server_address *: str*

The server address for the session, or None if not specified.

#### *property* remote *: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)*

Whether the session is remote.

#### *property* url *: str*

The URL of the session.

#### *property* config *: [AppConfig](fiftyone.core.config.md#fiftyone.core.config.AppConfig)*

The current [`fiftyone.core.config.AppConfig`](fiftyone.core.config.md#fiftyone.core.config.AppConfig).

For changes to a session’s config to take effect in the App,
a call to [`Session.refresh()`](#fiftyone.core.session.Session.refresh) or another state-updating action
such as `session.view = my_view` must occur.

Example usage:

```default
import fiftyone as fo

dataset, session = fo.quickstart()

# change the show confidence setting and push the change to the App
session.config.show_confidence = False
session.refresh()
```

#### *property* group_id *: str | None*

The current [`fiftyone.core.groups.Group`](fiftyone.core.groups.md#fiftyone.core.groups.Group) ID in the modal, if
any.

#### *property* sample_id *: str | None*

The current [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) ID in the modal, if
any.

#### *property* spaces *: [Space](fiftyone.core.odm.workspace.md#fiftyone.core.odm.workspace.Space)*

The layout state for the session.

#### load_workspace(workspace: str) → None

Loads the given saved workspace.

* **Parameters:**
  **workspace** – the name of a saved workspace

#### *property* color_scheme *: [ColorScheme](fiftyone.core.odm.dataset.md#fiftyone.core.odm.dataset.ColorScheme)*

The color scheme for the session.

#### *property* dataset *: [Dataset](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset) | None*

The [`fiftyone.core.dataset.Dataset`](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset) connected to the session.

#### clear_dataset() → None

Clears the current [`fiftyone.core.dataset.Dataset`](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset) from the
session, if any.

#### *property* view *: [DatasetView](fiftyone.core.view.md#fiftyone.core.view.DatasetView) | None*

The [`fiftyone.core.view.DatasetView`](fiftyone.core.view.md#fiftyone.core.view.DatasetView) connected to the
session, or `None` if no view is connected.

#### clear_view() → None

Clears the current [`fiftyone.core.view.DatasetView`](fiftyone.core.view.md#fiftyone.core.view.DatasetView) from the
session, if any.

#### *property* has_plots *: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)*

Whether this session has any attached plots.

#### *property* plots *: [PlotManager](fiftyone.core.plots.manager.md#fiftyone.core.plots.manager.PlotManager) | None*

The [`fiftyone.core.plots.manager.PlotManager`](fiftyone.core.plots.manager.md#fiftyone.core.plots.manager.PlotManager) instance that
manages plots attached to this session.

#### refresh() → None

Refreshes the current App window.

#### *property* selected *: List[str]*

A list of IDs of the currently selected samples in the App,
if any.

#### *property* selected_samples *: List[Dict]*

A list of selected sample dicts, each with `id` and `type`
(`"default"` or `"alt"`), where type corresponds to a key in
[`sample_selection_style`](#fiftyone.core.session.Session.sample_selection_style).

Despite its name, `selected_samples` represents whatever sample grid items are in
the current view: samples in a standard dataset view,
patches in a patches view, clips in a clips view, or frames in a
frames view.

#### clear_selected() → None

Clears the currently selected samples, if any.

#### select_samples(ids: str | Iterable | None = None, tags: str | Iterable[str] | None = None) → None

Selects the specified samples in the current view in the App.

Despite its name, this applies to whatever sample grid items are in
the current view: samples, patches, clips, or frames.

* **Parameters:**
  * **ids** (*None*) – an ID or iterable of IDs to select. Items can be
    plain strings (all `"default"` type) or dicts of the form
    `{"id": "...", "type": "default"|"alt"}`, where type
    corresponds to a key in [`sample_selection_style`](#fiftyone.core.session.Session.sample_selection_style).
  * **tags** (*None*) – a tag or iterable of tags to select

#### *property* sample_selection_style *: Dict*

The current sample grid selection style config.

A dict with a `default` key and optional `alt` key specifying
icon styles.

#### set_sample_selection_style(default: str = 'checkmark', alt: str = 'checkmark') → None

Sets the sample grid selection style in the App.

* **Parameters:**
  * **default** ( *"checkmark"*) – the default selection icon style. Supported
    values are `"checkmark"`, `"green-checkmark"`,
    `"red-checkmark"`, `"thumbsup"`, `"thumbsdown"`,
    `"pin"`, `"star"`, `"x"`, `"bookmark"`
  * **alt** ( *"checkmark"*) – the alt selection icon style

#### clear_sample_selection_style() → None

Clears the sample grid selection style, reverting to default checkmark.

#### *property* label_selection_style *: Dict*

The current label selection style config.

A dict with a `default` key and optional `alt` key specifying
label selection visual styles.

#### set_label_selection_style(default: str = 'dashed', alt: str = 'dashed') → None

Sets the label selection style in the App.

* **Parameters:**
  * **default** ( *"dashed"*) – the default label selection style. Supported
    values are `"dashed"`, `"dashed-green"`, `"dashed-red"`
  * **alt** ( *"dashed"*) – the alt label selection style

#### clear_label_selection_style() → None

Clears the label selection style, reverting to default dashed.

#### *property* selected_labels *: List[dict]*

A list of labels currently selected in the App.

Items are dictionaries with the following keys:

- `label_id`: the ID of the label
- `sample_id`: the ID of the sample containing the label
- `instance_id`: the instance ID of the label (optional)
- `field`: the field name containing the label
- `frame_number`: the frame number containing the label (only
  applicable to video samples)
- `type`: the selection type (`"default"` or `"alt"`), which
  determines the visual style applied via [`label_selection_style`](#fiftyone.core.session.Session.label_selection_style)

#### select_labels(labels: List[dict] | None = None, ids: str | Iterable[str] | None = None, instance_ids: str | Iterable[str] | None = None, tags: str | Iterable[str] | None = None, fields: str | Iterable[str] | None = None) → None

Selects the specified labels in the current view in the App.

This method uses the same interface as
[`fiftyone.core.collections.SampleCollection.select_labels()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.select_labels) to
specify the labels to select.

* **Parameters:**
  * **labels** (*None*) – a list of dicts specifying the labels to select
  * **ids** (*None*) – an ID or iterable of IDs of the labels to select
  * **instance_ids** (*None*) – an instance ID or iterable of instance IDs of
    the labels to select
  * **tags** (*None*) – a tag or iterable of tags of labels to select
  * **fields** (*None*) – a field or iterable of fields from which to select

#### clear_selected_labels() → None

Clears the currently selected labels, if any.

#### tag_selected_samples(tag: str) → None

Adds the tag to the currently selected samples, if necessary.

The currently selected labels are [`Session.selected`](#fiftyone.core.session.Session.selected).

* **Parameters:**
  **tag** – a tag

#### untag_selected_samples(tag: str) → None

Removes the tag from the currently selected samples, if necessary.

The currently selected labels are [`Session.selected`](#fiftyone.core.session.Session.selected).

* **Parameters:**
  **tag** – a tag

#### tag_selected_labels(tag: str) → None

Adds the tag to the currently selected labels, if necessary.

The currently selected labels are [`Session.selected_labels`](#fiftyone.core.session.Session.selected_labels).

* **Parameters:**
  **tag** – a tag

#### untag_selected_labels(tag: str) → None

Removes the tag from the currently selected labels, if necessary.

The currently selected labels are [`Session.selected_labels`](#fiftyone.core.session.Session.selected_labels).

* **Parameters:**
  **tag** – a tag

#### *property* selected_view *: [DatasetView](fiftyone.core.view.md#fiftyone.core.view.DatasetView) | None*

A [`fiftyone.core.view.DatasetView`](fiftyone.core.view.md#fiftyone.core.view.DatasetView) containing the currently
selected content in the App.

The selected view is defined as follows:

- If both samples and labels are selected, the view will contain only
  the [`selected_labels`](#fiftyone.core.session.Session.selected_labels) from within the [`selected`](#fiftyone.core.session.Session.selected)
  samples
- If samples are selected, the view will only contain the
  [`selected`](#fiftyone.core.session.Session.selected) samples
- If labels are selected, the view will only contain the
  [`selected_labels`](#fiftyone.core.session.Session.selected_labels)
- If no samples or labels are selected, the view will be `None`

#### summary() → str

Returns a string summary of the session.

* **Returns:**
  a string summary

#### open() → None

Opens the App, if necessary.

The behavior of this method depends on your context:

- Notebooks: calls [`Session.show()`](#fiftyone.core.session.Session.show) to open a new App window in
  the output of your current cell
- Other (non-remote): opens the App in a new browser tab

#### open_tab() → None

Opens the App in a new tab of your browser.

This method can be called from Jupyter notebooks to override the
default location of the App.

#### show(height: int = None) → None

Opens the App in the output of the current notebook cell.

This method has no effect in non-notebook contexts.

* **Parameters:**
  **height** (*None*) – a height, in pixels, for the App

#### no_show() → [SetAttributes](fiftyone.core.utils.md#fiftyone.core.utils.SetAttributes)

Returns a context manager that temporarily prevents new App
instances from being opened in the current notebook cell when methods
are run that normally would show new App windows.

This method has no effect in non-notebook contexts.

Examples:

```default
import fiftyone as fo

dataset = foz.load_zoo_dataset("quickstart")
session = fo.launch_app(dataset)

# (new cell)

# Opens a new App instance
session.view = dataset.take(100)

# (new cell)

# Does not open a new App instance
with session.no_show():
    session.view = dataset.take(100)
```

* **Returns:**
  a context manager

#### wait(wait: float = 3) → None

Blocks execution until the App is closed by the user.

All connected windows (tabs) must be closed before this method will
unblock.

* **Parameters:**
  **wait** (*3*) – the number of seconds to wait for a new App connection
  before returning if all connections are lost. If negative, the
  process will wait forever, regardless of connections

#### close() → None

Closes the session and terminates the App, if necessary.

#### freeze() → None

Screenshots the active App cell, replacing it with a static image.

Only applicable to notebook contexts.
