Skip to content

[MRG] Metric documentation (mainly in classification) #1512

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 28 commits into from
Jan 9, 2013
Merged

[MRG] Metric documentation (mainly in classification) #1512

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
9e1fcd9
DOC add narrative overall description of classification metrics
arjoly Jan 3, 2013
96751e0
DOC add hinge loss narrative doc
arjoly Jan 3, 2013
754038e
DOC Set reference links in the doc
arjoly Jan 3, 2013
21a19d5
DOC add narrative doc on zero_one loss metric
arjoly Jan 3, 2013
be5037d
DOC add narrative doc on zero_one_score
arjoly Jan 3, 2013
f30261e
DOC add narrative doc for precision, recall and fbeta measures
arjoly Jan 3, 2013
879b8e1
DOC add narrative doc on roc curve
arjoly Jan 3, 2013
23c1067
DOC add narrative doc on auc and average precision
arjoly Jan 3, 2013
b105993
DOC add narrative doc on matthews_corrcoef
arjoly Jan 3, 2013
ada3532
DOC add narrative doc for explained variance
arjoly Jan 3, 2013
95fab3e
DOC add reference to multioutput metrics in regression
arjoly Jan 3, 2013
4d4a1e0
DOC add link to clustering metrics
arjoly Jan 3, 2013
765173c
Update what's new
arjoly Jan 3, 2013
e7b8f6e
ENH renamed metrics.zero_one to metrics.zero_one_loss
arjoly Jan 4, 2013
6cf5ee0
ENH rename zero_loss_score to accuracy_score
arjoly Jan 4, 2013
8d901ba
ENH ClassifierMixin use a metrics from sklearn.metrics
arjoly Jan 4, 2013
4db98e2
DOC add classification_report to the narrative doc
arjoly Jan 4, 2013
46094fa
DOC typo and mistakes
arjoly Jan 4, 2013
4c49bab
DOC comment from @amueller + several minor improvements
arjoly Jan 6, 2013
2e911f0
TST + DOC add many examples on sklearn.metrics
arjoly Jan 6, 2013
e3506ae
DOC typo + minor improvements
arjoly Jan 7, 2013
b0cfa10
DOC remove redundant comment
arjoly Jan 7, 2013
4aa4698
DOC better example with dummy estimator + link to appropriate reference
arjoly Jan 8, 2013
17d5fef
ENH use deprecated decorator
arjoly Jan 9, 2013
e9bc6ca
FIX DOC missing default behavior change
arjoly Jan 9, 2013
d9a4cd6
DOC COSMIT pretty math
arjoly Jan 9, 2013
8a8ea33
DOC clarification of api change
arjoly Jan 9, 2013
fd5801e
FIX catch deprecation warning
arjoly Jan 9, 2013
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
2 changes: 1 addition & 1 deletion benchmarks/bench_covertype.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ def benchmark(clf):
t0 = time()
pred = clf.predict(X_test)
test_time = time() - t0
err = metrics.zero_one(y_test, pred) / float(pred.shape[0])
err = metrics.zero_one_loss(y_test, pred) / float(pred.shape[0])
return err, train_time, test_time

######################################################################
Expand Down
9 changes: 6 additions & 3 deletions doc/modules/classes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -668,6 +668,7 @@ Classification metrics
:toctree: generated/
:template: function.rst

metrics.accuracy_score
metrics.auc
metrics.auc_score
metrics.average_precision_score
Expand All @@ -676,13 +677,13 @@ Classification metrics
metrics.f1_score
metrics.fbeta_score
metrics.hinge_loss
metrics.matthews_corrcoef
metrics.precision_recall_curve
metrics.precision_recall_fscore_support
metrics.precision_score
metrics.recall_score
metrics.roc_curve
metrics.zero_one_score
metrics.zero_one
metrics.zero_one_loss

Regression metrics
------------------
Expand All @@ -694,6 +695,7 @@ details.
:toctree: generated/
:template: function.rst

metrics.explained_variance_score
metrics.mean_absolute_error
metrics.mean_squared_error
metrics.r2_score
Expand All @@ -702,7 +704,8 @@ details.
Clustering metrics
------------------

See the :ref:`clustering` section of the user guide for further details.
See the :ref:`clustering_evaluation` section of the user guide for further
details.

.. automodule:: sklearn.metrics.cluster
:no-members:
Expand Down
Loading