scikit-learn

History

Alexandre Passos 2eff92e86d Adding example; adding explicit lower bound computation; optionally monitoring convergence; full and tied work, somehow spherical and diag diverge.		2011-04-03 14:37:23 -03:00
..
developers	Neighbors refactoring.	2011-02-17 10:37:34 +01:00
images	Update web page.	2010-10-05 14:32:14 +02:00
logos	Add png logo.	2010-10-06 12:09:06 +02:00
modules	Merge branch 'hcluster2'	2011-04-01 12:27:16 -04:00
sphinxext	Web page update.	2010-12-17 12:28:02 +01:00
templates	Add function template for doc.	2010-10-05 14:33:24 +02:00
themes/scikit-learn	More doc on 0.7 release.	2011-02-28 15:29:13 +01:00
Makefile	MISC: html-nodoc default target	2011-04-01 12:59:03 +02:00
README	Implement make html-noplot for building the doc.	2010-11-17 13:08:20 +01:00
about.rst	Add AUTHORS to web page.	2010-12-17 12:27:46 +01:00
big_toc_css.rst	DOC: Rewamp the tables of contents and corresponding layout	2010-11-01 13:34:40 +01:00
bigger_toc_css.rst	DOC: Rewamp the tables of contents and corresponding layout	2010-11-01 13:34:40 +01:00
conf.py	Start of 0.8 development cycle.	2011-03-02 20:41:05 +01:00
contents.rst	documentation for the LFW dataset loaders	2011-02-25 02:04:37 +01:00
dp-derivation.rst	Adding example; adding explicit lower bound computation; optionally monitoring convergence; full and tied work, somehow spherical and diag diverge.	2011-04-03 14:37:23 -03:00
index.rst	Change the algorithm used in neighbors.barycenter.	2011-02-17 10:23:33 +01:00
install.rst	Update the installation guide with Ubuntu related info	2011-04-01 12:39:23 +02:00
make.bat	Initial import of rst docs.	2010-01-14 15:13:39 +00:00
model_selection.rst	DOC: Rewamp the tables of contents and corresponding layout	2010-11-01 13:34:40 +01:00
performance.rst	Doc: Add stub file.	2010-09-03 15:19:19 +02:00
supervised_learning.rst	DOC: some documentation for naive_bayes module.	2011-03-30 14:46:45 +02:00
support.rst	Documentation update.	2011-03-02 20:39:26 +01:00
tutorial.rst	Fix a Broken link in the documentation	2011-04-01 12:39:47 +02:00
unsupervised_learning.rst	Rename scikits.learn.gmm to scikits.learn.mixture.	2010-11-23 15:15:38 +01:00
user_guide.rst	DOC: remove duplicate information.	2011-01-11 15:45:06 +01:00
whats_new.rst	FIX: mxf --> Xinfan Meng	2011-03-02 14:02:59 +01:00

README

Documentation for scikits.learn
-------------------------------

This section contains the full manual and web page as displayed in
http://scikit-learn.sf.net. To generate the full web page, including
the example gallery (this might take a while):

make html

Or, if you'd rather not build the example gallery:

make html-noplot

That should create all the doc in directory _build/html

To build the pdf manual, you should first make the latex docs:

make latex

and then:

cd _build/latex
make all-pdf

Upload the generated doc to sourceforge
---------------------------------------

First of, generate the html documentation::

make html

This should create a directory _build/html with the documentation in html fornmat.

Now can upload the generated html documentation using scp or some other SFTP clients.

* Project web Hostname: web.sourceforge.net
* Path: htdocs/
* Username: Combine your SourceForge.net Username with your SourceForge.net project UNIX name using a comma ( "," ) See Example
* Password: Your SourceForge.net Password

An example session might look like the following for Username "jsmith" uploading a file for this project, using rsync with the right switch for the permissions:

[jsmith@linux ~]$ rsync -rltvz _build/html/ jsmith,scikit-learn@web.sourceforge.net:htdocs/ -essh
Connecting to web.sourceforge.net...
The authenticity of host 'web.sourceforge.net (216.34.181.57)' can't be established.
RSA key fingerprint is 68:b3:26:02:a0:07:e4:78:d4:ec:7f:2f:6a:4d:32:c5.
Are you sure you want to continue connecting (yes/no)? yes
Warning: Permanently added 'web.sourceforge.net,216.34.181.57' (RSA) to the list of known hosts.
jsmith,fooproject@web.sourceforge.net's password:
sending incremental file list
...