From ae9bc2a002e18b3b0755fd2be32d4c095771bdc1 Mon Sep 17 00:00:00 2001
From: Gilles Louppe <g.louppe@gmail.com>
Date: Sat, 6 Aug 2011 21:41:03 +0200
Subject: [PATCH] Added references to samples_generator.make_* functions in the
documentation.
---
doc/datasets/index.rst | 27 ++++++++++++++++++++++++---
doc/modules/classes.rst | 2 +-
2 files changed, 25 insertions(+), 4 deletions(-)
diff --git a/doc/datasets/index.rst b/doc/datasets/index.rst
index 88b1a4b517..91ca82f672 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 e2bd86bb9c..8af8aba094 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:
--
GitLab