up
|
Before Width: | Height: | Size: 180 KiB After Width: | Height: | Size: 180 KiB |
|
Before Width: | Height: | Size: 222 KiB |
|
Before Width: | Height: | Size: 232 KiB |
|
Before Width: | Height: | Size: 609 KiB After Width: | Height: | Size: 609 KiB |
|
Before Width: | Height: | Size: 367 KiB After Width: | Height: | Size: 367 KiB |
|
Before Width: | Height: | Size: 79 KiB After Width: | Height: | Size: 79 KiB |
|
Before Width: | Height: | Size: 307 KiB After Width: | Height: | Size: 307 KiB |
|
Before Width: | Height: | Size: 311 KiB After Width: | Height: | Size: 311 KiB |
|
Before Width: | Height: | Size: 74 KiB After Width: | Height: | Size: 74 KiB |
|
Before Width: | Height: | Size: 288 KiB After Width: | Height: | Size: 288 KiB |
|
Before Width: | Height: | Size: 376 KiB After Width: | Height: | Size: 376 KiB |
|
Before Width: | Height: | Size: 348 KiB After Width: | Height: | Size: 348 KiB |
120
docs/tutorial.md
@ -32,7 +32,7 @@
|
||||
|
||||

|
||||
|
||||
下载完成后打开安装包<small>(忽略这个是 3.11 版的安装界面)</small>,**一定要记得勾选 Add python.exe to PATH!!!** 然后直接点击 Install Now 安装即可
|
||||
下载完成后打开安装包<sub><sup>(忽略这个是 3.11 版的安装界面)</sup></sub>,**一定要记得勾选 Add python.exe to PATH!!!** 然后直接点击 Install Now 安装即可
|
||||
|
||||
如果要更改安装路径可以选择 Customize Installation 后自行更改后继续安装,注意安装路径最好不要有中文
|
||||
|
||||
@ -100,7 +100,7 @@ pyenv global 3.12
|
||||
python -V
|
||||
```
|
||||
|
||||
<small>(忽略这里的 Python 版本为 3.11)</small>
|
||||
<sub><sup>(忽略这里的 Python 版本为 3.11)</sup></sub>
|
||||

|
||||
|
||||
## 2. 部署 NoneBot
|
||||
@ -109,7 +109,7 @@ python -V
|
||||
|
||||
先找一个心仪的目录来放置你的 NoneBot2 项目,注意路径中最好不要存在中文
|
||||
|
||||
Windows 用户在资源管理器中单击地址栏后输入 `powershell` 回车即可打开命令行<small>(忽略我输入的是 pwsh)</small>,如图
|
||||
Windows 用户在资源管理器中单击地址栏后输入 `powershell` 回车即可打开命令行<sub><sup>(忽略我输入的是 pwsh)</sup></sub>,如图
|
||||
|
||||

|
||||
|
||||
@ -145,7 +145,7 @@ nb bs
|
||||
## 3. 安装插件
|
||||
|
||||
接上一步操作,在命令行中输入下面的命令将工作目录切换到你创建好的项目目录中
|
||||
<small>或者在资源管理器中打开项目文件夹后单击地址栏输入 `powershell` 回车打开新的命令行窗口</small>
|
||||
<sub><sup>或者在资源管理器中打开项目文件夹后单击地址栏输入 `powershell` 回车打开新的命令行窗口</sup></sub>
|
||||
|
||||
```shell
|
||||
cd 项目名
|
||||
@ -157,80 +157,16 @@ cd 项目名
|
||||
nb plugin install nonebot-plugin-nailongremove
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> 上面方式安装的插件仅支持以 CPU 推理 AI 模型,
|
||||
> 配置以 GPU 运行的环境会非常麻烦,仅推荐专业用户操作,相关信息请查看 README
|
||||
|
||||
安装过程如图
|
||||
|
||||

|
||||

|
||||
|
||||
## 4. 模型相关配置
|
||||
|
||||
接上一节,先进入虚拟环境,进入虚拟环境后命令行左侧应该会多出来你虚拟环境的名字
|
||||
|
||||
```shell
|
||||
nb sh
|
||||
```
|
||||
|
||||
接下来介绍安装完插件后要使用对应模型所需要额外做的一些操作
|
||||
|
||||
> [!NOTE]
|
||||
> 以下的每节内容中,请在 CPU 运行 和 GPU 运行 中 **只选择其中一节** 进行操作即可
|
||||
>
|
||||
> 如果你的机器没有英伟达(NVIDIA)显卡(GPU),或者你想避免麻烦的专业操作,请选择按照 CPU 运行 一节操作
|
||||
|
||||
### 4.1. 模型 1(默认)
|
||||
|
||||
如果想要使用默认的模型 1,为了避免一些问题,onnxruntime 没有包括在插件依赖里,不会随插件安装而自动安装,你需要自行安装
|
||||
|
||||
> [!NOTE]
|
||||
> 从旧版本升级上来的用户务必卸载原先混装在一起的 onnxruntime 之后按照下面的内容操作一遍
|
||||
>
|
||||
> 卸载命令:
|
||||
>
|
||||
> ```shell
|
||||
> pip uninstall onnxruntime onnxruntime-gpu
|
||||
> ```
|
||||
|
||||
#### 4.1.1. CPU 运行
|
||||
|
||||
直接运行下面命令安装 `onnxruntime` 即可
|
||||
|
||||
```shell
|
||||
pip install onnxruntime
|
||||
```
|
||||
|
||||
#### 4.1.2. GPU 运行
|
||||
|
||||
首先安装 `onnxruntime-gpu`
|
||||
|
||||
```shell
|
||||
pip install onnxruntime-gpu
|
||||
```
|
||||
|
||||
检查你安装的 `onnxruntime-gpu` 版本,对照 [这里](https://onnxruntime.ai/docs/execution-providers/CUDA-ExecutionProvider.html#requirements) 检查你安装的版本需要的 CUDA 和 cuDNN 版本,如果没有安装则需要自行安装(教程待补充)
|
||||
|
||||
接下来在 [这里](https://pytorch.org/get-started/locally/) 筛选对应信息后复制命令安装支持 CUDA 的 `pytorch` 库
|
||||
|
||||
最后更改插件配置项,让 `onnxruntime` 使用 CUDA 运行([NoneBot 配置简单介绍看这里](#72-修改插件配置项))
|
||||
|
||||
```properties
|
||||
NAILONG_ONNX_PROVIDERS=["CUDAExecutionProvider"]
|
||||
```
|
||||
|
||||
### 4.2. 模型 0
|
||||
|
||||
#### 4.2.1. CPU 运行
|
||||
|
||||
执行下面的命令来安装额外依赖
|
||||
|
||||
```shell
|
||||
pip install "nonebot-plugin-nailongremove[model0]"
|
||||
```
|
||||
|
||||
#### 4.2.2. GPU 运行
|
||||
|
||||
参照 [4.1.2](#412-gpu-运行) 部分安装支持 CUDA 的 `pytorch` 库即可
|
||||
|
||||
## 5. 启动 NoneBot
|
||||
## 4. 启动 NoneBot
|
||||
|
||||
在命令行中输入以下命令并回车启动 NoneBot
|
||||
|
||||
@ -245,22 +181,22 @@ Linux 下也可以使用 `./#run.sh`
|
||||
|
||||
启动完成并且没问题的话,应该像下面这样,没有任何报错
|
||||
|
||||

|
||||

|
||||
|
||||
## 6. 配置野生 QQ 机器人协议端连接 NoneBot
|
||||
## 5. 配置野生 QQ 机器人协议端连接 NoneBot
|
||||
|
||||
如果你想对接其他聊天平台(在第二步时安装了其他的适配器),请略过这节并自行查看对应平台适配器的文档,见 [适配器商店](https://nonebot.dev/store/adapters)
|
||||
|
||||
请在以下协议实现中选择**其中一个**你心仪的开始使用即可
|
||||
|
||||
### 6.1. Lagrange.OneBot
|
||||
### 5.1. Lagrange.OneBot
|
||||
|
||||
第三方的 NTQQ 协议实现
|
||||
|
||||
打开 Lagrange 存储库的 Actions 页,筛选 Lagrange.OneBot Build 的 Workflow,然后筛选 master 分支([可以点这里](https://github.com/LagrangeDev/Lagrange.Core/actions/workflows/Lagrange.OneBot-build.yml?query=branch%3Amaster))
|
||||
|
||||
(这里是手动打开的步骤,从上面链接点进去的可以不用看)
|
||||

|
||||

|
||||
|
||||
之后找到对应你机器系统架构的构建产物下载
|
||||
如果下面的文件列表无法点击下载,请登录 GitHub 账号
|
||||
@ -279,31 +215,31 @@ Linux 下也可以使用 `./#run.sh`
|
||||
</p>
|
||||
|
||||
例:Windows、X86 架构 CPU、64 位系统(一般的家用电脑和 Windows 云服务器都是这样的)下载这个:
|
||||

|
||||

|
||||
|
||||
下载完成后打开压缩包,找一个你喜欢的目录将里面的可执行文件解压出来,之后双击运行,看到下图样的提示后先直接把它关掉
|
||||
|
||||

|
||||

|
||||
|
||||
打开同目录下 Lagrange 生成的 `appsettings.json`
|
||||
|
||||
把 `Uin` 后的 `0` 替换为你 Bot 的 QQ 号,密码不动留空使用扫码登录,如下图
|
||||
|
||||

|
||||

|
||||
|
||||
接着修改,让它能以反向 Websocket 连接到 NoneBot,参考下图,记得把下面 `Port` 后的 `8080` 修改成你之前配置的端口号
|
||||
|
||||

|
||||

|
||||
|
||||
之后再次运行 Lagrange,手机登录 Bot 的 QQ 扫码登录
|
||||
|
||||

|
||||

|
||||
|
||||
之后你应该可以看到你的 NoneBot 提示已经连接到 Bot 并可以正常接受消息了
|
||||
|
||||

|
||||

|
||||
|
||||
### 6.2. NapCat
|
||||
### 5.2. NapCat
|
||||
|
||||
基于 QQNT 本体的协议实现,需要安装 QQNT 客户端,但可以以无头(无图形界面)方式启动
|
||||
|
||||
@ -322,13 +258,13 @@ Linux 下也可以使用 `./#run.sh`
|
||||
}
|
||||
```
|
||||
|
||||
## 7. 后续
|
||||
## 6. 后续
|
||||
|
||||
### 7.1. 重新启动
|
||||
### 6.1. 重新启动
|
||||
|
||||
无需再做前面的部署操作,参考 [第 5 节](#5-启动-nonebot) 启动你的 NoneBot,之后直接启动你在 第 6 节 中配置好的协议端即可
|
||||
无需再做前面的部署操作,参考 [第 4 节](#4-启动-nonebot) 启动你的 NoneBot,之后直接启动你在 第 5 节 中配置好的协议端即可
|
||||
|
||||
### 7.2. 修改插件配置项
|
||||
### 6.2. 修改插件配置项
|
||||
|
||||
参考 [NoneBot 文档 DotEnv 配置 一节](https://nonebot.dev/docs/appendices/config#dotenv-%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6) 的文件格式,修改 `.env.prod` 文件即可
|
||||
|
||||
@ -338,7 +274,7 @@ Linux 下也可以使用 `./#run.sh`
|
||||
NAILONG_MODEL=1
|
||||
```
|
||||
|
||||

|
||||

|
||||
|
||||
多行配置项例子:
|
||||
|
||||
@ -357,9 +293,9 @@ NAILONG_TIP='
|
||||
'
|
||||
```
|
||||
|
||||

|
||||

|
||||
|
||||
### 7.3. 更新插件
|
||||
### 6.3. 更新插件
|
||||
|
||||
在 Bot 项目目录下打开命令行,之后执行下面命令即可
|
||||
|
||||
@ -367,7 +303,7 @@ NAILONG_TIP='
|
||||
nb plugin update nonebot-plugin-nailongremove
|
||||
```
|
||||
|
||||
### 7.4. 常见问题
|
||||
### 6.4. 常见问题
|
||||
|
||||
待补充
|
||||
|
||||
|
||||