1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
=======
Support
=======
There are several channels to connect with scikit-learn developers for assistance, feedback, or contributions.
**Note**: Communications on all channels should respect our `Code of Conduct <https://github.com/scikit-learn/scikit-learn/blob/main/CODE_OF_CONDUCT.md>`_.
.. _announcements_and_notification:
Mailing Lists
=============
- **Main Mailing List**: Join the primary discussion
platform for scikit-learn at `scikit-learn Mailing List
<https://mail.python.org/mailman/listinfo/scikitlearn>`_.
- **Commit Updates**: Stay informed about repository
updates and test failures on the `scikit-learn-commits list
<https://lists.sourceforge.net/lists/listinfo/scikit-learn-commits>`_.
.. _user_questions:
User Questions
==============
If you have questions, this is our general workflow.
- **Stack Overflow**: Some scikit-learn developers support users using the
`[scikit-learn] <https://stackoverflow.com/questions/tagged/scikit-learn>`_
tag.
- **General Machine Learning Queries**: For broader machine learning
discussions, visit `Stack Exchange <https://stats.stackexchange.com/>`_.
When posting questions:
- Please use a descriptive question in the title field (e.g. no "Please
help with scikit-learn!" as this is not a question)
- Provide detailed context, expected results, and actual observations.
- Include code and data snippets (preferably minimalistic scripts,
up to ~20 lines).
- Describe your data and preprocessing steps, including sample size,
feature types (categorical or numerical), and the target for supervised
learning tasks (classification type or regression).
**Note**: Avoid asking user questions on the bug tracker to keep
the focus on development.
- `GitHub Discussions <https://github.com/scikit-learn/scikit-learn/discussions>`_
Usage questions such as methodological
- `Stack Overflow <https://stackoverflow.com/questions/tagged/scikit-learn>`_
Programming/user questions with `[scikit-learn]` tag
- `GitHub Bug Tracker <https://github.com/scikit-learn/scikit-learn/issues>`_
Bug reports - Please do not ask usage questions on the issue tracker.
- `Discord Server <https://discord.gg/h9qyrK8Jc8>`_
Current pull requests - Post any specific PR-related questions on your PR,
and you can share a link to your PR on this server.
.. _bug_tracker:
Bug Tracker
===========
Encountered a bug? Report it on our `issue tracker
<https://github.com/scikit-learn/scikit-learn/issues>`_
Include in your report:
- Steps or scripts to reproduce the bug.
- Expected and observed outcomes.
- Python or gdb tracebacks, if applicable.
- The ideal bug report contains a :ref:`short reproducible code snippet
<minimal_reproducer>`, this way anyone can try to reproduce the bug easily.
- If your snippet is longer than around 50 lines, please link to a
`gist <https://gist.github.com>`_ or a github repo.
**Tip**: Gists are Git repositories; you can push data files to them using Git.
Paid support
============
The following companies (listed in alphabetical order) offer support services
related to scikit-learn and have a proven track record of employing long-term
maintainers of scikit-learn and related open source projects:
- `:probabl. <https://support.probabl.ai/?utm_source=scikit_learn_docs&utm_medium=documentation&utm_campaign=pro_support>`__
- `Quansight <https://quansight.com/open-source-services>`__
.. _social_media:
Social Media
============
scikit-learn has presence on various social media platforms to share
updates with the community. The platforms are not monitored for user
questions.
.. _gitter:
Gitter
======
**Note**: The scikit-learn Gitter room is no longer an active community.
For live discussions and support, please refer to the other channels
mentioned in this document.
.. _documentation_resources:
Documentation Resources
=======================
This documentation is for |release|. Documentation for other versions can be found `here
<https://scikit-learn.org/dev/versions.html>`__, including zip archives which can be
downloaded for offline access.
We no longer provide a PDF version of the documentation, but you can still generate it
locally by following the :ref:`building documentation instructions <building_documentation>`.
The most recent version with a PDF documentation is quite old, 0.23.2 (released
in August 2020), but the PDF is available `here
<https://scikit-learn.org/0.23/_downloads/scikit-learn-docs.pdf>`__.
|
