fiftyone.utils.quickstart

module documentation

(source)

FiftyOne quickstart.

Function	`quickstart`	Runs the FiftyOne quickstart.
Function	`_launch_app`	Undocumented
Function	`_quickstart`	Undocumented
Function	`_video_quickstart`	Undocumented
Constant	`_QUICKSTART_GUIDE`	Undocumented
Constant	`_VIDEO_QUICKSTART_GUIDE`	Undocumented

def quickstart(video=False, port=None, address=None, remote=False): (source) ¶

Runs the FiftyOne quickstart.

This method loads an interesting dataset from the Dataset Zoo, launches the App, and prints some suggestions for exploring the dataset.

Parameters
video:`False`	whether to launch a video dataset
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
Returns
a tuple containing	dataset: the `fiftyone.core.dataset.Dataset` that was loaded session: the `fiftyone.core.session.Session` instance for the App that was launched

def _launch_app(dataset, port, address, remote): (source) ¶

Undocumented

def _quickstart(port, address, remote): (source) ¶

Undocumented

def _video_quickstart(port, address, remote): (source) ¶

Undocumented

_QUICKSTART_GUIDE: str = (source) ¶

Undocumented

Value

'''
Welcome to FiftyOne!

This quickstart downloaded a dataset from the Dataset Zoo and created a
session, which is a connection to an instance of the App.

The dataset contains ground truth labels in a `ground_truth` field and
...

_VIDEO_QUICKSTART_GUIDE: str = (source) ¶

Undocumented

Value

'''
Welcome to FiftyOne!

This quickstart downloaded a dataset from the Dataset Zoo and created a
session, which is a connection to an instance of the App.

The dataset contains small video segments with dense object detections
...