fiftyone.core.odm.dataset.DatasetAppConfig

class documentation

class DatasetAppConfig(EmbeddedDocument): (source)

Constructor: DatasetAppConfig(*args, **kwargs)

Dataset-specific settings that customize how a dataset is visualized in the App.

Parameters
color_scheme	an optional `ColorScheme` for the dataset
disable_frame_filtering	whether to disable frame filtering for video datasets in the App's grid view
grid_media_field	the default sample field from which to serve media in the App's grid view media_fallback (False): whether to fall back to the default media field (`"filepath"`) when the alternate media field value for a sample is not defined
media_fields	the list of sample fields that contain media and should be available to choose from the App's settings menus
modal_media_field	the default sample field from which to serve media in the App's modal view
dynamic_groups_target_frame_rate	the target frame rate when rendering ordered dynamic groups of images as videos
plugins	an optional dict mapping plugin names to plugin configuration dicts. Builtin plugins include: `"map"`: See the :ref:`map plugin docs <app-map-panel>` for supported options `"point-cloud"`: See the :ref:`3D visualizer docs <app-3d-visualizer-config>` for supported options
sidebar_groups	an optional list of `SidebarGroupDocument` describing sidebar groups to use in the App

Static Method	`default_sidebar_groups`	Generates the default `sidebar_groups` for the given collection.
Method	`is_custom`	Determines whether this app config differs from the default one.
Class Variable	`color_scheme`	Undocumented
Class Variable	`disable_frame_filtering`	Undocumented
Class Variable	`dynamic_groups_target_frame_rate`	Undocumented
Class Variable	`media_fallback`	Undocumented
Class Variable	`media_fields`	Undocumented
Class Variable	`meta`	Undocumented
Class Variable	`plugins`	Undocumented
Instance Variable	`grid_media_field`	Undocumented
Instance Variable	`modal_media_field`	Undocumented
Instance Variable	`sidebar_groups`	Undocumented
Method	`_add_path_to_sidebar_group`	Undocumented
Method	`_delete_path`	Undocumented
Method	`_delete_paths`	Undocumented
Method	`_rename_path`	Undocumented
Method	`_rename_paths`	Undocumented

Inherited from EmbeddedDocument:

Method __init__ Undocumented

Inherited from MongoEngineBaseDocument (via EmbeddedDocument, BaseEmbeddedDocument):

Class Method	`from_dict`	Loads the document from a BSON/JSON dictionary.
Method	`__deepcopy__`	Undocumented
Method	`__delattr__`	Undocumented
Method	`__delitem__`	Undocumented
Method	`clear_field`	Clears the field from the document.
Method	`field_to_mongo`	Undocumented
Method	`field_to_python`	Undocumented
Method	`get_field`	Gets the field of the document.
Method	`has_field`	Determines whether the document has a field of the given name.
Method	`set_field`	Sets the value of a field of the document.
Method	`to_dict`	Serializes this document to a BSON/JSON dictionary.
Property	`field_names`	An ordered tuple of the public fields of this document.
Method	`_get_field`	Undocumented
Method	`_get_field_names`	Returns an ordered tuple of field names of this document.
Method	`_get_repr_fields`	Returns an ordered tuple of field names that should be included in the `repr` of the document.
Method	`_to_db_fields`	Undocumented
Instance Variable	`_fields_ordered`	Undocumented

Inherited from SerializableDocument (via EmbeddedDocument, BaseEmbeddedDocument, MongoEngineBaseDocument):

Class Method	`from_json`	Loads the document from a JSON string.
Method	`__eq__`	Undocumented
Method	`__repr__`	Undocumented
Method	`__str__`	Undocumented
Method	`copy`	Returns a deep copy of the document.
Method	`fancy_repr`	Generates a customizable string representation of the document.
Method	`iter_fields`	Returns an iterator over the `(name, value)` pairs of the public fields of the document.
Method	`merge`	Merges the contents of the given document into this document.
Method	`to_json`	Serializes the document to a JSON string.

@staticmethod
def default_sidebar_groups(sample_collection): (source) ¶

Generates the default sidebar_groups for the given collection.

Examples:

import fiftyone as fo
import fiftyone.zoo as foz

dataset = foz.load_zoo_dataset("quickstart")

sidebar_groups = fo.DatasetAppConfig.default_sidebar_groups(dataset)
dataset.app_config.sidebar_groups = sidebar_groups
print(dataset.app_config)