diff options
author | Hind-M <hind.montassif@gmail.com> | 2021-08-11 14:35:25 +0200 |
---|---|---|
committer | Hind-M <hind.montassif@gmail.com> | 2021-08-11 14:35:25 +0200 |
commit | 575beed582f9288d83a403f4f578731f172f7f5f (patch) | |
tree | 3cd25aba0751dcdd0aec279b71543e39191e336a /src/python/doc | |
parent | b9160fb8410bbb999913b0b4e91f1aa1ff58d2cd (diff) |
Add test for sphere and torus
Fix numerical approximations inconsistencies with dim fraction exponent when generating points as grid on torus
Add notes in doc regarding the torus versions use cases
Diffstat (limited to 'src/python/doc')
-rw-r--r-- | src/python/doc/datasets_generators.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/python/doc/datasets_generators.rst b/src/python/doc/datasets_generators.rst index 2802eccd..e63dde82 100644 --- a/src/python/doc/datasets_generators.rst +++ b/src/python/doc/datasets_generators.rst @@ -60,6 +60,9 @@ Otherwise, if set to **'grid'**, the points are generated on a grid and would be ( [n\_samples^{1 \over {dim}}]^{dim}, 2*dim ) + +**Note:** This version is recommended when the user wishes to use **'grid'** as sample type, or **'random'** with a relatively small number of samples (~ less than 150). + Example """"""" .. code-block:: python @@ -81,6 +84,8 @@ The user should provide the number of points to be generated on the torus :code: The :code:`sample` argument is optional and is set to **'random'** by default. The other allowed value of sample type is **'grid'**. +**Note:** This version is recommended when the user wishes to use **'random'** as sample type with a great number of samples and a low dimension. + Example """"""" .. code-block:: python |