Skip to content

Commit

Permalink
Reorganize README
Browse files Browse the repository at this point in the history
  • Loading branch information
willingc committed Sep 22, 2016
1 parent 3e7a7ca commit a1eb062
Showing 1 changed file with 60 additions and 33 deletions.
93 changes: 60 additions & 33 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. -*- mode: rst -*-
scikit-learn
============

Website: http://scikit-learn.org

|Travis|_ |AppVeyor|_ |Coveralls|_ |CircleCI|_ |Python27|_ |Python35|_ |PyPi|_ |DOI|_

Expand All @@ -23,14 +27,9 @@
.. |PyPi| image:: https://badge.fury.io/py/scikit-learn.svg
.. _PyPi: https://badge.fury.io/py/scikit-learn


.. |DOI| image:: https://zenodo.org/badge/21369/scikit-learn/scikit-learn.svg
.. _DOI: https://zenodo.org/badge/latestdoi/21369/scikit-learn/scikit-learn


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

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

Expand All @@ -40,22 +39,12 @@ the `AUTHORS.rst <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``
Installation
------------

Dependencies
============
~~~~~~~~~~~~

scikit-learn is tested to work under Python 2.6, Python 2.7, and Python 3.5.
(using the same codebase thanks to an embedded copy of
Expand All @@ -79,8 +68,10 @@ CBLAS exists in many implementations; see `Linear algebra libraries
for known issues.


Install
=======
User installation
~~~~~~~~~~~~~~~~~

**conda? pip?**

This package uses distutils, which is the default way of installing
python modules. To install in your home directory, use::
Expand All @@ -95,33 +86,42 @@ To install for all users on Unix/Linux::
For more detailed installation instructions,
see the web page http://scikit-learn.org/stable/install.html

Documentation
-------------

- HTML documentation (stable release): http://scikit-learn.org
- HTML documentation (development version): http://scikit-learn.org/dev/


Development
===========
-----------

Important links
~~~~~~~~~~~~~~~

Code
----
- Official source code repo: https://github.com/scikit-learn/scikit-learn
- Download releases: http://sourceforge.net/projects/scikit-learn/files/
- Issue tracker: https://github.com/scikit-learn/scikit-learn/issues

GIT
~~~
Source code
~~~~~~~~~~~

You can check the latest sources with the command::

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

or if you have write privileges::

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

Setting up a development environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Quick tutorial on how to go about setting up your environment to
contribute to scikit-learn: https://github.com/scikit-learn/scikit-learn/blob/master/CONTRIBUTING.md

Before opening a Pull Request, have a look at the
full Contributing page to make sure your code complies
with our guidelines: http://scikit-learn.org/stable/developers/index.html


Testing
-------
~~~~~~~

After installation, you can launch the test suite from outside the
source directory (you will need to have the ``nose`` package installed)::
Expand All @@ -139,3 +139,30 @@ for more information.

Random number generation can be controlled during testing by setting
the ``SKLEARN_SEED`` environment variable.

Submitting a Pull Request
~~~~~~~~~~~~~~~~~~~~~~~~~

Before opening a Pull Request, have a look at the
full Contributing page to make sure your code complies
with our guidelines: http://scikit-learn.org/stable/developers/index.html

Project history
---------------

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.

The project is currently maintained by a team of volunteers.

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



Communication
-------------

- Mailing list: https://lists.sourceforge.net/lists/listinfo/scikit-learn-general
- IRC channel: ``#scikit-learn`` at ``irc.freenode.net``

0 comments on commit a1eb062

Please sign in to comment.