update doc

Signed-off-by: nemirorox <[email protected]>
jnmaomao · Feb 23, 2021 · c525c4c · c525c4c
1 parent b69f8a0
commit c525c4c
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/examples/README.rst b/examples/README.rst
@@ -124,7 +124,8 @@ following common models:
 * homogeneous scenario: LogisticRegression(`benchmark_quality/homo_lr <./benchmark_quality/homo_lr>`__),
   SecureBoost(`benchmark_quality/homo_sbt <./benchmark_quality/homo_sbt>`__), NN(`benchmark_quality/homo_nn <./benchmark_quality/homo_nn>`__.
 
-To run the comparison, please refer to the guide on `benchmark_quality <../python/fate_test/README.rst>`__.
+Starting at v1.6, benchmark quality supports matching metrics from the same script. For more details, please refer
+to the `guide <../python/fate_test/README.rst>`__.
 
 Upload Default Data
 -------------------
@@ -134,6 +135,7 @@ along with a utility script for uploading all data sets. User may use the provid
 script to upload all pre-given data, or modify the corresponding configuration file for uploading
 arbitrary data. Please refer `scripts <./scripts/README.rst>`__ for details.
 
+Alternatively, user may use `FATE-Test <../python/fate_test/README.rst#data>`__ for uploading data.
 
 Toy Example
 -----------

diff --git a/python/fate_client/pipeline/param/intersect_param.py b/python/fate_client/pipeline/param/intersect_param.py
@@ -75,7 +75,7 @@ class RSAParam(BaseParam):
 
     split_calculation: bool, if True, Host & Guest split operations for faster performance, recommended on large data set
 
-    random_base_fraction: positive float, if not None, generate specified number of r for encryption and reuse generated r;
+    random_base_fraction: positive float, if not None, generate (fraction * public key id count) of r for encryption and reuse generated r;
         note that value greater than 0.99 will be taken as 1, and value less than 0.01 will be rounded up to 0.01
     """
 

diff --git a/python/federatedml/param/intersect_param.py b/python/federatedml/param/intersect_param.py
@@ -78,7 +78,7 @@ class RSAParam(BaseParam):
 
     split_calculation: bool, if True, Host & Guest split operations for faster performance, recommended on large data set
 
-    random_base_fraction: positive float, if not None, generate specified number of r for encryption and reuse generated r;
+    random_base_fraction: positive float, if not None, generate (fraction * public key id count) of r for encryption and reuse generated r;
         note that value greater than 0.99 will be taken as 1, and value less than 0.01 will be rounded up to 0.01
     """