> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-dbrian-docs-serverless-training-quickstart.mintlify.site/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>
    Colabで試す
  </a>;

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

run がクラッシュしたときや、カスタムトリガーに応じて、Slack またはメールでアラートを作成できます。たとえば、トレーニングループの gradient が発散し始めたとき (NaN を返したとき) や、ML パイプラインの step が完了したときにアラートを作成できます。アラートは、個人のプロジェクトとチームのプロジェクトを含め、run を初期化したすべてのプロジェクトに適用されます。

設定すると、Slack (またはメール) で W\&B Alerts のメッセージを確認できます。

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541-dbrian-docs-serverless-training-quickstart/iro0ihRDC8az5AgK/images/track/send_alerts_slack.png?fit=max&auto=format&n=iro0ihRDC8az5AgK&q=85&s=e91b3e27f93b6af916d7314879009e58" alt="Slack アラートの設定" width="567" height="331" data-path="images/track/send_alerts_slack.png" />
</Frame>

<Note>
  W\&B Alerts を使用するには、コードに `run.alert()` を追加する必要があります。コードを変更しなくても、[Automations](/ja/models/automations/) を使えば、[artifact](/ja/models/artifacts/) のバージョンが作成されたときや、[run metric](/ja/models/runs/) がしきい値に達したとき、またはしきい値を超えて変化したときなど、W\&B 内のイベントに基づいて Slack に通知する別の方法を利用できます。

  たとえば、automation を使うと、新しいバージョンが作成されたときに Slack チャンネルに通知したり、artifact に `production` エイリアスが追加されたときに自動テスト用 webhook を実行したり、run の `loss` が許容範囲内にある場合にのみ検証ジョブを開始したりできます。

  [Automations の概要](/ja/models/automations/)を読むか、[automation を作成](/ja/models/automations/create-automations/)してください。
</Note>

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

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

<div id="automated-run-lifecycle-alerts">
  ## run ライフサイクルの自動アラート
</div>

W\&B では、コードを変更しなくても、run の完了時やクラッシュ時に通知を受け取れます。[User Settings](https://wandb.ai/settings) で **Alerts** セクションまでスクロールし、次をオンにします。

* run が正常に完了したときに通知を受け取るには、**Run finished** をオンにします。
* [`run.finish()`](/ja/models/ref/python/experiments/run#finish) を呼び出さずに run が終了したときに通知を受け取るには、**Run crashed** をオンにします。

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

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

`run.alert()` を使用して Scriptable Alerts を設定するには、次の手順を実行してください。詳細は以下のセクションで説明します。

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

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

[User Settings](https://wandb.ai/settings)で、以下を行います。

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

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

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541-dbrian-docs-serverless-training-quickstart/iro0ihRDC8az5AgK/images/track/demo_connect_slack.png?fit=max&auto=format&n=iro0ihRDC8az5AgK&q=85&s=fe5291685becf551429328f008c35cdd" alt="W&B User SettingsのAlerts設定" width="1420" height="900" data-path="images/track/demo_connect_slack.png" />
</Frame>

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

`run.alert()` をトリガーしたい箇所に、コード (Notebook または Python スクリプト) へ追加します

```python theme={null}
import wandb

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

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

Slack またはメールでアラートメッセージを確認してください。どちらにも届いていない場合は、[User Settings](https://wandb.ai/settings) で **Scriptable Alerts** のメールまたは Slack が有効になっていることを確認してください。

<div id="example">
  ## 例
</div>

このシンプルなアラートは、accuracy がしきい値を下回ると警告を送信します。この例では、アラートは少なくとも 5 分以上の間隔を空けて送信されます。

```python theme={null}
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,
        )
```

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

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

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

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

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

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

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

アラートの送信先チャンネルを変更するには、**Slack の接続を解除** をクリックしてから、もう一度接続してください。再接続後に、別の Slack チャンネルを選択します。
