fiftyone.core.session.notebooks

module documentation
(source)

Session notebook handling.

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

Class NotebookCell Undocumented
Function capture Undocumented
Function display Displays a running FiftyOne instance.
Function display_colab Display a FiftyOne instance in a Colab output frame.
Function display_databricks Display a FiftyOne instance in a Databricks output frame.
Function display_ipython Undocumented
def capture(cell: NotebookCell, data: fose.CaptureNotebookCell, proxy_url: str = None): (source)

Undocumented

def display(client: Client, cell: NotebookCell, proxy_url: str = None, reactivate: bool = False): (source)

Displays a running FiftyOne instance.

def display_colab(client: Client, cell: NotebookCell, proxy_url: str = None, reactivate: bool = False): (source)

Display a FiftyOne instance in a Colab output frame.

The Colab VM is not directly exposed to the network, so the Colab runtime provides a service worker tunnel to proxy requests from the end user's browser through to servers running on the Colab VM: the output frame may issue requests to https://localhost:<port> (HTTPS only), which will be forwarded to the specified port on the VM.

It does not suffice to create an iframe and let the service worker redirect its traffic (), because for security reasons service workers cannot intercept iframe traffic. Instead, we manually fetch the FiftyOne index page with an XHR in the output frame, and inject the raw HTML into document.body.

def display_databricks(client: Client, cell: NotebookCell, proxy_url: str = None, reactivate: bool = False): (source)

Display a FiftyOne instance in a Databricks output frame.

The Databricks driver port is accessible via a proxy url and can be displayed inside an IFrame.

def display_ipython(client: Client, cell: NotebookCell, proxy_url: str = None, reactivate: bool = False, **kwargs: dict[str, str | bool]): (source)

Undocumented