doc: update doc. (#30453)

This commit is contained in:
Haojun Liao 2025-03-25 17:45:21 +08:00 committed by GitHub
parent 4c023e5a4b
commit caa15959cd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 84 additions and 14 deletions

View File

@ -6,11 +6,11 @@ sidebar_label: "安装部署"
import PkgListV3 from "/components/PkgListV3";
# 使用 TDgpt Docker 镜像
## 使用 TDgpt Docker 镜像
本节首先介绍如何通过 Docker 快速使用 TDgpt。
## 启动 TDgpt
### 启动 TDgpt
如果已经安装了 Docker首先拉取最新的 TDengine 容器镜像:
@ -47,13 +47,13 @@ docker exec -it <container name> bash
然后就可以执行相关的 Linux 命令操作和访问 TDengine。
# 注册云服务使用 TDgpt
## 注册云服务使用 TDgpt
TDgpt 可以在 TDengine Cloud 上进行快速体验。如果您已经有云服务账号,请在数据库集市里面找到“时序数据预测分析数据集”数据库,点击启用就可以进入这个数据库,然后按照 TDgpt 的 SQL 操作手册来执行语句,比如 `select forecast(val, 'algo=tdtsfm_1') from forecast.electricity_demand;`
# 通过安装包部署 TDgpt
## 通过安装包部署 TDgpt
## 环境准备
### 环境准备
使用 TDgpt 的高级时序数据分析功能需要在 TDengine 集群中安装部署Taos AI nodeAnode。Anode 运行在 Linux 平台上,并需要 3.10 或以上版本的 Python 环境支持。
@ -61,7 +61,7 @@ TDgpt 可以在 TDengine Cloud 上进行快速体验。如果您已经有云服
可以使用以下的命令在 Ubuntu Linux 上安装 Python 3.10 环境
### 安装 Python
#### 安装 Python
```shell
sudo apt-get install software-properties-common
@ -74,7 +74,7 @@ sudo apt install python3.10-venv
sudo apt install python3.10-dev
```
### 安装 PiPy
#### 安装 PiPy
```shell
curl -sS https://bootstrap.pypa.io/get-pip.py | python3.10
@ -86,7 +86,7 @@ export PATH=$PATH:~/.local/bin
```
至此 Python 环境准备完成,可以进行 taosanode 的安装和部署。
## 获取安装包
### 获取安装包
1. 从列表中下载获得 tar.gz 安装包:
<PkgListV3 type={9}/>
@ -98,7 +98,7 @@ export PATH=$PATH:~/.local/bin
tar -zxvf TDengine-TDgpt-<version>-Linux-x64.tar.gz
```
## 执行安装脚本
### 执行安装脚本
解压文件后,进入相应子目录,执行其中的 `install.sh` 安装脚本:
请将 `<version>` 替换为下载的安装包版本
@ -110,11 +110,11 @@ sudo ./install.sh
为了避免影响系统已有的 Python 环境Anode 使用虚拟环境运行。安装 Anode 会在目录 `/var/lib/taos/taosanode/venv/` 中创建默认的 Python 虚拟环境Anode 运行所需要的库均安装在该目录下。为了避免反复安装虚拟环境带来的开销,卸载命令 `rmtaosanode` 并不会自动删除该虚拟环境,如果您确认不再需要 Python 的虚拟环境,手动删除该目录即可。
## 激活使用虚拟环境
### 激活使用虚拟环境
为了避免安装操作系统的Python 环境, TDgpt 安装过程中会自动创建一个虚拟环境,该虚拟环境默认创建的路径在 `/var/lib/taos/taosanode/venv/`。创建完成该虚拟环境,该虚拟环境通过 PiPy 安装了支持 TDgpt 运行所必须的 Python 依赖库。
该虚拟环境不会被卸载脚本 `rmtaosanode` 删除,当您确认不再需要该虚拟环境的时候,需要手动删除该虚拟环境。
后续如果您需要开发自己的算法模型,并能够 TDgpt 正确调用,需要将新的依赖库通过虚拟环境的 Pip 正确地安装。
## 卸载
### 卸载
卸载 TDgpt执行 `rmtaosanode` 即可。 安装过程中自动安装的虚拟环境不会被自动删除,用户确认不再需要的时候,需要手动删除该虚拟环境。

View File

@ -0,0 +1,14 @@
---
sidebar_label: 添加算法模型
title: 添加算法模型
---
本章主要介绍如何向 TDgpt 添加自定义的预测分析和异常检测算法模型。
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

View File

@ -1,9 +1,9 @@
---
title: "部署时序基础模型"
sidebar_label: "部署时序基础模型"
title: "部署 Time-MoE 模型"
sidebar_label: "部署 Time-MoE 模型"
---
# 准备环境运行环境
# 准备环境
为了使用时间序列基础模型,需要在本地部署环境支持其运行。首先需要准备 Python 环境。使用 PiPy 安装必要的依赖包:
@ -16,6 +16,8 @@ pip install accelerate
# 设置服务端口和 URL 地址
TDgpt 安装根目录下的 `./lib/taosanalytics/time-moe.py` 文件负责 Time-MoE 模型的部署和服务,修改该问题设置合适的服务 URL 和服务端口即可。
```Python
@app.route('/ds_predict', methods=['POST'])
def time_moe():

View File

@ -0,0 +1,40 @@
---
title: "添加模型服务"
sidebar_label: "添加模型服务"
---
TDgpt 默认已经内置了 Time-MoE 模型的支持功能, 执行 `show anodes full`,可以看到 Time-MoE 的预测服务 `timemoe-fc`,现在只适配了预测服务,所以其后增加了后缀名 fc。
```shell
taos> show anodes full;
id | type | algo |
============================================================================
1 | anomaly-detection | grubbs |
1 | anomaly-detection | lof |
1 | anomaly-detection | shesd |
1 | anomaly-detection | ksigma |
1 | anomaly-detection | iqr |
1 | anomaly-detection | sample_ad_model |
1 | forecast | arima |
1 | forecast | holtwinters |
1 | forecast | tdtsfm_1 |
1 | forecast | timemoe-fc |
```
正确调用 Time-MoE 模型的时间序列数据预测能力,需要您在本地或云端已经部署完成 Time-MoE 服务(需要执行 `./taosanode/lib/taosanalytics/time-moe.py` 的脚本部署 Time-MoE
服务。具体过程请参见 [部署 Time-MoE 服务](./02-deploy-timemoe))。
修改 `/etc/taos/taosanode.ini` 配置文件中如下部分:
```ini
[tsfm-service]
timemoe-fc = http://192.168.2.90:5001/ds_predict
```
设置正确的 IP 和端口,以及服务地址。
然后重启 taosnode 服务,并更新服务端算法缓存列表 `update all anodes`,之后即可通过 SQL 语句调用 Time-MoE 的时间序列数据预测服务。
```sql
SELECT FORECAST(i32, 'algo=timemoe-fc')
FROM foo;
```

View File

@ -0,0 +1,14 @@
---
sidebar_label: 添加时序基础模型
title: 添加时序基础模型
---
本章主要介绍如何通过 TDgpt 使用开源时序基础模型包括Time-MoE 等的时序功能。
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```