Skip to content

Commit

Permalink
DOC Restructure Multiclass and multilabel in User Guide (scikit-learn…
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuacwnewton authored Sep 17, 2020
1 parent 370e545 commit 6d1104e
Show file tree
Hide file tree
Showing 6 changed files with 378 additions and 313 deletions.
6 changes: 6 additions & 0 deletions doc/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1037,7 +1037,9 @@ Target Types
identified as 'multiclass'.

continuous multioutput
continuous multi-output
multioutput continuous
multi-output continuous
A regression problem where each sample's target consists of ``n_outputs``
:term:`outputs`, each one a finite floating point number, for a
fixed int ``n_outputs > 1`` in a particular dataset.
Expand All @@ -1052,6 +1054,7 @@ Target Types
'multiclass-multioutput'.

multiclass
multi-class
A classification problem consisting of more than two classes. A
multiclass target may be represented as a 1-dimensional array of
strings or integers. A 2d column vector of integers (i.e. a
Expand All @@ -1075,7 +1078,9 @@ Target Types
identically to 'multiclass'.

multiclass multioutput
multi-class multi-output
multioutput multiclass
multi-output multi-class
A classification problem where each sample's target consists of
``n_outputs`` :term:`outputs`, each a class label, for a fixed int
``n_outputs > 1`` in a particular dataset. Each output has a
Expand All @@ -1101,6 +1106,7 @@ Target Types
'multiclass-multioutput' for multiclass multioutput input.

multilabel
multi-label
A :term:`multiclass multioutput` target where each output is
:term:`binary`. This may be represented as a 2d (dense) array or
sparse matrix of integers, such that each column is a separate binary
Expand Down
Binary file added doc/images/multi_org_chart.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 6 additions & 4 deletions doc/modules/classes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1220,14 +1220,14 @@ Model validation

.. _multiclass_ref:

:mod:`sklearn.multiclass`: Multiclass and multilabel classification
===================================================================
:mod:`sklearn.multiclass`: Multiclass classification
====================================================

.. automodule:: sklearn.multiclass
:no-members:
:no-inherited-members:

**User guide:** See the :ref:`multiclass` section for further details.
**User guide:** See the :ref:`multiclass_classification` section for further details.

.. currentmodule:: sklearn

Expand All @@ -1248,7 +1248,9 @@ Model validation
:no-members:
:no-inherited-members:

**User guide:** See the :ref:`multiclass` section for further details.
**User guide:** See the :ref:`multilabel_classification`,
:ref:`multiclass_multioutput_classification`, and
:ref:`multioutput_regression` sections for further details.

.. currentmodule:: sklearn

Expand Down
Loading

0 comments on commit 6d1104e

Please sign in to comment.