Skip to content

Commit fd9d30b

Browse files
committed
add Chinese Doc for colunm_expand and correlation
1 parent 8767db5 commit fd9d30b

File tree

2 files changed

+70
-0
lines changed

2 files changed

+70
-0
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# 列增加
2+
3+
列增加模块用作基于用户提供的数值创建任意数量的变量列。该模块运行时新增的数据列被添加到原始数据上,而非添加到由FATE读取原始数据产生的数据变换上。
4+
5+
6+
<!-- mkdocs
7+
## Param
8+
9+
::: federatedml.param.column_expand_param
10+
rendering:
11+
heading_level: 3
12+
show_source: true
13+
show_root_heading: true
14+
show_root_toc_entry: false
15+
show_root_full_path: false
16+
-->
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# 纵向皮尔逊相关系数
2+
3+
## 模块介绍
4+
5+
纵向皮尔逊相关系数模块用于计算特征列的皮尔逊相关系数。皮尔逊相关系数是两个变量$X$和$Y$的线性相关性的度量,定义如下:
6+
7+
$$\rho_{X,Y} = \frac{cov(X, Y)}{\sigma_X\sigma_Y} = \frac{E[(X-\mu_X)(Y-\mu_Y)]}{\sigma_X\sigma_Y} = E\left[\left(\frac{X-\mu_X}{\sigma_X}\cdot\frac{Y-\mu_Y}{\sigma_Y}\right)\right]$$
8+
9+
令:
10+
11+
$$\tilde{X} = \frac{X-\mu_X}{\sigma_X}, \tilde{Y}=\frac{Y-\mu_Y}{\sigma_Y}$$
12+
13+
则有:
14+
15+
$$\rho_{X, Y} = E[\tilde{X}\tilde{Y}]$$
16+
17+
## 实现细节
18+
19+
我们使用了名为SPDZ的多方安全计算协议实现纵向皮尔逊相关系数模块。要了解更多细节,请参考: [[here](secureprotol.md)]
20+
21+
<!-- mkdocs
22+
## Param
23+
24+
::: federatedml.param.pearson_param
25+
rendering:
26+
heading_level: 3
27+
show_source: true
28+
show_root_heading: true
29+
show_root_toc_entry: false
30+
show_root_full_path: false
31+
-->
32+
33+
## 如何使用
34+
35+
部分参数
36+
37+
38+
- 列索引
39+
- 该参数取值为-1,或者一个int型数值列表。如取值为-1,所有变量列都将参与皮尔逊相关系数的计算;如取值为一个int型数值列表,则索引编号与列表中数值对应的列参与计算。
40+
41+
- 列名称
42+
- 该参数取值为一个字符串型列表。列名出现在列表中的列将参与皮尔逊相关系数的计算。
43+
44+
45+
46+
!!! 提示
47+
48+
如果同时设置了上述两个参数,则两参数限定参与计算的列的合集,将作为最终参与皮尔逊相关系数计算的列。
49+
50+
<!-- mkdocs
51+
## Examples
52+
53+
{% include-examples "hetero_pearson" %}
54+
-->

0 commit comments

Comments
 (0)