From e6ff76b955233ab684c6fbb2c8f562b60331caa8 Mon Sep 17 00:00:00 2001 From: Haojun Liao Date: Mon, 11 Nov 2024 17:00:02 +0800 Subject: [PATCH 1/7] doc: refactor docs. --- .../{06-data-analysis => 06-TDgpt}/02-management.md | 0 .../03-preprocess.md} | 0 .../04-anomaly-detection/02-anomaly-detection.md | 0 .../04-anomaly-detection/intro.md} | 1 + .../05-forecast/02-arima.md | 0 .../05-forecast/03-holtwinters.md | 0 .../01-intro.md => 06-TDgpt/05-forecast/intro.md} | 0 .../{06-data-analysis => 06-TDgpt}/06-addins.md | 0 .../01-index.md => 06-TDgpt/index.md} | 2 +- .../{06-data-analysis => 06-TDgpt}/pic/activity.png | Bin .../pic/anomaly-detection.png | Bin .../pic/data-analysis.png | Bin 12 files changed, 2 insertions(+), 1 deletion(-) rename docs/zh/06-advanced/{06-data-analysis => 06-TDgpt}/02-management.md (100%) rename docs/zh/06-advanced/{06-data-analysis/03-analysis-preprocess.md => 06-TDgpt/03-preprocess.md} (100%) rename docs/zh/06-advanced/{06-data-analysis => 06-TDgpt}/04-anomaly-detection/02-anomaly-detection.md (100%) rename docs/zh/06-advanced/{06-data-analysis/04-anomaly-detection/01-intro.md => 06-TDgpt/04-anomaly-detection/intro.md} (97%) rename docs/zh/06-advanced/{06-data-analysis => 06-TDgpt}/05-forecast/02-arima.md (100%) rename docs/zh/06-advanced/{06-data-analysis => 06-TDgpt}/05-forecast/03-holtwinters.md (100%) rename docs/zh/06-advanced/{06-data-analysis/05-forecast/01-intro.md => 06-TDgpt/05-forecast/intro.md} (100%) rename docs/zh/06-advanced/{06-data-analysis => 06-TDgpt}/06-addins.md (100%) rename docs/zh/06-advanced/{06-data-analysis/01-index.md => 06-TDgpt/index.md} (96%) rename docs/zh/06-advanced/{06-data-analysis => 06-TDgpt}/pic/activity.png (100%) rename docs/zh/06-advanced/{06-data-analysis => 06-TDgpt}/pic/anomaly-detection.png (100%) rename docs/zh/06-advanced/{06-data-analysis => 06-TDgpt}/pic/data-analysis.png (100%) diff --git a/docs/zh/06-advanced/06-data-analysis/02-management.md b/docs/zh/06-advanced/06-TDgpt/02-management.md similarity index 100% rename from docs/zh/06-advanced/06-data-analysis/02-management.md rename to docs/zh/06-advanced/06-TDgpt/02-management.md diff --git a/docs/zh/06-advanced/06-data-analysis/03-analysis-preprocess.md b/docs/zh/06-advanced/06-TDgpt/03-preprocess.md similarity index 100% rename from docs/zh/06-advanced/06-data-analysis/03-analysis-preprocess.md rename to docs/zh/06-advanced/06-TDgpt/03-preprocess.md diff --git a/docs/zh/06-advanced/06-data-analysis/04-anomaly-detection/02-anomaly-detection.md b/docs/zh/06-advanced/06-TDgpt/04-anomaly-detection/02-anomaly-detection.md similarity index 100% rename from docs/zh/06-advanced/06-data-analysis/04-anomaly-detection/02-anomaly-detection.md rename to docs/zh/06-advanced/06-TDgpt/04-anomaly-detection/02-anomaly-detection.md diff --git a/docs/zh/06-advanced/06-data-analysis/04-anomaly-detection/01-intro.md b/docs/zh/06-advanced/06-TDgpt/04-anomaly-detection/intro.md similarity index 97% rename from docs/zh/06-advanced/06-data-analysis/04-anomaly-detection/01-intro.md rename to docs/zh/06-advanced/06-TDgpt/04-anomaly-detection/intro.md index 5f4934f588..24ba835b96 100644 --- a/docs/zh/06-advanced/06-data-analysis/04-anomaly-detection/01-intro.md +++ b/docs/zh/06-advanced/06-TDgpt/04-anomaly-detection/intro.md @@ -3,6 +3,7 @@ 异常检测生成的异常窗口受检测算法和算法参数的共同影响，对于异常窗口范围内的数据，可以应用 TDengine 提供的聚合和标量函数进行查询或变换处理。 对于输入时间序列 (1, 20), (2, 22), (3, 91), (4, 120), (5, 18), (6, 19)。系统检测到 (3, 91), (4, 120) 为异常点，那么返回的异常窗口是闭区间 [3, 4]。 +异常检测 ##### 语法 diff --git a/docs/zh/06-advanced/06-data-analysis/05-forecast/02-arima.md b/docs/zh/06-advanced/06-TDgpt/05-forecast/02-arima.md similarity index 100% rename from docs/zh/06-advanced/06-data-analysis/05-forecast/02-arima.md rename to docs/zh/06-advanced/06-TDgpt/05-forecast/02-arima.md diff --git a/docs/zh/06-advanced/06-data-analysis/05-forecast/03-holtwinters.md b/docs/zh/06-advanced/06-TDgpt/05-forecast/03-holtwinters.md similarity index 100% rename from docs/zh/06-advanced/06-data-analysis/05-forecast/03-holtwinters.md rename to docs/zh/06-advanced/06-TDgpt/05-forecast/03-holtwinters.md diff --git a/docs/zh/06-advanced/06-data-analysis/05-forecast/01-intro.md b/docs/zh/06-advanced/06-TDgpt/05-forecast/intro.md similarity index 100% rename from docs/zh/06-advanced/06-data-analysis/05-forecast/01-intro.md rename to docs/zh/06-advanced/06-TDgpt/05-forecast/intro.md diff --git a/docs/zh/06-advanced/06-data-analysis/06-addins.md b/docs/zh/06-advanced/06-TDgpt/06-addins.md similarity index 100% rename from docs/zh/06-advanced/06-data-analysis/06-addins.md rename to docs/zh/06-advanced/06-TDgpt/06-addins.md diff --git a/docs/zh/06-advanced/06-data-analysis/01-index.md b/docs/zh/06-advanced/06-TDgpt/index.md similarity index 96% rename from docs/zh/06-advanced/06-data-analysis/01-index.md rename to docs/zh/06-advanced/06-TDgpt/index.md index 0b729005bb..495f84a7a3 100644 --- a/docs/zh/06-advanced/06-data-analysis/01-index.md +++ b/docs/zh/06-advanced/06-TDgpt/index.md @@ -17,5 +17,5 @@ TDgpt 运行在部署于 TDengine 集群中的 Analysis Node (ANode)中。每个 TDgpt 提供的高级数据分析功能分为时序数据异常检测和时序数据预测两大类。 时序数据异常检测的结果采用异常窗口的形式提供，即分析系统自动将连续的异常数据以时间窗口的形式返回，其使用方式与 TDengine 中其他类型的时间窗口类似。特别地，可以将异常时序数据窗口视作为一种特殊的**事件窗口（Event Window）**，因此事件窗口可应用的查询操作均可应用在异常窗口上。如下图所示，分析平台将返回时序数据异常窗口 [10:51:30, 10:54:40] （红色背景部分数据）。 -异常检测 + diff --git a/docs/zh/06-advanced/06-data-analysis/pic/activity.png b/docs/zh/06-advanced/06-TDgpt/pic/activity.png similarity index 100% rename from docs/zh/06-advanced/06-data-analysis/pic/activity.png rename to docs/zh/06-advanced/06-TDgpt/pic/activity.png diff --git a/docs/zh/06-advanced/06-data-analysis/pic/anomaly-detection.png b/docs/zh/06-advanced/06-TDgpt/pic/anomaly-detection.png similarity index 100% rename from docs/zh/06-advanced/06-data-analysis/pic/anomaly-detection.png rename to docs/zh/06-advanced/06-TDgpt/pic/anomaly-detection.png diff --git a/docs/zh/06-advanced/06-data-analysis/pic/data-analysis.png b/docs/zh/06-advanced/06-TDgpt/pic/data-analysis.png similarity index 100% rename from docs/zh/06-advanced/06-data-analysis/pic/data-analysis.png rename to docs/zh/06-advanced/06-TDgpt/pic/data-analysis.png From 9392f8d03ed0cc5986b76914d54cab4a824add88 Mon Sep 17 00:00:00 2001 From: Haojun Liao Date: Mon, 11 Nov 2024 17:05:24 +0800 Subject: [PATCH 2/7] Update intro.md --- docs/zh/06-advanced/06-TDgpt/04-anomaly-detection/intro.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/zh/06-advanced/06-TDgpt/04-anomaly-detection/intro.md b/docs/zh/06-advanced/06-TDgpt/04-anomaly-detection/intro.md index 24ba835b96..a9855ad143 100644 --- a/docs/zh/06-advanced/06-TDgpt/04-anomaly-detection/intro.md +++ b/docs/zh/06-advanced/06-TDgpt/04-anomaly-detection/intro.md @@ -1,3 +1,8 @@ +--- +title: 异常检测算法 +description: 异常检测算法 +--- + #### 时序数据异常检测 异常检测是针对输入的时序数据，使用预设或用户指定的算法确定时间序列中**可能**出现异常的时间序列点，对于时间序列中若干个连续的异常点，将自动合并成为一个连续的（闭区间）异常窗口。对于只有单个点的场景，异常窗口窗口退化成为一个起始时间和结束时间相同的点。 异常检测生成的异常窗口受检测算法和算法参数的共同影响，对于异常窗口范围内的数据，可以应用 TDengine 提供的聚合和标量函数进行查询或变换处理。 @@ -61,4 +66,4 @@ Query OK, 1 row(s) in set (0.028946s) - grubbs - lof - shesd -- tac \ No newline at end of file +- tac From 807bd3501d398e3ada07fc5801793347b78e62fb Mon Sep 17 00:00:00 2001 From: Haojun Liao Date: Mon, 11 Nov 2024 17:05:59 +0800 Subject: [PATCH 3/7] Update intro.md --- docs/zh/06-advanced/06-TDgpt/05-forecast/intro.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/zh/06-advanced/06-TDgpt/05-forecast/intro.md b/docs/zh/06-advanced/06-TDgpt/05-forecast/intro.md index 3ddcd59a3b..d8fd4d83f6 100644 --- a/docs/zh/06-advanced/06-TDgpt/05-forecast/intro.md +++ b/docs/zh/06-advanced/06-TDgpt/05-forecast/intro.md @@ -1,3 +1,7 @@ +--- +title: 预测算法 +description: 预测算法 +--- #### 时序数据预测 数据预测以一段训练数据作为输入，预测接下来一个连续时间区间内，时序数据的趋势。 From 08ec092ad3b8c314d4d422d3ecb97730c22ed5e3 Mon Sep 17 00:00:00 2001 From: Haojun Liao Date: Mon, 11 Nov 2024 17:07:21 +0800 Subject: [PATCH 4/7] doc: refactor docs. --- .../06-advanced/06-TDgpt/{05-forecast => 04-forecast}/02-arima.md | 0 .../06-TDgpt/{05-forecast => 04-forecast}/03-holtwinters.md | 0 .../zh/06-advanced/06-TDgpt/{05-forecast => 04-forecast}/intro.md | 0 .../02-anomaly-detection.md | 0 .../{04-anomaly-detection => 05-anomaly-detection}/intro.md | 0 5 files changed, 0 insertions(+), 0 deletions(-) rename docs/zh/06-advanced/06-TDgpt/{05-forecast => 04-forecast}/02-arima.md (100%) rename docs/zh/06-advanced/06-TDgpt/{05-forecast => 04-forecast}/03-holtwinters.md (100%) rename docs/zh/06-advanced/06-TDgpt/{05-forecast => 04-forecast}/intro.md (100%) rename docs/zh/06-advanced/06-TDgpt/{04-anomaly-detection => 05-anomaly-detection}/02-anomaly-detection.md (100%) rename docs/zh/06-advanced/06-TDgpt/{04-anomaly-detection => 05-anomaly-detection}/intro.md (100%) diff --git a/docs/zh/06-advanced/06-TDgpt/05-forecast/02-arima.md b/docs/zh/06-advanced/06-TDgpt/04-forecast/02-arima.md similarity index 100% rename from docs/zh/06-advanced/06-TDgpt/05-forecast/02-arima.md rename to docs/zh/06-advanced/06-TDgpt/04-forecast/02-arima.md diff --git a/docs/zh/06-advanced/06-TDgpt/05-forecast/03-holtwinters.md b/docs/zh/06-advanced/06-TDgpt/04-forecast/03-holtwinters.md similarity index 100% rename from docs/zh/06-advanced/06-TDgpt/05-forecast/03-holtwinters.md rename to docs/zh/06-advanced/06-TDgpt/04-forecast/03-holtwinters.md diff --git a/docs/zh/06-advanced/06-TDgpt/05-forecast/intro.md b/docs/zh/06-advanced/06-TDgpt/04-forecast/intro.md similarity index 100% rename from docs/zh/06-advanced/06-TDgpt/05-forecast/intro.md rename to docs/zh/06-advanced/06-TDgpt/04-forecast/intro.md diff --git a/docs/zh/06-advanced/06-TDgpt/04-anomaly-detection/02-anomaly-detection.md b/docs/zh/06-advanced/06-TDgpt/05-anomaly-detection/02-anomaly-detection.md similarity index 100% rename from docs/zh/06-advanced/06-TDgpt/04-anomaly-detection/02-anomaly-detection.md rename to docs/zh/06-advanced/06-TDgpt/05-anomaly-detection/02-anomaly-detection.md diff --git a/docs/zh/06-advanced/06-TDgpt/04-anomaly-detection/intro.md b/docs/zh/06-advanced/06-TDgpt/05-anomaly-detection/intro.md similarity index 100% rename from docs/zh/06-advanced/06-TDgpt/04-anomaly-detection/intro.md rename to docs/zh/06-advanced/06-TDgpt/05-anomaly-detection/intro.md From e993801362f530fa615f1ac54e116cd224f5b828 Mon Sep 17 00:00:00 2001 From: Haojun Liao Date: Mon, 11 Nov 2024 17:16:52 +0800 Subject: [PATCH 5/7] doc: refactor docs. --- docs/zh/06-advanced/06-TDgpt/03-preprocess.md | 1 + docs/zh/06-advanced/06-TDgpt/05-anomaly-detection/intro.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/zh/06-advanced/06-TDgpt/03-preprocess.md b/docs/zh/06-advanced/06-TDgpt/03-preprocess.md index 60ca4eb6c1..62646f6ce0 100644 --- a/docs/zh/06-advanced/06-TDgpt/03-preprocess.md +++ b/docs/zh/06-advanced/06-TDgpt/03-preprocess.md @@ -6,6 +6,7 @@ sidebar_label: "数据分析预处理" ## 时序数据分析功能 在针对时序数据进行高级分析之前，首先进行数据的白噪声检查（White Noise Data check, WND）。白噪声时序数据可以简单地认为是随机数构成的时序数据序列，这种类型的序列没有分析的价值，因此会直接返回空的结果。整体的流程如下图所示。 + 流程图 ### 白噪声检查 diff --git a/docs/zh/06-advanced/06-TDgpt/05-anomaly-detection/intro.md b/docs/zh/06-advanced/06-TDgpt/05-anomaly-detection/intro.md index a9855ad143..b29e9a320e 100644 --- a/docs/zh/06-advanced/06-TDgpt/05-anomaly-detection/intro.md +++ b/docs/zh/06-advanced/06-TDgpt/05-anomaly-detection/intro.md @@ -8,7 +8,7 @@ description: 异常检测算法 异常检测生成的异常窗口受检测算法和算法参数的共同影响，对于异常窗口范围内的数据，可以应用 TDengine 提供的聚合和标量函数进行查询或变换处理。 对于输入时间序列 (1, 20), (2, 22), (3, 91), (4, 120), (5, 18), (6, 19)。系统检测到 (3, 91), (4, 120) 为异常点，那么返回的异常窗口是闭区间 [3, 4]。 -异常检测 +异常检测 ##### 语法 From 7bce12a00f7164c3a24dd177f516f01f80b3ad87 Mon Sep 17 00:00:00 2001 From: Haojun Liao Date: Mon, 11 Nov 2024 17:18:36 +0800 Subject: [PATCH 6/7] Update 02-management.md --- docs/zh/06-advanced/06-TDgpt/02-management.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/zh/06-advanced/06-TDgpt/02-management.md b/docs/zh/06-advanced/06-TDgpt/02-management.md index 3f814f68f0..b507b79890 100644 --- a/docs/zh/06-advanced/06-TDgpt/02-management.md +++ b/docs/zh/06-advanced/06-TDgpt/02-management.md @@ -3,7 +3,6 @@ title: "安装部署" sidebar_label: "安装部署" --- -## 安装部署 ### 环境准备 ANode 要求节点上准备有 Python 3.10 及以上版本，以及相应的 Python 包自动安装组件 Pip，同时请确保能够正常连接互联网。 From 77a1dd6fa0169f727bc1baf8b207af0904e847ae Mon Sep 17 00:00:00 2001 From: Haojun Liao Date: Mon, 11 Nov 2024 17:27:27 +0800 Subject: [PATCH 7/7] Update index.md --- docs/zh/06-advanced/06-TDgpt/index.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/zh/06-advanced/06-TDgpt/index.md b/docs/zh/06-advanced/06-TDgpt/index.md index 495f84a7a3..1f37fb4815 100644 --- a/docs/zh/06-advanced/06-TDgpt/index.md +++ b/docs/zh/06-advanced/06-TDgpt/index.md @@ -12,10 +12,11 @@ TDgpt 运行在部署于 TDengine 集群中的 Analysis Node (ANode)中。每个 TDgpt架构图 -通过注册指令语句，将 ANode 注册到 MNode 中就加入到 TDengine 集群，查询会按需向其请求数据分析服务。请求服务通过 VNode 直接向 ANode 发起，用户则可以通过 SQL 语句直接调用 ANode 提供的服务。 +通过注册指令语句，将 ANode 注册到 MNode 中就加入到 TDengine 集群，查询会**按需**向其请求数据分析服务。ANode 不直接接收用户的数据分析请求。用户可通过SQL语句间接使用 ANode 提供的分析服务。 -TDgpt 提供的高级数据分析功能分为时序数据异常检测和时序数据预测两大类。 +TDgpt 提供的高级数据分析功能分为时序数据异常检测和时序数据预测两类。 时序数据异常检测的结果采用异常窗口的形式提供，即分析系统自动将连续的异常数据以时间窗口的形式返回，其使用方式与 TDengine 中其他类型的时间窗口类似。特别地，可以将异常时序数据窗口视作为一种特殊的**事件窗口（Event Window）**，因此事件窗口可应用的查询操作均可应用在异常窗口上。如下图所示，分析平台将返回时序数据异常窗口 [10:51:30, 10:54:40] （红色背景部分数据）。 +时序数据预测是基于输入的时间序列数据，采用用户给定（或默认算法）输出输入数据之后的时间序列数据的预测值数据，预测产生的时序数据点需要由用户指定。