Skip to content

Commit

Permalink
update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
xuyang1706 committed Apr 10, 2023
1 parent 8f68dc4 commit 8e8906c
Show file tree
Hide file tree
Showing 13 changed files with 257 additions and 324 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,7 @@ iForest 可以识别数据中异常点,在异常检测领域有比较好的效

## 参数说明

| 名称 | 中文名称 | 描述 | 类型 | 是否必须? | 取值范围 | 默认值 |
| --- | --- | --- | --- | --- | --- | --- |
| inputMTableCol | 输入列名 | 输入序列的列名 | String || | |
| outputMTableCol | 输出列名 | 输出序列的列名 | String || | |
| predictionCol | 预测结果列名 | 预测结果列名 | String || | |
| featureCols | 特征列名数组 | 特征列名数组,默认全选 | String[] | | 所选列类型为 [BIGDECIMAL, BIGINTEGER, BYTE, DOUBLE, FLOAT, INTEGER, LONG, SHORT] | null |
| maxOutlierNumPerGroup | 每组最大异常点数目 | 每组最大异常点数目 | Integer | | | |
| maxOutlierRatio | 最大异常点比例 | 算法检测异常点的最大比例 | Double | | | |
| numTrees | 模型中树的棵数 | 模型中树的棵数 | Integer | | | 100 |
| outlierThreshold | 异常评分阈值 | 只有评分大于该阈值才会被认为是异常点 | Double | | | |
| predictionDetailCol | 预测详细信息列名 | 预测详细信息列名 | String | | | |
| subsamplingSize | 每棵树的样本采样行数 | 每棵树的样本采样行数,默认 256 ,最小 2 ,最大 100000 . | Integer | | [1, 100000] | 256 |
| tensorCol | tensor列 | tensor列 | String | | 所选列类型为 [BOOL_TENSOR, BYTE_TENSOR, DOUBLE_TENSOR, FLOAT_TENSOR, INT_TENSOR, LONG_TENSOR, STRING, STRING_TENSOR, TENSOR, UBYTE_TENSOR] | null |
| vectorCol | 向量列名 | 向量列对应的列名,默认值是null | String | | 所选列类型为 [DENSE_VECTOR, SPARSE_VECTOR, STRING, VECTOR] | null |
| numThreads | 组件多线程线程个数 | 组件多线程线程个数 | Integer | | | 1 |
<!-- PARAMETER TABLE -->

## 代码示例

Expand Down Expand Up @@ -121,4 +107,4 @@ group_id|data|pred
|2|11.0000 |2|11.0000|false
|3|12.0000 |3|12.0000|false
|4|13.0000 |4|13.0000|false
|5|14.0000 |5|14.0000|false
|5|14.0000 |5|14.0000|false
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,7 @@ Python 类名:LookupRedisString

## 参数说明

| 名称 | 中文名称 | 描述 | 类型 | 是否必须? | 取值范围 | 默认值 |
| --- | --- | --- | --- | --- | --- | --- |
| pluginVersion | 插件版本号 | 插件版本号 | String || | |
| selectedCol | 选中的列名 | 计算列对应的列名 | String || | |
| clusterMode | 集群模式 | 是集群模式还是单机模式 | Boolean | | | false |
| databaseIndex | 数据库索引号 | 数据库索引号 | Long | | | |
| outputCol | 输出结果列 | 输出结果列列名,可选,默认null | String | | | null |
| pipelineSize | 流水线大小 | Redis 发送命令流水线的大小 | Integer | | | 1 |
| redisIPs | Redis IP | Redis 集群的 IP/端口 | String[] | | | |
| redisPassword | Redis 密码 | Redis 服务器密码 | String | | | |
| reservedCols | 算法保留列名 | 算法保留列 | String[] | | | null |
| timeout | 超时 | 关闭连接的超时时间 | Integer | | | |
| numThreads | 组件多线程线程个数 | 组件多线程线程个数 | Integer | | | 1 |
<!-- PARAMETER TABLE -->


## 代码示例
Expand Down Expand Up @@ -126,4 +114,4 @@ public class LookupRedisRowTest extends AlinkTestBase {
### 运行结果
| id | col0 | col1 | col2 |
|-------+------+---------+------|
| id001 | 123 | 45.6000 | str |
| id001 | 123 | 45.6000 | str |
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,7 @@ Python 类名:LookupRedisRow

## 参数说明

| 名称 | 中文名称 | 描述 | 类型 | 是否必须? | 取值范围 | 默认值 |
| --- | --- | --- | --- | --- | --- | --- |
| outputSchemaStr | Schema | Schema。格式为"colname coltype[, colname2, coltype2[, ...]]",例如"f0 string, f1 bigint, f2 double" | String || | |
| pluginVersion | 插件版本号 | 插件版本号 | String || | |
| selectedCols | 选择的列名 | 计算列对应的列名列表 | String[] || | |
| clusterMode | 集群模式 | 是集群模式还是单机模式 | Boolean | | | false |
| databaseIndex | 数据库索引号 | 数据库索引号 | Long | | | |
| pipelineSize | 流水线大小 | Redis 发送命令流水线的大小 | Integer | | | 1 |
| redisIPs | Redis IP | Redis 集群的 IP/端口 | String[] | | | |
| redisPassword | Redis 密码 | Redis 服务器密码 | String | | | |
| reservedCols | 算法保留列名 | 算法保留列 | String[] | | | null |
| timeout | 超时 | 关闭连接的超时时间 | Integer | | | |
<!-- PARAMETER TABLE -->


## 代码示例
Expand Down Expand Up @@ -127,4 +116,4 @@ public class LookupRedisRowTest extends AlinkTestBase {
### 运行结果
| id | col0 | col1 | col2 |
|-------+------+---------+------|
| id001 | 123 | 45.6000 | str |
| id001 | 123 | 45.6000 | str |
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,8 @@ Python 类名:LookupRecentDaysModel


## 参数说明
| 名称 | 中文名称 | 描述 | 类型 | 是否必须? | 取值范围 | 默认值 |
| --- | --- | --- | --- | --- | --- | --- |
| selectedCols | 选择的列名 | 计算列对应的列名列表 | String[] || | |
| featureSchemaStr | Schema | Schema。格式为"colname coltype[, colname2, coltype2[, ...]]",例如 "f0 string, f1 bigint, f2 double" | String | | | |
| modelFilePath | 模型的文件路径 | 模型的文件路径 | String | | | null |
| outputCols | 输出结果列列名数组 | 输出结果列列名数组,可选,默认null | String[] | | | null |
| overwriteSink | 是否覆写已有数据 | 是否覆写已有数据 | Boolean | | | false |
| reservedCols | 算法保留列名 | 算法保留列 | String[] | | | null |
| numThreads | 组件多线程线程个数 | 组件多线程线程个数 | Integer | | | 1 |
| modelStreamFilePath | 模型流的文件路径 | 模型流的文件路径 | String | | | null |
| modelStreamScanInterval | 扫描模型路径的时间间隔 | 描模型路径的时间间隔,单位秒 | Integer | | | 10 |
| modelStreamStartTime | 模型流的起始时间 | 模型流的起始时间。默认从当前时刻开始读。使用yyyy-mm-dd hh:mm:ss.fffffffff格式,详见Timestamp.valueOf(String s) | String | | | null |
| modelStreamUpdateMethod | 模型更新方法 | 模型更新方法,可选COMPLETE(全量更新)或者 INCREMENT(增量更新) | String | | "COMPLETE", "INCREMENT" | "COMPLETE" |
<!-- PARAMETER TABLE -->


## 代码示例
见 LookupRecentDays 组件的文档。
见 LookupRecentDays 组件的文档。
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ FLAIRS.
| labelCol | 标签列名 | 输入表中的标签列名 | String || | |
| categoricalCols | 离散特征列名 | 离散特征列名 | String[] | | 所选列类型为 [BIGINTEGER, BOOLEAN, INTEGER, LONG, STRING] | |
| smoothing | 算法参数 | 光滑因子,默认为0.0 | Double | | [0.0, +inf) | 0.0 |
| weightCol | 权重列名 | 权重列对应的列名 | String | | 所选列类型为 [DOUBLE] | null |
| weightCol | 权重列名 | 权重列对应的列名 | String | | 所选列类型为 [BIGDECIMAL, BIGINTEGER, BYTE, DOUBLE, FLOAT, INTEGER, LONG, SHORT] | null |

## 代码示例
### Python 代码
Expand Down
Loading

0 comments on commit 8e8906c

Please sign in to comment.