Skip to content

Commit 6d03cd7

Browse files
committed
Automations content updates split out from Automation History changes
1 parent 1edabcd commit 6d03cd7

File tree

2 files changed

+28
-25
lines changed

2 files changed

+28
-25
lines changed

models/automations.mdx

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,42 @@ import EnterpriseCloudOnly from "/snippets/en/_includes/enterprise-cloud-only.md
88
<EnterpriseCloudOnly/>
99
</Info>
1010

11-
This page describes _automations_ in W&B. [Create an automation](/models/automations/create-automations/) to trigger workflow steps, such as automated model testing and deployment, based on an event in W&B, such as when an [artifact](/models/artifacts/) artifact version is created or when a [run metric](/models/runs/) meets or changes by a threshold.
11+
This page describes _automations_ in W&B. [Create an automation](/models/automations/create-automations/) to trigger workflow steps, such as automated model testing and deployment, based on an event in W&B.
1212

1313
For example, an automation can notify a Slack channel when a new version is created, trigger an automated testing webhook when the `production` alias is added to an artifact, or start a validation job only when a run's `loss` is within acceptable bounds.
1414

15-
## Overview
16-
An automation can start when a specific [event](/models/automations/automation-events/) occurs in a registry or project.
15+
<Info>
16+
Looking for companion tutorials for automations?
17+
- [Learn to automatically trigger a Github Action for model evaluation and deployment](https://wandb.ai/wandb/wandb-model-cicd/reports/Model-CI-CD-with-W-B--Vmlldzo0OTcwNDQw).
18+
- [Watch a video demonstrating automatically deploying a model to a Sagemaker endpoint](https://www.youtube.com/watch?v=s5CMj_w3DaQ).
19+
- [Watch a video series introducing automations](https://youtube.com/playlist?list=PLD80i8An1OEGECFPgY-HPCNjXgGu-qGO6&feature=shared).
20+
</Info>
1721

18-
In a [Registry](/models/registry/), an automation can start:
19-
- When a new artifact version is linked to a collection. For example, trigger testing and validation workflows for new candidate models.
20-
- When an alias is added to an artifact version. For example, trigger a deployment workflow when an alias is added to a model version.
22+
## Automation events
2123

22-
In a [project](/models/track/project-page/), an automation can start:
23-
- 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.
24-
- 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.
25-
- 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.
26-
- When a metric for a run meets or exceeds a configured threshold.
27-
- When a metric for a run changes by a configured threshold.
28-
- When a run's status changes to **Running**, **Failed**, or **Finished**.
24+
Automations can be triggered by events related to runs or artifacts in a collection, project, or registry. An automation can start:
2925

30-
Optionally, you can:
31-
- Filter artifacts, aliases, or tags by name
32-
- Filter runs by user or run name.
26+
- When a run metric meets a defined absolute or relative threshold. For example, trigger when a run's `loss` is less than 0.01 or when a run's `accuracy` improves by 5%.
27+
- When an event occurs in a project or registry. For example, trigger when a new version of a model artifact is created or when the `production` alias is added to a model artifact.
3328

3429
For more details, see [Automation events and scopes](/models/automations/automation-events/).
3530

31+
## Automation actions
32+
33+
When an event triggers an automation, it can perform one of these actions:
34+
35+
### Slack notification
36+
Send a message to a Slack channel with details about the triggering event. The message summarizes the event, with a link to view more details in W&B.
37+
38+
### Webhook
39+
Call a webhook URL with a JSON payload containing information about the triggering event. This enables integration with external systems like CI/CD pipelines, model deployment services, or custom workflows. The body of the webhook request may be any JSON-serializable payload.
40+
41+
For implementation details, see:
42+
- [Create a Slack automation](/models/automations/create-automations/slack/)
43+
- [Create a webhook automation](/models/automations/create-automations/webhook/)
44+
45+
## How automations work
46+
3647
To [create an automation](/models/automations/create-automations/), you:
3748

3849
1. If required, configure [secrets](/platform/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.
@@ -46,5 +57,6 @@ To [create an automation](/models/automations/create-automations/), you:
4657

4758
## Next steps
4859
- [Create an automation](/models/automations/create-automations/).
60+
- [View an automation's history](/models/automations/view-automation-history) to track executions and debug issues.
4961
- Learn about [Automation events and scopes](/models/automations/automation-events/).
5062
- [Create a secret](/platform/secrets/).

models/runs/alert.mdx

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,6 @@ For example, an automation can notify a Slack channel when a new version is crea
2323
Read the [Automations overview](/models/automations/) or [create an automation](/models/automations/create-automations/).
2424
</Note>
2525

26-
27-
## Create an alert
28-
29-
<Note>
30-
The following guide only applies to alerts in Multi-tenant Cloud.
31-
32-
If you're using [W&B Server](/platform/hosting/) in your Private Cloud or on W&B Dedicated Cloud, refer to [Configure Slack alerts in W&B Server](/platform/hosting/monitoring-usage/slack-alerts) to set up Slack alerts.
33-
</Note>
34-
3526
To set up an alert, take these steps, which are detailed in the following sections:
3627

3728
1. Turn on Alerts in your W&B [User Settings](https://wandb.ai/settings).

0 commit comments

Comments
 (0)