[mlpack-git] master: fix doc tutorial (81079bc)

gitdub at mlpack.org gitdub at mlpack.org
Tue Jun 7 13:27:45 EDT 2016


Repository : https://github.com/mlpack/mlpack
On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/14aca3718be01738fe2e541a48058491a7e59cd6...0e7143ca787241dcc593eef9871d1f9eb65acb70

>---------------------------------------------------------------

commit 81079bc9e142595adeb066df8906b35d3f370455
Author: Keon Kim <kwk236 at gmail.com>
Date:   Wed Jun 8 02:27:45 2016 +0900

    fix doc tutorial


>---------------------------------------------------------------

81079bc9e142595adeb066df8906b35d3f370455
 doc/tutorials/README.md | 48 ++++++++++++++++++++++++++++++++++--------------
 1 file changed, 34 insertions(+), 14 deletions(-)

diff --git a/doc/tutorials/README.md b/doc/tutorials/README.md
index f4114ac..c75f5ab 100644
--- a/doc/tutorials/README.md
+++ b/doc/tutorials/README.md
@@ -1,20 +1,40 @@
 
 ## Tutorials
 
-Tutorials for mlpack can be found [here : mlpack tutorials](http://www.mlpack.org/tutorial.html).
+Tutorials for mlpack can be found [here : mlpack tutorials](http://www.mlpack.org/tutorials.html).
 
-### Method-specific tutorials
-* [NeighborSearch tutorial (mlpack_knn / mlpack_kfn)](http://www.mlpack.org/doxygen.php?doc=nstutorial.html)
-* [RangeSearch tutorial (mlpack_range_search)](http://www.mlpack.org/doxygen.php?doc=rstutorial.html)
-* [LinearRegression tutorial (mlpack_linear_regression)](http://www.mlpack.org/doxygen.php?doc=lrtutorial.html)
-* [Density Estimation Trees tutorial (mlpack_det)](http://www.mlpack.org/doxygen.php?doc=dettutorial.html)
-* [Euclidean Minimum Spanning Trees tutorial (mlpack_emst)](http://www.mlpack.org/doxygen.php?doc=emst_tutorial.html)
-* [K-Means tutorial (mlpack_kmeans)](http://www.mlpack.org/doxygen.php?doc=kmtutorial.html)
-* [FastMKS tutorial (mlpack_fastmks)](http://www.mlpack.org/doxygen.php?doc=fmkstutorial.html)
 
 ### General mlpack tutorials
-* [Building mlpack from source](http://www.mlpack.org/doxygen.php?doc=build.html)
-* [mlpack input and output](http://www.mlpack.org/doxygen.php?doc=iodoc.html)
-* [Matrices in mlpack](http://www.mlpack.org/doxygen.php?doc=matrices.html)
-* [Simple sample mlpack programs](http://www.mlpack.org/doxygen.php?doc=sample.html)
-* [mlpack timers](http://www.mlpack.org/doxygen.php?doc=timer.html)
+
+These tutorials introduce the basic concepts of working with mlpack, aimed at developers who want to use and contribute to mlpack but are not sure where to start.
+
+* [Building mlpack from source](http://www.mlpack.org/docs/mlpack-git/doxygen.php?doc=build.html)
+* [File Formats in mlpack](http://www.mlpack.org/docs/mlpack-git/doxygen.php?doc=formatdoc.html)
+* [Matrices in mlpack](http://www.mlpack.org/docs/mlpack-git/doxygen.php?doc=matrices.html)
+* [mlpack input and output](http://www.mlpack.org/docs/mlpack-git/doxygen.php?doc=iodoc.html)
+* [mlpack timers](http://www.mlpack.org/docs/mlpack-git/doxygen.php?doc=timer.html)
+* [Simple sample mlpack programs](http://www.mlpack.org/docs/mlpack-git/doxygen.php?doc=sample.html)
+
+
+### Method-specific tutorials
+
+These tutorials introduce the various methods mlpack offers, aimed at users who want to get started quickly. These tutorials start with simple examples and progress to complex, extensible uses.
+
+* [NeighborSearch tutorial (mlpack_knn / mlpack_kfn)](http://www.mlpack.org/docs/mlpack-git/doxygen.php?doc=nstutorial.html)
+* [LinearRegression tutorial (mlpack_linear_regression)](http://www.mlpack.org/docs/mlpack-git/doxygen.php?doc=lrtutorial.html)
+* [RangeSearch tutorial (mlpack_range_search)](http://www.mlpack.org/docs/mlpack-git/doxygen.php?doc=rstutorial.html)
+* [Density Estimation Trees tutorial (mlpack_det)](http://www.mlpack.org/docs/mlpack-git/doxygen.php?doc=dettutorial.html)
+* [K-Means tutorial (mlpack_kmeans)](http://www.mlpack.org/docs/mlpack-git/doxygen.php?doc=kmtutorial.html)
+* [FastMKS tutorial (mlpack_fastmks)](http://www.mlpack.org/docs/mlpack-git/doxygen.php?doc=fmkstutorial.html)
+* [Euclidean Minimum Spanning Trees tutorial (mlpack_emst)](http://www.mlpack.org/docs/mlpack-git/doxygen.php?doc=emst_tutorial.html)
+* [Alternating Matrix Factorization Tutorial](http://www.mlpack.org/docs/mlpack-git/doxygen.php?doc=amftutorial.html)
+* [Collaborative Filtering Tutorial](http://www.mlpack.org/docs/mlpack-git/doxygen.php?doc=cftutorial.html)
+
+
+### Policy Class Documentation
+
+mlpack uses templates to achieve its genericity and flexibility. Some of the template types used by mlpack are common across multiple machine learning algorithms. The links below provide documentation for some of these common types.
+
+[The MetricType policy in mlpack](http://www.mlpack.org/docs/mlpack-git/doxygen.php?doc=metrics.html)
+[The KernelType policy in mlpack](http://www.mlpack.org/docs/mlpack-git/doxygen.php?doc=kernels.html)
+[The TreeType policy in mlpack](http://www.mlpack.org/docs/mlpack-git/doxygen.php?doc=trees.html)
\ No newline at end of file




More information about the mlpack-git mailing list