baohan
/
scikit-learn
mirror of https://github.com/scikit-learn/scikit-learn.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
3,098 Commits 31 Branches 142 Tags 892 MiB
Python 92.3%
Cython 5.6%
C++ 1.2%
Shell 0.3%
C 0.3%
Other 0.2%
Go to file
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
benchmarks Merge branch 'hcluster2' 2011-04-01 12:27:16 -04:00
doc 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
examples 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
scikits 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
.gitignore Ignore OSX .DS_Store files. 2011-04-01 09:17:44 +02:00
.mailmap FIX: mxf --> Xinfan Meng 2011-03-02 14:02:59 +01:00
AUTHORS.rst Some more changelog stuff. 2011-03-01 09:21:47 +01:00
COPYING Added COPYING file with the license terms. 2010-01-06 14:23:12 +00:00
MANIFEST.in You want the truth well here it is. 2010-10-11 11:07:56 +02:00
Makefile make the test display the output on stdout 2011-03-19 17:52:07 +01:00
README-py3k.rst Update status of py3k support. 2010-12-07 15:27:32 +01:00
README.rst Update numpy/scipy requirements. 2011-03-09 15:32:42 +01:00
setup.cfg Do not execute test coverage by default. 2010-10-14 16:32:23 +02:00
setup.py Python 3 compat, this time with npy_3kcompat.h 2011-04-01 16:27:04 +02:00
site.cfg Remove obsolete info. 2011-02-08 09:27:20 +01: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 Cournapeau as a Google Summer
of Code project, and since then many volunteers have contributed. See
the AUTHORS.rst 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,
setuptools, NumPy >= 1.2, SciPy >= 0.7 and a working C++ compiler.

To run the tests you will also need nose >= 0.10.


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.


IRC channel
===========

Some developers tend to hang around the channel ``#scikit-learn``
at ``irc.freenode.net``, especially during the week preparing a new
release. If nobody is available to answer your questions there don't
hesitate to ask it on the mailing list to reach a wider audience.


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

Code
----

GIT
~~~

You can check the latest sources with the command::

    git clone git://github.com/scikit-learn/scikit-learn.git

or if you have write privileges::

    git clone git@github.com:scikit-learn/scikit-learn.git

Bugs
----

Please submit bugs you might encounter, as well as patches and feature
requests to the tracker located at github
https://github.com/scikit-learn/scikit-learn/issues


Testing
-------

After installation, you can launch the test suite from outside the
source directory (you will need to have nosetest installed)::

    python -c "import scikits.learn as skl; skl.test()"

See web page http://scikit-learn.sourceforge.net/install.html#testing
for more information.