Skip to content

Commit 686c594

Browse files
authored
docs: add neuronex ai function install guide (#138)
1 parent 487df89 commit 686c594

File tree

6 files changed

+30
-0
lines changed

6 files changed

+30
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11

22
.DS_Store
3+
.history/
4+
.idea/

directory.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@
4747
{
4848
"title": "申请和安装许可证",
4949
"path": "installation/license_setting"
50+
},
51+
{
52+
"title": "安装 AI 功能",
53+
"path": "installation/ai"
5054
}
5155
]
5256
},
@@ -1145,6 +1149,10 @@
11451149
{
11461150
"title": "Application and Installation License",
11471151
"path": "installation/license_setting"
1152+
},
1153+
{
1154+
"title": "Install AI Function",
1155+
"path": "installation/ai"
11481156
}
11491157
]
11501158
},
25.3 KB
Loading

en_US/installation/ai.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# NeuronEX AI Function Installation Package Installation Guide
2+
3+
1. Download the corresponding installation package according to the current environment. For example: neuronex-3.6.0-beta.3-linux-amd64.deb.
4+
2. Install NeuronEX with reference to the documentation: [install NeuronEX](./introduction.md)
5+
3. Enter the AI function module directory. The default directory for the AI function of NeuronEX managed by systemd is: /opt/neuronex/software/neuronex-ai.
6+
4. The AI function of NeuronEX uses uv as the project management tool. If uv is not installed, it needs to be installed first. For details, refer to: [Installing uv](https://docs.astral.sh/uv/getting-started/installation/)
7+
5. After successfully installing uv, use the following command to test whether the AI function can be started normally: uv sync && cd src/apps_entry && uv run main.py.
8+
6. If the above command shows the following prompt, it means that the AI - related dependent libraries have been installed successfully:
9+
![neuronex ai hint](./_assets/neuronex-ai-install.png)
10+
7. If the environment cannot install uv and the dependent libraries normally, you can find available domestic mirror repositories, or use the NeuronEX container images with the -ai or -ai - arm64 suffix to deploy the NeuronEX service. The images already have a complete AI function.
25.3 KB
Loading

zh_CN/installation/ai.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# NeuronEX AI 功能安装包安装指南
2+
3+
1. 根据当前环境, 下载对应的安装包, 例如: neuronex-3.6.0-beta.3-linux-amd64.deb
4+
2. 参考文档安装 NeuronEX: [安装 NeuronEX](./introduction.md)
5+
3. 进入 AI 功能模块目录, systemd 托管的 NeuronEX 的 AI 功能默认目录是: /opt/neuronex/software/neuronex-ai
6+
4. NeuronEX 的 AI 功能采用 uv 作为项目管理工具, 如果没有 uv, 需要先安装, 具体参考: [Installing uv](https://docs.astral.sh/uv/getting-started/installation/)
7+
5. uv 安装成功后, 使用如下命令测试 AI 功能是否能正常启动: uv sync && cd src/apps_entry && uv run main.py
8+
6. 如果上面的命令出现如下提示, 则表示 AI 相关依赖库已安装成功:
9+
![neuronex ai hint](./_assets/neuronex-ai-install.png)
10+
7. 如果所处环境无法正常安装 uv 和依赖库, 可以寻找可用的国内镜像库, 或者使用 NeuronEX 带 -ai 或者 -ai-arm64 后缀的容器镜像来部署 NeuronEX 服务, 镜像中已经有完整的 AI 功能.

0 commit comments

Comments
 (0)