baohan
/
scikit-learn
mirror of https://github.com/scikit-learn/scikit-learn.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
8,843 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
Andreas Mueller 3b3dc2ecfd MISC use logsumexp in DPGMM for less warnings 2012-05-05 20:56:58 +02:00
benchmarks BENCHMARK covertype: select classifier via cmd line opt 2012-03-27 23:25:21 +02:00
doc COSMIT: macports package name 2012-05-05 18:05:54 +02:00
examples MISC don't use ``set_cmap`` 2012-05-05 20:43:21 +02:00
scikits MISC Update all the other deprecation warnings that I forgot. 2012-03-02 19:46:05 +01:00
sklearn MISC use logsumexp in DPGMM for less warnings 2012-05-05 20:56:58 +02:00
.gitignore FIX: make LFW data shapes consistent with Olivetti faces 2012-02-11 13:58:33 +01:00
.mailmap Mailmap alias 2012-01-10 19:51:53 +01:00
AUTHORS.rst change web site for agramfort 2012-04-20 21:02:37 +02:00
COPYING 2011 -> 2012 2012-01-11 10:33:02 +01:00
MANIFEST.in Update MANIFEST.in: scikit-learn --> sklearn 2011-09-21 12:18:18 +02:00
Makefile replaced silence paramenter in makefile, links removed in stat_learn tutorial, big_toc_css copy deleted, heading changed in tutorial index, tutorial index info added 2012-03-07 17:08:14 +01:00
README-py3k.rst Update status of py3k support. 2010-12-07 15:27:32 +01:00
README.rst Better title in README.rst. 2012-01-18 06:17:14 +09:00
setup.cfg Do not execute test coverage by default. 2010-10-14 16:32:23 +02:00
setup.py COSMIT renaming scikits.learn to sklearn in some places 2012-03-02 13:50:09 +01:00
site.cfg Remove obsolete info. 2011-02-08 09:27:20 +01:00

README.rst 

.. -*- mode: rst -*-

scikit-learn
============

scikit-learn is a Python module for machine learning built on top of
SciPy and distributed under the 3-Clause BSD license.

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.

**Note** `scikit-learn` was previously referred to as `scikits.learn`.


Important links
===============

- Official source code repo: https://github.com/scikit-learn/scikit-learn
- HTML documentation (stable release): http://scikit-learn.org
- HTML documentation (development version): http://scikit-learn.org/dev/
- Download releases: http://sourceforge.net/projects/scikit-learn/files/
- Issue tracker: https://github.com/scikit-learn/scikit-learn/issues
- Mailing list: https://lists.sourceforge.net/lists/listinfo/scikit-learn-general
- IRC channel: ``#scikit-learn`` at ``irc.freenode.net``

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

The required dependencies to build the software are Python >= 2.6,
setuptools, Numpy >= 1.3, SciPy >= 0.7 and a working C/C++ compiler.
This configuration matches the Ubuntu 10.04 LTS release from April 2010.

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


Install
=======

This package uses distutils, which is the default way of installing
python modules. To install in your home directory, use::

  python setup.py install --home

To install for all users on Unix/Linux::

  python setup.py build
  sudo python setup.py install


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


Testing
-------

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

    python -c "import sklearn; sklearn.test()"

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