DOC describe scikit-learn-contrib in related projects and contributing docs #8440
Conversation
Codecov Report
@@ Coverage Diff @@
## master #8440 +/- ##
==========================================
+ Coverage 95.47% 95.47% +<.01%
==========================================
Files 342 342
Lines 60902 60907 +5
==========================================
+ Hits 58149 58154 +5
Misses 2753 2753
Continue to review full report at Codecov.
|
doc/developers/contributing.rst
Outdated
| by deriving a class from ``BaseEstimator`` | ||
| and optionally the mixin classes in ``sklearn.base``. | ||
| E.g., below is a custom classifier. | ||
| `scikit-learn-contrib <https://github.com/scikit-learn-contrib/project-template/blob/master/skltemplate/template.py>`_:: |
There was a problem hiding this comment.
You removed "For more information on this example see", was that intentional? Now scikit-learn-contrib stand on its own which is a bit weird.
There was a problem hiding this comment.
I meant to remove "for more information on this example" because I found it weird. I did not mean to leave the URL there. WDYT?
There was a problem hiding this comment.
Looks like the template has some other examples of estimators, maybe you can do:
E.g., below is a custom classifier
>>> import numpy as np
...
For more examples of estimators see the `scikit-learn-contrib template <url>`_
doc/developers/contributing.rst
Outdated
| selection tools such as :class:`model_selection.GridSearchCV` and | ||
| :class:`pipeline.Pipeline`. | ||
|
|
||
| For this to work, you need to implement the interface described below. |
There was a problem hiding this comment.
Not sure what "described below" actually refers to, can we add a link? I know it was like this before but adding topics as you did makes below even belower if that makes sense ...
There was a problem hiding this comment.
How about: "Before detailing the required interface below, we describe two ways to achieve the correct interface more easily."
|
Changes made, thanks @lesteve |
|
LGTM, merging thanks a lot! |
No description provided.