module niftyone.metadata.tags

Utilities for handling NiftyOne tags.

Global Variables

  • TAGS

class GroupTags

QC tags for individual data acquisitions.

Interfaces between FiftyOne datasets and pandas DataFrames, CSV, JSON.

method GroupTags.__init__

__init__(tags_dict: dict[str, typing.Any]) → None

method GroupTags.apply

apply(dataset: fiftyone.core.dataset.Dataset) → None

Apply tags to a given FiftyOne dataset, overwriting existing tags.


method GroupTags.equals

equals(other: 'GroupTags') → bool

Assert two groups of tabs are equal.


classmethod GroupTags.from_csv

from_csv(path: str | pathlib.Path) → GroupTags

Extract tags from csv.


classmethod GroupTags.from_dataset

from_dataset(dataset: fiftyone.core.dataset.Dataset) → GroupTags

Extract tags from a FiftyOne dataset.


classmethod GroupTags.from_df

from_df(df: pandas.core.frame.DataFrame) → GroupTags

Extract tags from datafame.


classmethod GroupTags.from_json

from_json(path: str | pathlib.Path) → GroupTags

Extract tags from json file.


method GroupTags.to_csv

to_csv(path: str | pathlib.Path) → None

Save tags to csv.


method GroupTags.to_df

to_df() → DataFrame

Convert tags from dict to pandas dataframe.


method GroupTags.to_json

to_json(path: str | pathlib.Path) → None

Save tags to json.