Create a webhook automation

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

1. Weights & Biases にログインします。

2. Registry の名前をクリックして詳細を表示します。

3. Registry の範囲に設定されたオートメーションを作成するには、Automations タブをクリックし、Create automation をクリックします。Registry の範囲に設定されたオートメーションは、そのすべてのコレクション（今後作成されるものを含む）に自動的に適用されます。

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

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

5. webhook を所有する Team を選択します。

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

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

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

9. オートメーションの名前を入力します。必要に応じて、説明を入力します。Create automation をクリックします。

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

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

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

Weights & Biases からリポジトリディスパッチを送信して、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" 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>"

テンプレート文字列を使用して、Weights & Biases から GitHub Actions およびその他のツールにコンテキストを動的に渡します。これらのツールが Python スクリプトを呼び出すことができる場合は、Weights & Biases API を使用して、登録されたモデル Artifacts を利用できます。

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

• モデル評価の Webhook オートメーション および モデルデプロイメントの Webhook オートメーション のビデオをご覧ください。これらのビデオでは、モデル評価およびデプロイメントのオートメーションを作成する方法を説明しています。

• Weights & Biases レポート を確認してください。このレポートでは、モデル CI に Github Actions webhook オートメーションを使用する方法を示しています。この GitHub リポジトリ をチェックして、Modal Labs webhook でモデル CI を作成する方法を学んでください。

Team 管理者は、Weights & Biases App UI を使用して webhook をインタラクティブにテストできます。

1. Weights & Biases Team の Settings ページに移動します。
2. Webhooks セクションまでスクロールします。
3. webhook の名前の横にある水平方向の 3 つのドキュメント（ミートボールアイコン）をクリックします。
4. Test を選択します。
5. 表示される UI パネルから、表示されるフィールドに POST リクエストを貼り付けます。
6. Test webhook をクリックします。Weights & Biases App UI 内で、Weights & Biases はエンドポイントからの応答を投稿します。

デモンストレーションについては、ビデオ Weights & Biases での Webhook のテスト をご覧ください。