scikit-learn/doc/tutorial/basic
Joel Nothman 840f632e8f 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).
2018-01-02 10:14:07 +01:00
..
tutorial.rst DOC A glossary of concepts and API elements (#9517) 2018-01-02 10:14:07 +01:00