Create an automation

• 1: Create a Slack automation
• 2: Create a webhook automation

1 - Create a Slack automation

このページでは、Slack オートメーション の作成方法について説明します。Webhook オートメーションを作成するには、代わりに Webhook オートメーションの作成 を参照してください。

大まかに言うと、Slack オートメーションを作成するには、次の手順を実行します。

1. Slack インテグレーションの追加 。これにより、Weights & Biases が Slack インスタンスと channel に投稿することを承認します。
2. Slack オートメーションの作成 。これにより、監視する event と投稿先の channel が定義されます。

Slack に接続する

Team の管理者は、Team に Slack の送信先を追加できます。

1. Weights & Biases にログインして、Team Settings ページに移動します。

2. [Slack channel integrations] セクションで、[Connect Slack] をクリックして新しい Slack インスタンスを追加します。既存の Slack インスタンスに channel を追加するには、[New integration] をクリックします。

   必要に応じて、ブラウザで Slack にサインインします。プロンプトが表示されたら、選択した Slack channel に投稿する権限を Weights & Biases に付与します。ページを読んでから、[Search for a channel] をクリックして、channel 名を入力します。リストから channel を選択し、[Allow] をクリックします。

3. Slack で、選択した channel に移動します。[Your Slack handle] added an integration to this channel: Weights & Biases のような投稿が表示された場合、インテグレーションは正しく構成されています。

これで、構成した Slack channel に通知する オートメーションの作成 ができます。

Slack 接続の表示と管理

Team の管理者は、Team の Slack インスタンスと channel を表示および管理できます。

1. Weights & Biases にログインして、[Team Settings] に移動します。
2. [Slack channel integrations] セクションで、各 Slack の送信先を表示します。
3. 送信先を削除するには、ゴミ箱アイコンをクリックします。

オートメーションの作成

Weights & Biases Team を Slack に接続 したら、[Registry] または [Project] を選択し、次の手順に従って Slack channel に通知するオートメーションを作成します。

• Registry
• Project

オートメーションの表示と管理

• Registry
• Project

2 - Create a webhook automation

このページでは、webhook オートメーション の作成方法について説明します。Slack オートメーションを作成するには、代わりに Slack オートメーションの作成 を参照してください。

大まかに言うと、webhook オートメーションを作成するには、次の手順を実行します。

1. 必要に応じて、アクセストークン、パスワード、SSH キーなど、オートメーションに必要な機密文字列ごとに W&B シークレットを作成 します。シークレットは、 Team の設定で定義されます。
2. webhook を作成 して、エンドポイントと認証の詳細を定義し、インテグレーションに必要なシークレットへのアクセスを許可します。
3. オートメーションを作成 して、監視する イベント と、Weights & Biases が送信するペイロードを定義します。ペイロードに必要なシークレットへのオートメーションアクセスを許可します。

webhook を作成する

Team の管理者は、 Team に webhook を追加できます。

1. Weights & Biases にログインし、Team の Settings ページに移動します。

2. Webhooks セクションで、New webhook をクリックします。

3. webhook の名前を入力します。

4. webhook のエンドポイント URL を入力します。

5. webhook に Bearer トークンが必要な場合は、Access token をそれを含む シークレット に設定します。webhook オートメーションを使用すると、Weights & Biases は Authorization: Bearer HTTP ヘッダーをアクセストークンに設定し、${ACCESS_TOKEN} ペイロード変数 でトークンにアクセスできます。

6. webhook のペイロードにパスワードまたはその他の機密文字列が必要な場合は、Secret をそれを含むシークレットに設定します。webhook を使用するオートメーションを設定すると、名前の先頭に $ を付けることで、ペイロード変数 としてシークレットにアクセスできます。

   webhook のアクセストークンがシークレットに保存されている場合は、次の手順も完了して、シークレットをアクセストークンとして指定する 必要 があります。

7. Weights & Biases がエンドポイントに接続して認証できることを確認するには：

   1. 必要に応じて、テストするペイロードを指定します。ペイロードで webhook がアクセスできるシークレットを参照するには、名前の先頭に $ を付けます。このペイロードはテスト専用であり、保存されません。オートメーションのペイロードは、オートメーションを作成 するときに設定します。シークレットとアクセストークンが POST リクエストのどこに指定されているかを確認するには、webhook のトラブルシューティング を参照してください。
   2. Test をクリックします。Weights & Biases は、設定した資格情報を使用して webhook のエンドポイントへの接続を試みます。ペイロードを指定した場合は、Weights & Biases がそれを送信します。

   テストが成功しない場合は、webhook の設定を確認して、もう一度お試しください。必要に応じて、webhook のトラブルシューティング を参照してください。

これで、webhook を使用する オートメーションを作成 できます。

オートメーションを作成する

webhook を設定 したら、Registry または Project を選択し、次の手順に従って webhook をトリガーするオートメーションを作成します。

• Registry
• Project

オートメーションの表示と管理

• Registry
• Project

ペイロードリファレンス

これらのセクションを使用して、webhook のペイロードを作成します。webhook とそのペイロードのテストの詳細については、webhook のトラブルシューティング を参照してください。

ペイロード変数

このセクションでは、webhook のペイロードの作成に使用できる変数について説明します。

ペイロードの例

このセクションには、一般的なユースケースの webhook ペイロードの例が含まれています。この例では、ペイロード変数 の使用方法を示します。

• GitHub リポジトリディスパッチ
• Microsoft Teams 通知
• Slack 通知

on:
repository_dispatch:
  types: BUILD_AND_DEPLOY

{
  "event_type": "BUILD_AND_DEPLOY",
  "client_payload": 
  {
    "event_author": "${event_author}",
    "artifact_version": "${artifact_version}",
    "artifact_version_string": "${artifact_version_string}",
    "artifact_collection_name": "${artifact_collection_name}",
    "project_name": "${project_name}",
    "entity_name": "${entity_name}"
    }
}

${event_type} --> "LINK_ARTIFACT" or "ADD_ARTIFACT_ALIAS"
${event_author} --> "<wandb-user>"
${artifact_version} --> "wandb-artifact://_id/QXJ0aWZhY3Q6NTE3ODg5ODg3""
${artifact_version_string} --> "<entity>/model-registry/<registered_model_name>:<alias>"
${artifact_collection_name} --> "<registered_model_name>"
${project_name} --> "model-registry"
${entity_name} --> "<entity>"

{
"@type": "MessageCard",
"@context": "http://schema.org/extensions",
"summary": "New Notification",
"sections": [
  {
    "activityTitle": "Notification from WANDB",
    "text": "This is an example message sent via Teams webhook.",
    "facts": [
      {
        "name": "Author",
        "value": "${event_author}"
      },
      {
        "name": "Event Type",
        "value": "${event_type}"
      }
    ],
    "markdown": true
  }
]
}

{
    "text": "New alert from WANDB!",
"blocks": [
    {
            "type": "section",
        "text": {
            "type": "mrkdwn",
            "text": "Registry event: ${event_type}"
        }
    },
        {
            "type":"section",
            "text": {
            "type": "mrkdwn",
            "text": "New version: ${artifact_version_string}"
        }
        },
        {
        "type": "divider"
    },
        {
            "type": "section",
        "text": {
            "type": "mrkdwn",
            "text": "Author: ${event_author}"
        }
        }
    ]
}

webhook のトラブルシューティング

Weights & Biases App UI を使用してインタラクティブに、または Bash スクリプトを使用してプログラムで webhook のトラブルシューティングを行います。新しい webhook を作成するとき、または既存の webhook を編集するときに、webhook のトラブルシューティングを行うことができます。

• Weights & Biases App UI
• Bash スクリプト