Skip to content

Add documentation on f1, recall and precision score with averaging me... #477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 16, 2018
Merged

Add documentation on f1, recall and precision score with averaging me... #477

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions doc/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ Built-in Metrics

Classification
~~~~~~~~~~~~~~
Note: The default ``autosklearn.metrics.f1``, ``autosklearn.metrics.precision`` and ``autosklearn.metrics.recall``
built-in metrics are applicable only for binary classification. In order to apply them on multilabel and multiclass
classification, please use the corresponding metrics with an appropriate averaging mechanism, such as ``autosklearn.metrics.f1_macro``.
For more information about how these metrics are used, please read
`this scikit-learn documentation <http://scikit-learn.org/stable/modules/model_evaluation.html#precision-recall-and-f-measures>`_.

.. autoclass:: autosklearn.metrics.accuracy

Expand Down