8000 Explain why we are somewhat selective, lower citiation rule of thumb · scikit-learn/scikit-learn@8e3eea8 · GitHub
[go: up one dir, main page]

Skip to content

Commit 8e3eea8

Browse files
committed
Explain why we are somewhat selective, lower citiation rule of thumb
1 parent ac7c88c commit 8e3eea8

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

doc/faq.rst

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,37 @@ See :ref:`contributing`.
2727
Can I add this new algorithm that I (or someone else) just published?
2828
-------------------------------------------------------------------------
2929
No. As a rule we only add well-established algorithms. A rule of thumb is at least
30-
3 years since publications, 1000+ citations and wide use and usefullness. A
30+
3 years since publications, 200+ citations and wide use and usefullness. A
3131
technique that provides a clear-cut improvement (e.g. an enhanced data
3232
structure or efficient approximation) on a widely-used method will also be
3333
considered for inclusion.
3434
Your implementation doesn't need to be in scikit-learn to be used together
3535
with scikit-learn tools, though. Implement your favorite algorithm
3636
in a scikit-learn compatible way, upload it to github and we will list
3737
it under :ref:`related_projects`.
38+
Also see :selectiveness:
39+
3840

3941
Can I add this classical al CC58 gorithm from the 80s?
4042
---------------------------------------------------
4143
Depends. If there is a common usecase within the scope of scikit-learn, such
4244
as classification, regression or clustering, where it outperforms methods
4345
that are already implemented in scikit-learn, we will consider it.
4446

47+
.. _selectiveness:
48+
49+
Why are you so selective on what algorithms you include in scikit-learn?
50+
------------------------------------------------------------------------
51+
Code is maintenance cost, and we need to balance the amount of
52+
code we have with the size of the team (and add to this the fact that
53+
complexity scales non linearly with the number of features).
54+
The package relies on core developers using their free time to
55+
fix bugs, maintain code and review contributions.
56+
Any algorithm that is added needs future attention by the developers,
57+
at which point the original author might long have lost interest.
58+
Also see `this thread on the mailing list
59+
<http://sourceforge.net/p/scikit-learn/mailman/scikit-learn-general/thread/CAAkaFLWcBG%2BgtsFQzpTLfZoCsHMDv9UG5WaqT0LwUApte0TVzg%40mail.gmail.com/#msg33104380>`_.
60+
4561
Why did you remove HMMs from scikit-learn?
4662
--------------------------------------------
4763
See :ref:`adding_graphical_models`.

0 commit comments

Comments
 (0)
0