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

レジストリ管理者は、そのレジストリ内でオートメーションを作成できます。レジストリのオートメーションは、将来追加されるものを含めて、そのレジストリ内のすべてのコレクションに適用されます。

1. W&B にログインします。

2. 詳細を確認するためにレジストリの名前をクリックします。

3. レジストリにスコープされているオートメーションを作成するには、Automations タブをクリックし、Create automation をクリックします。レジストリにスコープされているオートメーションは、そのすべてのコレクション（将来作成されるものを含む）に自動的に適用されます。

   レジストリ内の特定のコレクションのみにスコープされたオートメーションを作成するには、コレクションのアクション ... メニューをクリックし、Create automation をクリックします。または、コレクションを表示しながら、コレクションの詳細ページの Automations セクションにある Create automation ボタンを使用してそれに対するオートメーションを作成します。

4. 監視する Event を選択します。イベントによっては表示される追加フィールドを入力します。例えば、An artifact alias is added を選択した場合、Alias regex を指定する必要があります。Next step をクリックします。

5. webhookを所有するチームを選択します。

6. Action type を Webhooks に設定し、使用する webhook を選択します。

7. webhook にアクセストークンを設定している場合、${ACCESS_TOKEN} payload variable でトークンにアクセスできます。webhook にシークレットを設定している場合、シークレットの名前に $ を付けてペイロード内でアクセスできます。webhook の要件は webhook のサービスによって決まります。

8. Next step をクリックします。

9. オートメーションに名前を付けます。オプションで説明を入力します。Create automation をクリックします。

• レジストリのオートメーションは、レジストリの Automations タブから管理します。
• コレクションのオートメーションは、コレクションの詳細ページの Automations セクションから管理します。

これらのページのいずれかから、レジストリ管理者は既存のオートメーションを管理できます。

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

W&B からリポジトリディスパッチを送信して GitHub アクションをトリガーします。例えば、リポジトリディスパッチを on キーのトリガーとして受け入れる GitHub ワークフローファイルを持っているとしましょう。

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_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>"

テンプレート文字列を使用して W&B から GitHub Actions や他のツールにコンテキストを動的に渡します。これらのツールが Python スクリプトを呼び出すことができる場合、それらは W&B APIを通じて登録されたモデルアーティファクトを使用することができます。

• リポジトリディスパッチの詳細については、GitHub Marketplace の公式ドキュメントを参照してください。

• Webhook Automations for Model Evaluation と Webhook Automations for Model Deployment のビデオを視聴し、モデルの評価とデプロイメントのためのオートメーションを作成する方法を学びましょう。

• W&B の レポート をレビューし、GitHub Actions webhook オートメーションを使用した Model CI の作成方法を説明しています。この GitHub リポジトリ をチェックして、Modal Labs webhook を使用した model CI の作成方法を学びましょう。

チーム管理者は W&B アプリ UI を使用して webhook をインタラクティブにテストできます。

1. W&B チーム設定ページに移動します。
2. Webhooks セクションまでスクロールします。
3. webhook の名前の横にある三点リーダー（ミートボールアイコン）をクリックします。
4. Test を選択します。
5. 現れた UI パネルから、表示されるフィールドに POST リクエストを貼り付けます。
6. Test webhook をクリックします。W&B アプリ UI 内で、W&B はエンドポイントからの応答を投稿します。

Testing Webhooks in Weights & Biases のビデオを見て、デモをご覧ください。