diff --git a/doc/datasets/index.rst b/doc/datasets/index.rst index 88b1a4b517b36f213f05e2f273a79da83904070b..91ca82f67214378221ca0dc70039d4387bcf24d6 100644 --- a/doc/datasets/index.rst +++ b/doc/datasets/index.rst @@ -27,8 +27,8 @@ used by the machine learning community to benchmark algorithm on data that comes from the 'real world'. -Datasets shipped with the scikit learn -======================================== +Datasets shipped with scikit-learn and samples generators +========================================================= scikit-learn comes with a few small standard datasets that do not require to download any file from some external website. @@ -44,9 +44,30 @@ require to download any file from some external website. load_linnerud These datasets are useful to quickly illustrate the behavior of the -various algorithms implemented in the scikit. They are however often to +various algorithms implemented in the scikit. They are however often too small to be representative of real world machine learning tasks. +In addition, scikit-learn includes various random samples generators that +can be used to build artifical datasets of controled size and complexity. + +.. autosummary:: + + :toctree: generated/ + :template: function.rst + + make_classification + make_regression + make_blobs + make_friedman1 + make_friedman2 + make_friedman3 + make_low_rank_matrix + make_sparse_coded_signal + make_sparse_uncorrelated + make_spd_matrix + make_swiss_roll + make_s_curve + Datasets in svmlight / libsvm format ==================================== diff --git a/doc/modules/classes.rst b/doc/modules/classes.rst index e2bd86bb9c7e07ce58e738ae3a869679c663b343..8af8aba094d1ebfe7fdd51c55d15c39c309efa74 100644 --- a/doc/modules/classes.rst +++ b/doc/modules/classes.rst @@ -592,7 +592,7 @@ Loaders Samples generator ----------------- -.. automodule:: scikits.learn.datasets.samples_generator +.. automodule:: scikits.learn.datasets :no-members: :no-inherited-members: