> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coreweave.com/llms.txt
> Use this file to discover all available pages before exploring further.

> Python コードからアラートをトリガーして、Slack またはメールに送信します

# アラートを送信する

export const ColabLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="colab-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M14.25.18l.9.2.73.26.59.3.45.32.34.34.25.34.16.33.1.3.04.26.02.2-.01.13V8.5l-.05.63-.13.55-.21.46-.26.38-.3.31-.33.25-.35.19-.35.14-.33.1-.3.07-.26.04-.21.02H8.77l-.69.05-.59.14-.5.22-.41.27-.33.32-.27.35-.2.36-.15.37-.1.35-.07.32-.04.27-.02.21v3.06H3.17l-.21-.03-.28-.07-.32-.12-.35-.18-.36-.26-.36-.36-.35-.46-.32-.59-.28-.73-.21-.88-.14-1.05-.05-1.23.06-1.22.16-1.04.24-.87.32-.71.36-.57.4-.44.42-.33.42-.24.4-.16.36-.1.32-.05.24-.01h.16l.06.01h8.16v-.83H6.18l-.01-2.75-.02-.37.05-.34.11-.31.17-.28.25-.26.31-.23.38-.2.44-.18.51-.15.58-.12.64-.1.71-.06.77-.04.84-.02 1.27.05zm-6.3 1.98l-.23.33-.08.41.08.41.23.34.33.22.41.09.41-.09.33-.22.23-.34.08-.41-.08-.41-.23-.33-.33-.22-.41-.09-.41.09zm13.09 3.95l.28.06.32.12.35.18.36.27.36.35.35.47.32.59.28.73.21.88.14 1.04.05 1.23-.06 1.23-.16 1.04-.24.86-.32.71-.36.57-.4.45-.42.33-.42.24-.4.16-.36.09-.32.05-.24.02-.16-.01h-8.22v.82h5.84l.01 2.76.02.36-.05.34-.11.31-.17.29-.25.25-.31.24-.38.2-.44.17-.51.15-.58.13-.64.09-.71.07-.77.04-.84.01-1.27-.04-1.07-.14-.9-.2-.73-.25-.59-.3-.45-.33-.34-.34-.25-.34-.16-.33-.1-.3-.04-.25-.02-.2.01-.13v-5.34l.05-.64.13-.54.21-.46.26-.38.3-.32.33-.24.35-.2.35-.14.33-.1.3-.06.26-.04.21-.02.13-.01h5.84l.69-.05.59-.14.5-.21.41-.28.33-.32.27-.35.2-.36.15-.36.1-.35.07-.32.04-.28.02-.21V6.07h2.09l.14.01.21.03zm-6.47 14.25l-.23.33-.08.41.08.41.23.33.33.23.41.08.41-.08.33-.23.23-.33.08-.41-.08-.41-.23-.33-.33-.23-.41-.08-.41.08z" />
    </svg>
    Try in Colab
  </a>;

<ColabLink url="https://wandb.me/alerts-colab" />

run がクラッシュしたときや、カスタムトリガーの条件を満たしたときに、Slack またはメールで通知するアラートを作成できます。たとえば、トレーニングループの勾配が発散し始めたとき (NaN が報告されたとき) や、ML パイプラインのステップが完了したときにアラートを送信できます。アラートは、個人の project とチームの project を問わず、run を初期化するすべての project に適用されます。

アラートを作成すると、Slack (またはメール) で W\&B Alerts のメッセージを受け取れます。

<Frame>
  <img src="https://mintcdn.com/coreweave-dbfa0e8d/3Dv_sw2eg8feUJlx/products/wandb/_media/send_alerts_slack.png?fit=max&auto=format&n=3Dv_sw2eg8feUJlx&q=85&s=3739fea03fd05adb2a76cbd8d20514b0" alt="Slack アラートの設定" width="567" height="331" data-path="products/wandb/_media/send_alerts_slack.png" />
</Frame>

<Note>
  W\&B Alerts を使用するには、コードに `run.alert()` を追加する必要があります。コードを変更したくない場合は、[オートメーション](/ja/products/wandb/automations)を使用して、W\&B のイベントに応じて Slack に通知することもできます。たとえば、[アーティファクト](/ja/products/wandb/artifacts)のバージョンが作成されたときや、[run のメトリクス](/ja/products/wandb/runs)がしきい値に達したとき、またはしきい値以上変化したときなどです。

  具体的には、オートメーションを使用すると、新しいバージョンが作成されたときに Slack チャンネルに通知したり、アーティファクトに `production` エイリアスが追加されたときに自動テスト用の webhook を実行したり、run の `loss` が許容範囲内の場合にのみ検証ジョブを開始したりできます。

  詳しくは、[オートメーションの概要](/ja/products/wandb/automations)または[オートメーションの作成](/ja/products/wandb/automations/create-automations)を参照してください。
</Note>

<Note>
  以下のガイドは、Multi-tenant Cloud のアラートにのみ適用されます。

  プライベートクラウドまたは W\&B 専用クラウドで [W\&B Server](/ja/products/wandb/platform/hosting) を使用している場合は、[W\&B Server で Slack アラートを設定する](/ja/products/wandb/platform/hosting/monitoring-usage/slack-alerts)を参照して Slack アラートを設定してください。
</Note>

<h2 id="automated-run-lifecycle-alerts">
  run のライフサイクルに関する自動アラート
</h2>

W\&B では、コードを変更しなくても、run が終了またはクラッシュしたときに通知を受け取れます。[User Settings](https://forge.coreweave.com/settings) で **Alerts** セクションまでスクロールし、以下をオンにします。

* **Run finished**：run が正常に完了したときに通知を受け取ります。
* **Run crashed**：[`run.finish()`](/ja/products/wandb/ref/python/experiments/run#finish) が呼び出されずに run が終了したときに通知を受け取ります。

これらのトグルはユーザーごとに設定されます。Jupyter ノートブック内の run では、**Run finished** アラートは送信されません。ノートブックで完了通知を受け取るには、`run.alert()` を使用してください。

Alerts はメールまたは Slack に配信されます。配信先は同じ User Settings パネルで設定します。この配信設定は Scriptable Alerts でも共通して使用されます。Scriptable Alerts を使用すると、メトリクスのしきい値や損失の NaN など、カスタム条件に基づいてアラートをトリガーできます。詳しくは以下のセクションで説明します。

`run.alert()` を使用して Scriptable Alerts を設定する手順は次のとおりです。各手順の詳細は以下のセクションで説明します。

1. W\&B の [User Settings](https://forge.coreweave.com/settings) で Alerts をオンにします。
2. コードに `run.alert()` を追加します。
3. 設定をテストします。

<h3 id="1-turn-on-alerts-in-your-wb-user-settings">
  1) W\&B User Settings でアラートを有効にする
</h3>

[User Settings](https://forge.coreweave.com/settings) で次の操作を行います。

* **Alerts** セクションまでスクロールします
* `run.alert()` からのアラートを受け取るには、**Scriptable run alerts** を有効にします
* **Connect Slack** を使用して、アラートの投稿先となる Slack チャンネルを選択します。アラートを非公開にできるため、**Slackbot** チャンネルの使用をおすすめします。
* **Email** は、W\&B への登録時に使用したメールアドレスに送信されます。受信トレイがアラートで埋まらないよう、メールのフィルターを設定して、これらのアラートをすべて特定のフォルダーに振り分けることをおすすめします。

この設定が必要なのは、W\&B Alerts を初めて設定するときと、アラートの受信方法を変更するときだけです。

<Frame>
  <img src="https://mintcdn.com/coreweave-dbfa0e8d/3Dv_sw2eg8feUJlx/products/wandb/_media/demo_connect_slack.png?fit=max&auto=format&n=3Dv_sw2eg8feUJlx&q=85&s=447031fea4fc850c58c6910d1aa6059d" alt="W&B User Settings のアラート設定" width="1420" height="900" data-path="products/wandb/_media/demo_connect_slack.png" />
</Frame>

<h3 id="2-add-runalert-to-your-code">
  2. コードに `run.alert()` を追加する
</h3>

コード (ノートブックまたは Python スクリプト) 内の、アラートをトリガーしたい箇所に `run.alert()` を追加します

```python theme={"system"}
import wandb

with wandb.init() as run:
    run.alert(title="High Loss", text="Loss is increasing rapidly")
```

<h3 id="3-test-the-configuration">
  3. 設定をテストする
</h3>

Slack またはメールにアラートメッセージが届いているか確認してください。届いていない場合は、[User Settings](https://forge.coreweave.com/settings) で **Scriptable Alerts** のメール通知または Slack 通知がオンになっているか確認してください

<h2 id="example">
  例
</h2>

このシンプルなアラートは、精度がしきい値を下回ると警告を送信します。この例では、アラートの送信間隔を 5 分以上空けるように設定しています。

```python theme={"system"}
import wandb
from wandb import AlertLevel

with wandb.init() as run:

    if acc < threshold:
        run.alert(
            title="Low accuracy",
            text=f"Accuracy {acc} is below the acceptable threshold {threshold}",
            level=AlertLevel.WARN,
            wait_duration=300,
        )
```

<h2 id="tag-or-mention-users">
  ユーザーをタグ付けまたはメンションする
</h2>

アラートのタイトルまたは本文で自分や同僚をタグ付けするには、アットマーク `@` に続けて Slack のユーザー ID を指定します。Slack のユーザー ID は、各ユーザーの Slack プロフィールページで検索できます。

```python theme={"system"}
run.alert(title="Loss is NaN", text=f"Hey <@U1234ABCD> loss has gone to NaN")
```

<h2 id="configure-team-alerts">
  チームアラートを設定する
</h2>

チーム管理者は、チーム設定ページ (`wandb.ai/teams/your-team`) でチームのアラートを設定できます。

チームアラートはチームの全員に適用されます。アラートを非公開に保てるため、W\&B は **Slackbot** チャンネルの使用を推奨しています。

<h2 id="change-slack-channel-to-send-alerts-to">
  アラートの送信先 Slack チャンネルを変更する
</h2>

アラートの送信先チャンネルを変更するには、**Disconnect Slack** をクリックしてから再接続し、別の Slack チャンネルを選択します。
