Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 4.4 KB

search-functionality.md

File metadata and controls

47 lines (31 loc) · 4.4 KB
description With the search bar, you can search for samples by their name, metadata attributes, and label content.

Search within a dataset

Search by metadata attributes and label content

Search syntax

To search by sample name, just type the full or partial name of a sample.

To search by metadata attribute, use the key:value syntax.

To search by number of objects of a category in a labelset, use the labelset.category:=value syntax, or labelset.total_count:=value to search by total number of objects.

To search by labeler and reviewer of a sample, use the labeled-by:username or reviewed-by:username syntax.

For string values, use the : operator. For numeric values, use the operators :=,:>, :>=, :< and :<= to search for values that are equal to, greater than, greater than or equal to, less than, and less than or equal to another value. For list values, use the :| operator to search for a value contained in the list.

Queries can be combined by separating them with a space. They will be ANDed together.

Search from label statistics

On the Overview tab, you can click a category name in the label statistics to jump to the Samples tab.

The search bar is pre-filled with the corresponding category query.

The current search query is also reflected in the page URL through the ?q= query parameter. For example, ?q=ground-truth.category:>0 opens the Samples tab with that filter already applied.

This makes filtered views easy to bookmark and share. The search input and URL stay in sync in both directions: typing in the search bar updates the URL, and opening or editing a URL with ?q= updates the search field.

Examples

Examples
image_grayscale matches samples with the word "image_grayscale" in their name.
city:london matches samples with a metadata attribute "city" set to "london".
vehicle_id:>3 matches samples with a metadata attribute "vehicle_id" set to a value larger than 3.
ground-truth.car:>=5 matches samples where the "ground-truth" label contains 5 or more "car" objects.
my-predictions.car:<5 matches samples where the "my-predictions" label contains less than 5 "car" objects.
my-predictions.total_count:<=20 matches samples where the "my-predictions" label contains 20 or fewer objects in total.
city:london ground-truth.car:>0 my-predictions.car:=0 matches samples where metadata attribute "city" is set to "london" AND the "ground-truth" label contains more than 0 "car" objects AND the "my-predictions" label contains 0 "car" objects.
tags:|red matches samples where metadata attribute "tags" is a list of values ["red", "green", "blue"].
labeled-by:jane matches samples labeled by the user with username jane.