Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
Signed-off-by: nemirorox <[email protected]>
  • Loading branch information
nemirorox committed Feb 9, 2021
1 parent e55ce98 commit ffe37ef
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
10 changes: 9 additions & 1 deletion examples/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ modeling jobs. For more information, please refer this guide on
Upgraded DSL(DSL v2) by FATE-v1.5 comes with the following major features:

1. Predictions DSL may now be configured through FATE-Flow cli. Please note
that new DSL no longer supports automatic formation of prediction DSL;
that with new DSL training job will no longer automatically form prediction DSL;
user needs to first form DSL manually with FATE-Flow cli before running
prediction task.
2. New components may now be added to prediction DSL;
Expand All @@ -100,6 +100,14 @@ For DSL v2 examples, please refer `dsl/v2 <./dsl/v2>`__. For examples of
the older version, please refer `dsl/v1 <./dsl/v1>`__. This is the "federatedml-1.x-examples" in older version. Please note that
starting at version 1.6, FATE may no longer support DSL v1.

Cross Validation Task
~~~~~~~~~~~~~~~~~~~~~~~

Starting at version 1.6, cross validation tasks can output fold history data when ``output_fold_history`` is set to True.
Output data contains either prediction ``score`` or original ``instance`` value. Please note that the ``score`` output from cross validation
tasks may not be input to Evaluation module. All testsuites of modeling modules include demos
on setting `cv parameters <../python/federatedml/param/cross_validation_param.py>`_.


Benchmark Quality
-----------------
Expand Down
9 changes: 9 additions & 0 deletions examples/README_zh.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,15 @@ DSL是FATE提供的第一代配置和构建联邦建模任务的方式,具体
`dsl/v1 <./dsl/v1>`__\ ,此文件夹是在过去版本中对应的"federatedml-1.x-examples"文件夹。
需要注意的是,在FATE-v1.6或者以后的版本里面,旧版本的DSL将会被逐步移除。


交叉验证任务
~~~~~~~~~~~

1.6及以后的版本的交叉验证任务可选输出支持训练/验证过程数据。如需要输出过程数据,请配置CV参数``output_fold_history``;
输出数据内容可从以下两种选择:1. 训练/预测结果 2. 数据特证。需注意输出的训练/预测结果不可输入下游评估组件Evaluation.
目前所有建模模型组件的样例集均包括使用`CV参数 <../python/federatedml/param/cross_validation_param.py>`_ 的样例。


Benchmark Quality
-----------------

Expand Down

0 comments on commit ffe37ef

Please sign in to comment.