8000 [DOCS-1656] Document automations triggered by artifact tags by mdlinville · Pull Request #1453 · wandb/docs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

[DOCS-1656] Document automations triggered by artifact tags #1453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions content/en/guides/core/automations/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ In a [Registry]({{< relref "/guides/core/registry/">}}), an automation can start
In a [project]({{< relref "/guides/models/track/project-page.md" >}}), an automation can start:
- When a new version is added to an artifact. For example, start a training job when a new version of a dataset artifact is added to a given collection.
- When an alias is added to an artifact version. For example, trigger a PII redaction workflow when the alias "redaction" is added to a dataset artifact.
- When a tag is added to an artifact version. For example, trigger a geo-specific workflow when the tag "europe" is added to an artifact version.
- When a metric for a run meets or exceeds a configured threshold.
- When a metric for a run changes by a configured threshold.
- When a run's status changes to **Running**, **Failed**, or **Finished**.
Expand Down
12 changes: 6 additions & 6 deletions content/en/guides/core/automations/automation-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ You can create a Registry automation at these scopes:

### Events
A Registry automation can watch for these events:
- **Linking a new artifact to a collection**: Test and validate new models or datasets when they are added to a registry.
- **Adding a new alias to a version of an artifact**: Trigger a specific step of your workflow when a new artifact version has a specific alias applied. For example, deploy a model when it has the `production` alias applied.
- **A new version is linked to a collection**: Test and validate new models or datasets when they are added to a registry.
- **An artifact alias is added**: Trigger a specific step of your workflow when a new artifact version has a specific alias applied. For example, deploy a model when it has the `production` alias applied.

## Project
This section describes the scopes and events for an automation in a [project]({{< relref "/guides/models/track/project-page.md" >}}).
Expand All @@ -54,9 +54,9 @@ You can create a project automation at these scopes:
### Artifact events
This section describes the events related to an artifact that can trigger an automation.

- **Linking a new artifact**: Test and validate new models or datasets automatically.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: it looks like we removed Linking a new artifact -- was this intentional?

It's still supported, just not from the Project-level automations page

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I was going to ask about it. Can you remind me where in the UI I go to see the option? I need to double-check the UI label (the others all changed in the meantime).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the Registry UI copy. Thanks. :)

10000

- **Creating a new version of an artifact**: Apply recurring actions to each version of an artifact. For example, start a training job when a new dataset artifact version is created.
- **Adding a new alias to a version of an artifact**: Trigger a specific step of your workflow when a new artifact version in a project or collection has a specific label or alias applied. For example, run a series of downstream processing steps when an artifact has the `test-set-quality-check` alias applied.
- **A new version is added to an artifact**: Apply recurring actions to each version of an artifact. For example, start a training job when a new dataset artifact version is created.
- **An artifact alias is added**: Trigger a specific step of your workflow when a new artifact version in a project or collection has a specific alias applied. For example, run a series of downstream processing steps when an artifact has the `test-set-quality-check` alias applied, or run a workflow each time a new artifact version gains the `latest` alias. Only one artifact version can have a given alias at a point in time.
- **An artifact tag is added**: Trigger a specific step of your workflow when an artifact version in a project or collection has a specific tag applied. For example, trigger a geo-specific workflow when the tag "europe" is added to an artifact version. Artifact tags are used for grouping and filtering, and a given tag can be assigned to multiple artifact versions simultaneously.

### Run events
An automation can be triggered by a change in a [run's status]({{< relref "/guides/models/track/runs/#run-states" >}}) or a change in a [metric value]({{< relref "/guides/models/track/log/#what-data-is-logged-with-specific-wb-api-calls" >}}).
Expand Down Expand Up @@ -133,4 +133,4 @@ This section describes how the automation selects runs to evaluate.

## Next steps
- [Create a Slack automation]({{< relref "create-automations/slack.md" >}})
- [Create a webhook automation]({{< relref "create-automations/webhook.md" >}})
- [Create a webhook automation]({{< relref "create-automations/webhook.md" >}})
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ View and manage automations from a project or registry's **Automations** tab.
- To delete an automation, click its action `...` menu, then click **Delete automation**.

## Next steps
- Learn more about [automation events and scopes]({{< relref "/guides/core/automations/automation-events.md" >}})
- [Create a Slack automation]({{< relref "slack.md" >}}).
- [Create a webhook automation]({{< relref "webhook.md" >}}).
- [Create a secret]({{< relref "/guides/core/secrets.md" >}}).
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ A Registry admin can create automations in that registry.
1. Choose the [event]({{< relref "/guides/core/automations/automation-events.md" >}}) to watch for.

Fill in any additional fields that appear, which depend upon the event. For example, if you select **An artifact alias is added**, you must specify the **Alias regex**.

Click **Next step**.
1. Select the team that owns the [Slack integration]({{< relref "#add-a-slack-integration" >}}).
1. Set **Action type** to **Slack notification**. Select the Slack channel, then click **Next step**.
Expand All @@ -69,7 +69,7 @@ A W&B admin can create automations in a project.
1. Choose the [event]({{< relref "/guides/core/automations/automation-events.md" >}}) to watch for.

Fill in any additional fields that appear, which depend upon the event. For example, if you select **An artifact alias is added**, you must specify the **Alias regex**.

Click **Next step**.
1. Select the team that owns the [Slack integration]({{< relref "#add-a-slack-integration" >}}).
1. Set **Action type** to **Slack notification**. Select the Slack channel, then click **Next step**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ A W&B admin can create automations in a project.
1. Fill in any additional fields that appear, which depend upon the event. For example, if you select **An artifact alias is added**, you must specify the **Alias regex**.

1. Optionally specify a collection filter. Otherwise, the automation is applied to all collections in the project, including those added in the future.

Click **Next step**.
1. Select the team that owns the [webhook]({{< relref "#create-a-webhook" >}}).
1. Set **Action type** to **Webhooks**. then select the [webhook]({{< relref "#create-a-webhook" >}}) to use.
Expand Down Expand Up @@ -120,7 +120,8 @@ This section describes the variables you can use to construct your webhook's pay
| `${entity_name}` | The name of the entity or team that owns the mutation that triggered the action.
| `${event_type}` | The type of event that triggered the action. |
| `${event_author}` | The user that triggered the action. |
| `${alias}` | Contains an artifact's alias if the automation is triggered by the **Adding a new alias to a version of an artifact** event. For other automations, this variable is blank. |
| `${alias}` | Contains an artifact's alias if the automation is triggered by the **An artifact alias is added** event. For other automations, this variable is blank. |
| `${tag}` | Contains an artifact's tags if the automation is triggered by the **An artifact tag is added** event. For other automations, this variable is blank. |
| `${artifact_collection_name}` | The name of the artifact collection that the artifact version is linked to. |
| `${artifact_metadata.<KEY>}` | The value of an arbitrary top-level metadata key from the artifact version that triggered the action. Replace `<KEY>` with the name of a top-level metadata key. Only top-level metadata keys are available in the webhook's payload. |
| `${artifact_version}` | The [`Wandb.Artifact`]({{< relref "/ref/python/sdk/classes/artifact.md/" >}}) representation of the artifact version that triggered the action. |
Expand Down
0