设置通知服务

及时获知训练过程中的关键事件可以节省大量计算资源和研究人员的时间。当记录新消息或检测到运行卡顿时，Aim通知服务会向已启用的渠道（如Slack、Workplace）发送通知。

快速入门

以下是设置通知服务所需的步骤。

配置通知器。通知器配置的详细信息请参阅配置通知器章节。
启动通知服务：
```
aim-watcher --repo  start
```

Aim通知服务由以下组件组成：

Aim watcher服务。一个负责发送通知的服务。
通知器配置命令行工具。用于配置您希望接收训练运行状态通知的方式和目的地的命令行实用程序。

以下是各组件的详细说明。

配置通知器

使用aim-watcher CLI交互式选择和设置通知器。目前支持以下类型的通知器：

Slack: 在Slack频道上接收消息通知。
Workplace: 接收通知作为工作场所群组中的帖子。
日志记录器：用于将通知文本回显到观察者标准输出。

基础命令是：

aim-watcher notifiers add

一旦选择了通知类型，观察器将要求填写该特定通知所需的输入内容。

aim-watcher 允许配置多个通知器，以便您可以在多个渠道同时接收通知。添加通知器配置后，需要重新运行 aim-watcher 才能使新配置生效。

接下来的部分将分别介绍它们的设置流程。

配置Slack通知器

要执行以下步骤，您必须拥有Slack工作区的管理员权限。

以下是配置Aim通知器到Slack的步骤。

前往Slack API网页页面并点击"创建应用"按钮。
选择“从头开始”并按照步骤操作。
确保"传入Webhooks"处于激活状态。这是Aim将用于发送通知的Slack API。
创建一个新的Webhook URL并复制到剪贴板。
运行 aim-watcher notifiers add slack 当提示输入Webhook网址时，粘贴在步骤4中复制的网址。
可选修改训练运行失败消息模板。
确认设置。

配置工作区通知器

要执行以下描述的步骤，请确保您有权访问Workplace管理员面板

以下是配置Aim通知器到Workplace的步骤。

#. 前往“您的工作区”管理面板 #.

选择“集成”标签页并点击“创建自定义集成”

按照设置步骤操作。
在“权限”选项卡中，确保勾选“管理群组内容”复选框。
选择您希望接收通知的群组。
在“详情”标签页点击“创建访问令牌”并复制生成的访问令牌。
运行 aim-watcher notifiers add workplace 并提供群组ID和复制的访问令牌。
可选修改训练运行失败消息模板。
确认设置。

启用/禁用通知器配置

Aim watcher CLI 允许临时禁用或完全移除通知器。每个通知器配置都有唯一的自动生成ID，可用于操作该通知器。要列出aim仓库中可用的通知器：

aim-watcher --repo . notifiers list

> NOTIFIER ID                              TYPE       STATUS
> 88bbacb3-159d-4ee2-8f33-180addd162f1     slack      enabled
> 75fe529d-c060-4816-9cbb-246770cb8592     slack      disabled
> 248821e4-2bf3-4aa9-857e-194bf3ab2f8a     logger     enabled

您可以通过指定ID禁用通知器：

aim-watcher --repo . notifiers disable 88bbacb3-159d-4ee2-8f33-180addd162f1

并重新启用它：

aim-watcher --repo . notifiers enable 88bbacb3-159d-4ee2-8f33-180addd162f1

为了完全移除通知器配置：

aim-watcher --repo . notifiers remove 88bbacb3-159d-4ee2-8f33-180addd162f1

aim-watcher CLI 的完整参考文档可在此处here获取。

配置通知级别

可以配置记录消息时的通知级别。可用选项包括DEBUG、INFO、WARNING、ERROR。运行aim-watcher notifiers set-log-level [LVL]命令来设置级别。

注意

WARNING 被设置为默认级别。