Tags

Tags are used to categorize content. You can attach tags to runs, models and datasets. Tags are per-project, so you can have a tag with the same name in different projects, but only one tag with the same name in the same project.

Create a tag

You can create a tag using the create method. You can only create a tag if it does not exist in the project. If the tag already exists, the method will finish without errors.

import pyhectiqlab.functional as hl
hl.create_tag(name="my-tag", project="hectiq-ai/demo")

Name	Type	Default	Description
`name`	`str`		The name of the tag.
`project`	`str`		The project where the tag will be created.
`color`	`str, optional`		The color of the tag. If the color is unset, a random color is assigned.
`wait_response`	`bool`	`False`	Set to true to create sync. If False, the creation is made in background.

You can list tags using the list method. This method is available from the functional and Tag object-oriented approaches, and the CLI.

import pyhectiqlab.functional as hl
hl.list_tags(project="hectiq-ai/demo")

Name	Type	Default	Description
`project`	`str`	`None`	Project name.
`page`	`int`	`1`	Page number.
`limit`	`int`	`100`	Number of tags per page.
`order_by`	`str`	`None`	Order by field.
`order_direction`	`str`	`None`	Order direction.

Attach tags to a run

At initialization of a run, you can specify the tags that you want to attach to the run. You can also attach tags to an existing run using the add_tags method. If the tag does not exist, it will be created.

import pyhectiqlab.functional as hl
hl.add_tags_to_run(tags=["my-tag"])

Name	Type	Default	Description
`tags`	`List[str]`	-	List of tags to attach.
`run_id`	`str`	-	Run ID.
`project`	`str`	-	Project name.
`wait_response`	`bool`	`False`	Set to true to attach sync. If False, the attachment is made in background.

Detach tag from a run

While you can attach many tags to a run, you can only detach one tag at a time. You can detach a tag from a run using the detach_from_run method. If the tag doesn't exist or is not attached to the run, the method will finish without errors.

import pyhectiqlab.functional as hl
hl.detach_tag_from_run(run_id="9c29ckw0", tag="my-tag")

Name	Type	Default	Description
`run_id`	`str`	-	Run ID.
`tag`	`str`	-	Tag name.
`project`	`str`	-	Project name.
`wait_response`	`bool`	`False`	Set to true to detach sync. If `False`, the detachment is made in background.

Tags

Create a tagCopy Anchor Link

List tagsCopy Anchor Link

Attach tags to a runCopy Anchor Link

Detach tag from a runCopy Anchor Link

On this page

Create a tag

List tags

Attach tags to a run

Detach tag from a run