scikit-learn/doc/support.rst

=======
Support
=======

There are several ways to get in touch with the developers.


.. _mailing_lists:

Mailing List
============

- The main mailing list is `scikit-learn-general
  <https://lists.sourceforge.net/lists/listinfo/scikit-learn-general>`_.

- There is also a commit list `scikit-learn-commits
  <https://lists.sourceforge.net/lists/listinfo/scikit-learn-commits>`_,
  where updates to the main repository and test failures get notified.


.. _user_questions:

User questions
==============

- Some scikit-learn developers support users on StackOverflow using
  the `[scikit-learn] <http://stackoverflow.com/questions/tagged/scikit-learn>`_
  tag.

- For general theoretical or methodological Machine Learning questions
  `metaoptimize.com/qa <http://metaoptimize.com/qa>`_ is probably a more
  suitable venue.

In both cases please use a descriptive question in the title field (e.g.
no "Please help with scikit-learn!" as this is not a question) and put
details on what you tried to achieve, what were the expected results and
what you observed instead in the details field.

Code and data snippets are welcome. Minimalistic (up to ~20 lines long)
reproduction script very helpful.

Please describe the nature of your data and the how you preprocessed it:
what is the number of samples, what is the number and type of features
(i.d. categorical or numerical) and for supervised learning tasks,
what target are your trying to predict: binary, multiclass (1 out of
``n_classes``) or multilabel (``k`` out of ``n_classes``) classification
or continuous variable regression.


.. _bug_tracker:

Bug tracker
===========

If you think you've encountered a bug, please report it to the issue tracker:

https://github.com/scikit-learn/scikit-learn/issues

Don't forget to include:

  - steps (or better script) to reproduce,

  - expected outcome,

  - observed outcome or python (or gdb) tracebacks

To help developers fix your bug faster, please link to a https://gist.github.com
holding a standalone minimalistic python script that reproduces your bug and
optionally a minimalistic subsample of your dataset (for instance exported
as CSV files using ``numpy.savetxt``).

Note: gists are git cloneable repositories and thus you can use git to
push datafiles to them.


.. _irc:

IRC
===

Some developers like to hang out on channel ``#scikit-learn`` on
``irc.freenode.net``.

If you do not have an IRC client or are behind a firewall this web
client works fine: http://webchat.freenode.net


.. _documentation_resources:

Documentation resources
=======================

This documentation is relative to |release|. Documentation for other
versions can be found here:

    * `0.15 <http://scikit-learn.org/0.15/>`_
    * `0.14 <http://scikit-learn.org/0.14/>`_
    * `0.13 <http://scikit-learn.org/0.13/>`_
    * `0.12 <http://scikit-learn.org/0.12/>`_
    * `0.11 <http://scikit-learn.org/0.11/>`_
    * `0.10 <http://scikit-learn.org/0.10/>`_
    * `0.9 <http://scikit-learn.org/0.9/>`_
    * `0.8 <http://scikit-learn.org/0.8/>`_
    * `0.7 <http://scikit-learn.org/0.7/>`_
    * `0.6 <http://scikit-learn.org/0.6/>`_
    * `0.5 <http://scikit-learn.org/0.5/>`_

Printable pdf documentation for all versions can be found `here
<http://sourceforge.net/projects/scikit-learn/files/documentation/>`_.