> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wandb.ai/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" />

실행이 크래시되거나 사용자 정의 트리거 조건을 만족하면 Slack 또는 이메일 알림을 보내도록 설정할 수 있습니다. 예를 들어, 학습 루프의 그래디언트가 폭주하기 시작해 NaN을 보고하거나, ML 파이프라인의 한 단계가 완료되었을 때 알림을 만들 수 있습니다. 알림 설정은 개인 프로젝트와 팀 프로젝트를 포함해 실행을 초기화하는 모든 프로젝트에 적용됩니다.

그리고 Slack(또는 이메일)에서 W\&B Alerts 메시지를 확인할 수 있습니다:

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541/_OEDykSS2PIumrEw/images/track/send_alerts_slack.png?fit=max&auto=format&n=_OEDykSS2PIumrEw&q=85&s=a3ebc3dccaa85a8c8df635f9eca20101" alt="Slack 알림 설정" width="567" height="331" data-path="images/track/send_alerts_slack.png" />
</Frame>

<Note>
  W\&B Alerts를 사용하려면 코드에 `run.alert()`를 추가해야 합니다. 코드를 수정하지 않고도 [Automations](/ko/models/automations/)를 사용하면 [artifact](/ko/models/artifacts/) 아티팩트 버전이 생성되거나 [run metric](/ko/models/runs/)이 특정 임계값에 도달하거나 변화하는 등 W\&B에서 발생하는 이벤트를 기준으로 Slack에 알림을 보내는 다른 방식을 사용할 수 있습니다.

  예를 들어, 자동화는 새 버전이 생성될 때 Slack 채널에 알림을 보내거나, `production` 별칭이 아티팩트에 추가되면 자동 테스트 웹훅을 실행하거나, 실행의 `loss`가 허용 가능한 범위에 있을 때만 검증 작업을 시작하도록 설정할 수 있습니다.

  [Automations 개요](/ko/models/automations/)를 읽거나 [자동화 생성](/ko/models/automations/create-automations/)을 진행하세요.
</Note>

<Note>
  다음 가이드는 멀티 테넌트 클라우드에서의 알림에만 적용됩니다.

  Private Cloud 또는 W\&B Dedicated Cloud에서 [W\&B Server](/ko/platform/hosting/)를 사용하는 경우, Slack 알림을 설정하려면 [W\&B Server에서 Slack 알림 구성](/ko/platform/hosting/monitoring-usage/slack-alerts)을 참조하세요.
</Note>

<div id="automated-run-lifecycle-alerts">
  ## 자동 run 라이프사이클 알림
</div>

W\&B는 코드를 변경하지 않아도 run이 완료되거나 크래시될 때 알림을 보낼 수 있습니다. [User Settings](https://wandb.ai/settings)에서 **Alerts** 섹션까지 스크롤한 다음, 다음 항목을 켜세요.

* run이 성공적으로 완료될 때 알림을 받으려면 **Run finished**
* [`run.finish()`](/ko/models/ref/python/experiments/run#finish)를 호출하지 않고 run이 크래시될 때 알림을 받으려면 **Run crashed**

이 설정은 사용자별로 적용됩니다. Jupyter notebook에서 실행한 run에는 **Run finished** 알림이 전송되지 않습니다. notebook에서는 완료 알림을 위해 `run.alert()`를 사용하세요.

알림은 같은 User Settings 패널에서 설정한 이메일 또는 Slack으로 전송됩니다. 이 전송 설정은 스크립트형 알림과 공유되며, 이에 대해서는 다음 섹션에서 설명합니다. 스크립트형 알림을 사용하면 metric threshold나 NaN loss와 같은 맞춤형 조건에서 알림을 트리거할 수 있습니다.

`run.alert()`로 스크립트형 알림을 설정하려면 다음 단계를 따르세요. 자세한 내용은 다음 섹션에서 설명합니다.

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 사용자 설정에서 알림 켜기
</div>

[User Settings](https://wandb.ai/settings)에서 다음을 수행합니다:

* **Alerts** 섹션까지 스크롤합니다.
* `run.alert()`에서 보내는 알림을 받으려면 **Scriptable run alerts**를 켭니다.
* **Connect Slack**을 사용해 알림을 게시할 Slack 채널을 선택합니다. 알림을 비공개로 유지하려면 **Slackbot** 채널을 사용하는 것을 권장합니다.
* **Email** 알림은 W\&B에 가입할 때 사용한 이메일 주소로 전송됩니다. 이 알림이 모두 특정 폴더로 들어가도록 이메일 필터를 설정해 받은편지함이 가득 차지 않도록 하는 것을 권장합니다.

이는 W\&B Alerts를 처음 설정할 때 한 번만 하면 되며, 이후 알림을 받는 방식을 변경하고 싶을 때에만 다시 설정하면 됩니다.

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541/_OEDykSS2PIumrEw/images/track/demo_connect_slack.png?fit=max&auto=format&n=_OEDykSS2PIumrEw&q=85&s=93436de7124ffccc9a07c3af6460b2bc" alt="W&B 사용자 설정의 알림 설정" 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>

노트북 또는 Python 스크립트에서 알림을 트리거하고 싶은 위치에 `run.alert()`를 코드에 추가하세요

```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>

이 간단한 알림은 정확도가 임계값 아래로 떨어질 때 경고를 보냅니다. 이 예시에서는 알림을 최소 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>

알림의 제목이나 본문에서 본인 또는 동료를 태그하려면 at 기호 `@` 뒤에 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>

알림이 전송되는 채널을 변경하려면 **Disconnect Slack**을 클릭한 다음 다시 연결하세요. 다시 연결한 후 알림을 받을 다른 Slack 채널을 선택하세요.
