fiftyone.core.stages.MatchTags

Returns a view containing the samples in the collection that have or don't have any/all of the given tag(s).

Examples:

import fiftyone as fo

dataset = fo.Dataset()
dataset.add_samples(
    [
        fo.Sample(filepath="image1.png", tags=["train"]),
        fo.Sample(filepath="image2.png", tags=["test"]),
        fo.Sample(filepath="image3.png", tags=["train", "test"]),
        fo.Sample(filepath="image4.png"),
    ]
)

#
# Only include samples that have the "test" tag
#

stage = fo.MatchTags("test")
view = dataset.add_stage(stage)

#
# Only include samples that do not have the "test" tag
#

stage = fo.MatchTags("test", bool=False)
view = dataset.add_stage(stage)

#
# Only include samples that have the "test" or "train" tags
#

stage = fo.MatchTags(["test", "train"])
view = dataset.add_stage(stage)

#
# Only include samples that have the "test" and "train" tags
#

stage = fo.MatchTags(["test", "train"], all=True)
view = dataset.add_stage(stage)

#
# Only include samples that do not have the "test" or "train" tags
#

stage = fo.MatchTags(["test", "train"], bool=False)
view = dataset.add_stage(stage)

#
# Only include samples that do not have the "test" and "train" tags
#

stage = fo.MatchTags(["test", "train"], bool=False, all=True)
view = dataset.add_stage(stage)