Automations

This page describes automations in W&B. Create an automation to trigger workflow steps, such as automated model testing and deployment, based on an event in W&B, such as when an artifact artifact version is created (/guides/core/registry/).

For example, an automation can post to a Slack channel when a new version is created, or can run a webhook to trigger automated testing when the production alias is added to an artifact.

Overview

An automation can run when a specific event occurs in a registry or project.

For an artifact in Registry, you can configure an automation to run:

• When a new artifact version is linked to a collection. For example, trigger testing and validation workflows for new candidate models.
• When an alias is added to an artifact version. For example, trigger a deployment workflow when the deploy alias is added to a model version.

For an artifact in a project, you can configure an automation to run:

• 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.

For more details, refer to Automation events.

To create an automation, you:

1. If required, configure secrets for sensitive strings the automation requires, such as access tokens, passwords, or sensitive configuration details. Secrets are defined in your Team Settings. Secrets are most commonly used in webhook automations to securely pass credentials or tokens to the webhook’s external service without exposing it in plain text or hard-coding it in the webhook’s payload.
2. Authorize W&B to post to Slack, or configure the webhook’s endpoint and authorization details. This is required once per Slack destination or webhook endpoint.
3. In the project or registry, create the automation:
4. Define the event to watch for, such as when a new artifact version is added.
5. Define the action to take when the event occurs (posting to a Slack channel or running a webhook). For a webhook, specify a secret to use for the access token and/or a secret to send with the payload, if required.

Next steps

• Create an automation.
• Learn about Automation events and scopes.
• Create a secret.