DOC revamp how to develop sklearn estimator page #30253
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Marked this as ready for review @glemaitre @adam2392 . I think these are the crucial areas which we better get in for the release since things have changed, and I'd be working on improving these / the rest of the document, and adding proper examples on how to write estimators in separate PRs. |
thomasjpfan
approved these changes
Nov 10, 2024
doc/developers/develop.rst
Outdated
| very few places, only in some meta-estimators, where the sub-estimator(s) argument is | ||
| a required argument. | ||
|
|
||
| The arguments should all correspond to hyperparameters describing the model or the |
There was a problem hiding this comment.
Not all arguments are hyparmeters or part of the optimization problem. For example CountVectorizer.input is not in a search space for tuning a model.
There was a problem hiding this comment.
This was text from before, but I agree, changed now.
adam2392
approved these changes
Nov 10, 2024
jeremiedbb
pushed a commit
to glemaitre/scikit-learn
that referenced
this pull request
Nov 14, 2024
jeremiedbb
pushed a commit
that referenced
this pull request
Nov 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The way people should develop estimators has changed quite a lot in the past years, and we also have developed our developer API quite a bit in recent years.
This PR is an effort to make the guide on how to develop an estimator more up to date with what we expect users to do these days.