オートメーション

• 1: 自動化の作成
• 1.1: Slack 自動化の作成
• 1.2: Webhook オートメーションを作成する
• 2: 自動化イベントと範囲

1 - 自動化の作成

このページでは、W&B の オートメーション を作成および管理する概要を示します。詳細な手順については Slack オートメーションを作成する または Webhook オートメーションを作成する を参照してください。

要件

• チーム管理者は、チームの Projects やオートメーションのコンポーネント（Webhook、秘密情報、Slack 接続など）のオートメーションを作成および管理できます。チーム設定を参照してください。
• レジストリオートメーションを作成するには、レジストリへのアクセスが必要です。レジストリアクセスの設定を参照してください。
• Slack オートメーションを作成するには、選択した Slack インスタンスとチャンネルに投稿する権限が必要です。

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

プロジェクトまたはレジストリの Automations タブからオートメーションを作成します。オートメーションを作成するには、以下のステップに従います：

1. 必要に応じて、オートメーションに必要な各機密文字列（アクセストークン、パスワード、SSH キーなど）のために W&B の秘密情報を作成する。秘密情報は Team Settings で定義されます。秘密情報は主に Webhook オートメーションで使用されます。
2. Webhook または Slack 通知を設定して、W&B が Slack に投稿するか、代わりに Webhook を実行できるようにします。単一のオートメーションアクション（Webhook または Slack 通知）は、複数のオートメーションによって使用できます。これらのアクションは Team Settings で定義されます。
3. プロジェクトまたはレジストリで、監視するイベントと実行するアクション（Slack への投稿や Webhook の実行など）を指定するオートメーションを作成します。Webhook オートメーションを作成するときは、送信するペイロードを設定します。

詳細については、以下を参照してください：

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

オートメーションを表示および管理する

プロジェクトまたはレジストリの Automations タブからオートメーションを表示および管理します。

• オートメーションの詳細を表示するには、その名前をクリックします。
• オートメーションを編集するには、そのアクションの … メニューをクリックし、Edit automation をクリックします。
• オートメーションを削除するには、そのアクションの … メニューをクリックし、Delete automation をクリックします。

次のステップ

• Slack オートメーションを作成する。
• Webhook オートメーションを作成する。
• 秘密情報を作成する。

1.1 - Slack 自動化の作成

このページでは、Slack オートメーションを作成する方法を示します。ウェブフックオートメーションを作成するには、ウェブフックオートメーションの作成を参照してください。

高レベルでは、Slackオートメーションを作成するには、以下の手順を行います:

1. Slackインテグレーションを追加し、W&BがSlackインスタンスとチャンネルに投稿できるように認証します。
2. Slackオートメーションを作成し、監視するイベントと投稿するチャンネルを定義します。

Slackに接続

チーム管理者は、チームにSlack宛先を追加できます。

1. W&Bにログインし、チーム設定ページに移動します。

2. Slackチャンネルインテグレーションセクションで、Slackを接続をクリックして新しいSlackインスタンスを追加します。既存のSlackインスタンスにチャンネルを追加するには、新しいインテグレーションをクリックします。

   必要に応じて、ブラウザでSlackにサインインします。プロンプトが表示されたら、選択したSlackチャンネルにW&Bからの投稿を許可してください。ページを読み、チャンネルを検索をクリックしてチャンネル名を入力し始めます。リストからチャンネルを選択し、許可をクリックします。

3. Slackで、選択したチャンネルに移動します。[あなたのSlackハンドル]がこのチャンネルにインテグレーションを追加しました: Weights & Biasesという投稿が表示されれば、インテグレーションが正しく設定されています。

これで、設定したSlackチャンネルに通知するオートメーションを作成できます。

Slack接続の表示と管理

チーム管理者は、チームのSlackインスタンスとチャンネルを表示および管理できます。

1. W&Bにログインし、チーム設定に移動します。
2. Slackチャンネルインテグレーションセクションで各Slack宛先を表示します。
3. 宛先を削除するには、そのゴミ箱アイコンをクリックします。

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

W&BチームをSlackに接続した後、RegistryまたはProjectを選択し、Slackチャンネルに通知するオートメーションを作成する手順に従います。

• Registry
• Project

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

• Registry
• Project

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

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

webhook オートメーションを作成するための大まかな手順は以下の通りです。

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

webhook の作成

チーム管理者は、チームに webhook を追加できます。

1. W&B にログインし、チーム設定ページに移動します。

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

3. webhook に名前を提供します。

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

5. webhook が Bearer トークンを必要とする場合、Access token をそれを含む secretに設定します。webhook オートメーションを使用する際、W&B は Authorization: Bearer HTTP ヘッダーをアクストークンに設定し、${ACCESS_TOKEN} payload variable でトークンにアクセスできます。

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

   webhook のアクセストークンがシークレットに保存されている場合は、アクセストークンとしてシークレットを指定するために次のステップを 必ず 完了してください。

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

   1. オプションで、テスト用のペイロードを提供します。ペイロード内で webhook がアクセス可能なシークレットを参照するには、その名前に $ を付けます。このペイロードはテスト用であり保存されません。オートメーションのペイロードは create the automation で設定します。シークレットとアクセストークンが POST リクエストで指定されている場所を表示するには、Troubleshoot your webhook を参照してください。
   2. Test をクリックします。W&B は、設定された認証情報を使用して webhook のエンドポイントに接続しようとします。ペイロードを提供した場合は、W&B がそれを送信します。

   テストが成功しない場合は、webhook の設定を確認して再試行してください。必要に応じて、Troubleshoot your webhook を参照してください。

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

オートメーションの作成

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

• Registry
• Project

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

• Registry
• Project

ペイロードのリファレンス

以下のセクションを使用して、webhook のペイロードを構築します。webhook とそのペイロードのテストについての詳細は、Troubleshoot your webhook を参照してください。

ペイロード変数

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

ペイロードの例

このセクションでは、一般的なユースケースのための webhook ペイロードの例を示します。例は payload variables をどのように使用するかを示します。

• GitHub repository dispatch
• Microsoft Teams notification
• Slack notifications

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" または "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 のトラブルシューティング

W&B アプリ UI または Bash スクリプトを使用して、インタラクティブに webhook のトラブルシューティングを行います。新しい webhook を作成する際や既存の webhook を編集する際に webhook をトラブルシューティングできます。

• W&B App UI
• Bash script

Loading…

2 - 自動化イベントと範囲

あるオートメーションは、プロジェクトやレジストリのスコープ内で特定のイベントが発生したときに開始されます。プロジェクトのスコープは[スコープの技術的定義を挿入]を参照してください。このページでは、それぞれのスコープ内でオートメーションをトリガーするイベントについて説明します。

オートメーションの詳細は、オートメーション概要またはオートメーションの作成を参照してください。

レジストリ

このセクションでは、レジストリでのオートメーションのスコープとイベントについて説明します。

1. レジストリアプリをhttps://wandb.ai/registry/で開きます。
2. レジストリの名前をクリックし、オートメーションタブでオートメーションを表示および作成します。

オートメーションの作成の詳細をご覧ください。

スコープ

レジストリにおけるオートメーションは、これらのスコープで作成できます：

• レジストリ レベル：オートメーションは、特定のレジストリ内のすべてのコレクション（将来追加されるコレクションを含む）で発生するイベントを監視します。
• コレクションレベル：特定のレジストリ内の単一のコレクション。

イベント

レジストリオートメーションは、これらのイベントを監視できます：

• 新しいアーティファクトをコレクションにリンク: 新しいモデルやデータセットがレジストリに追加されたときにテストと検証。
• アーティファクトのバージョンに新しいエイリアスを追加: 新しいアーティファクトバージョンに特定のエイリアスが適用されたときに、ワークフローの特定のステップをトリガーします。たとえば、productionエイリアスが適用されたときにモデルをデプロイする。

プロジェクト

このセクションでは、プロジェクトでのオートメーションのスコープとイベントについて説明します。

1. W&Bアプリの https://wandb.ai/<team>/<project-name> にあるW&Bプロジェクトに移動します。
2. オートメーションタブでオートメーションを表示および作成します。

オートメーションの作成の詳細をご覧ください。

スコープ

プロジェクト内でオートメーションを作成できるスコープ：

• プロジェクトレベル：オートメーションは、プロジェクト内の任意のコレクションで発生するイベントを監視します。
• コレクションレベル：指定したフィルタに一致するプロジェクト内のすべてのコレクション。

イベント

プロジェクト内でオートメーションは、これらのイベントを監視できます：

• コレクションでアーティファクトの新しいバージョンが作成される: アーティファクトの各バージョンに繰り返しの処理を適用します。コレクションの指定はオプションです。たとえば、新しいデータセットアーティファクトバージョンが作成されたときにトレーニングジョブを開始します。
• アーティファクトエイリアスが追加される: プロジェクトやコレクション内の新しいアーティファクトバージョンに特定のエイリアスが適用されたときに、ワークフローの特定のステップをトリガーします。例えば、アーティファクトに test-set-quality-check エイリアスが適用されたときに一連の後処理ステップを実行します。

次のステップ

• Slackオートメーションを作成
• Webhookオートメーションを作成