Run tags

Tags help identify and organize your runs.

Tag types

Neptune supports two kinds of tags:

• Group tags: Use as labels for run categories. When grouping runs, group tags are used by default.
• Tags: Use for quick identification and filtering.

Functionality	Group tags	Tags
Add tags via app or API
Remove tags via app or API
Filter runs by tag
Set custom tag color		–
Use same color for all runs with tag		–
Menu for managing member runs		–

tip

If you're not sure which type to use, we recommend group tags. The two tag types are stored as separate StringSet attributes and can be used independently.

For example, you can use regular tags for ad-hoc tagging of individual runs, without cluttering group labels.

Add tags at run creation

Pass a list or set of tags to the tags argument of the add_tags() function:

from neptune_scale import Run


run = Run(...)
run.add_tags(tags=["tag1", "tag2", "tag3"])

The tags are stored in the sys/tags attribute.

Add group tags

To add group tags instead of regular ones, set the group_tags argument to True:

run.add_tags(
    tags=["seabirds"],
    group_tags=True,
)

The tags are stored in the sys/group_tags attribute.

Filter runs by tag

Use the runs table to filter the displayed runs by tag:

• To create a filter, click on a tag or group tag and select Filter by this tag.
• To create a condition on multiple tags, click next to the search bar, then select sys/tags or sys/group_tags. To finish the filter, select Done.

Manage tags in the web app

To edit the tags of a run:

1. In the runs table, hover over the Tags or Group tags column.

2. Click the pencil icon.

3. Choose between existing tags in the project, or type the name of a new tag and select Create <tag name>.

   You can also include emoji in tags:

   run.add_tags(tags=["best 🏆"])

Bulk tagging

• To apply a group tag to multiple runs, click on a group tag and add runs through the group menu.
• To manage regular tags, use the checkboxes to select multiple runs, then click Manage tags in the toolbar.

note

Bulk selection isn't available in reports.

Edit tags via API

To add tags to an existing run, resume it first:

run = Run(run_id="SomeExistingRunId", resume=True, ...)

Then, to add best to the list of tags:

run.add_tags(tags=["best"])

To add group tags, include the group_tags=True argument.

Remove tags

To remove tags from a run via API, pass them to the tags argument of the remove_tags() function:

run = Run(run_id="SomeExistingRunId", resume=True, ...)
run.remove_tags(tags=["best"])

To remove group tags, include the group_tags=True argument.