scikit-learn

Go to file

Fabian Pedregosa 8143abbadf Add a complete example of SVM classifier using a precomputed kernel.		2010-05-17 11:25:35 +02:00
doc	Add a complete example of SVM classifier using a precomputed kernel.	2010-05-17 11:25:35 +02:00
examples	Add a complete example of SVM classifier using a precomputed kernel.	2010-05-17 11:25:35 +02:00
scikits	Update docstrings in svm module.	2010-05-17 09:37:52 +02:00
.gitignore	.gitignore: vim power! + generated __config__.py and build	2010-05-04 00:06:40 +02:00
.svnauthors	adding myself to svnauthors	2010-03-24 21:11:48 +00:00
AUTHORS	Welcome Chris.	2010-05-15 13:34:18 +02:00
COPYING	Added COPYING file with the license terms.	2010-01-06 14:23:12 +00:00
README.rst	Add test directory to setup.py and update dependencies on README.	2010-05-06 11:13:01 +02:00
setup.py	Start of 0.4 development cycle.	2010-05-03 09:27:16 +00:00
site.cfg	Add the option to link against system-wide libsvm by editing site.cfg	2010-04-29 09:52:30 +00:00
svn_ignores	MISC: Set svn ignores.	2010-03-23 08:41:08 +00:00

README.rst

.. -*- mode: rst -*-

About
=====

scikits.learn is a python module for machine learning built on top of
scipy.

The project was started in 2007 by David Cournapeu as a Google Summer
of Code project, and since then many volunteers have contributed. See
the AUTHORS file for a complete list of contributors.

It is currently maintained by a team of volunteers.


Download
========

You can download source code and Windows binaries from SourceForge:

http://sourceforge.net/projects/scikit-learn/files/


Dependencies
============

The required dependencies to build the software are python >= 2.5,
NumPy >= 1.1, SciPy and a working C++ compiler.

Optional dependencies are scikits.optimization and the Boost libraries
for module scikits.learn.manifold.

To run the tests you will also need nosetests and python-dap
(http://pypi.python.org/pypi/dap/).


Install
=======

This packages uses distutils, which is the default way of installing
python modules. The install command is::

  python setup.py install


Mailing list
============

There's a general and development mailing list, visit
https://lists.sourceforge.net/lists/listinfo/scikit-learn-general to
subscribe to the mailing list.


Development
===========

Code
----

GIT
~~~

You can check out the current repository with the command::

    git clone git://scikit-learn.git.sourceforge.net/gitroot/scikit-learn/scikit-learn 

Developers with write privileges should instead use the command::

    git clone ssh://USERNAME@scikit-learn.git.sourceforge.net/gitroot/scikit-learn/scikit-learn

where USERNAME is your sourceforge username.

Bugs
----

Please submit bugs you might encounter, as well as patches and feature
requests to the tracker located at the address
https://sourceforge.net/apps/trac/scikit-learn/report


Testing
-------

To execute the test suite, run from the project's top directory (you
will need to have nosetest installed)::

    python setup.py test