-
-
Notifications
You must be signed in to change notification settings - Fork 25.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DOC A glossary of concepts and API elements (#9517)
Skeleton for a glossary of concepts and API elements. This responds to at least three issues: * Many aspects of scikit-learn API for users and developers are known tacitly by core contributors (and the stack overflow crowd), but are not written down in a consistent place. * What is written is in an ad-hoc narrative style which may be useful for introduction, but is difficult to refer to and to maintain. * Parameters such as `n_jobs` and methods like `decision_function` are described repeatedly in documentation giving sometimes more sometimes less information. This glossary allows us to use "See :term:`the glossary <n_jobs>`." so that parameter descriptions in the API reference can remain brief (just as not every numpy operation needs to describe broadcasting).
- Loading branch information
Showing
10 changed files
with
1,689 additions
and
18 deletions.
There are no files selected for viewing
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
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
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
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
Oops, something went wrong.