Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
41 changes: 41 additions & 0 deletions docs/api/metrax.AUCPR.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
metrax.AUCPR
============

.. currentmodule:: metrax

.. autoclass:: AUCPR


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~AUCPR.__init__
~AUCPR.compute
~AUCPR.compute_value
~AUCPR.empty
~AUCPR.from_fun
~AUCPR.from_model_output
~AUCPR.from_output
~AUCPR.interpolate_pr_auc
~AUCPR.merge
~AUCPR.reduce
~AUCPR.replace





.. rubric:: Attributes

.. autosummary::

~AUCPR.true_positives
~AUCPR.false_positives
~AUCPR.false_negatives
~AUCPR.num_thresholds


41 changes: 41 additions & 0 deletions docs/api/metrax.AUCROC.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
metrax.AUCROC
=============

.. currentmodule:: metrax

.. autoclass:: AUCROC


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~AUCROC.__init__
~AUCROC.compute
~AUCROC.compute_value
~AUCROC.empty
~AUCROC.from_fun
~AUCROC.from_model_output
~AUCROC.from_output
~AUCROC.merge
~AUCROC.reduce
~AUCROC.replace





.. rubric:: Attributes

.. autosummary::

~AUCROC.true_positives
~AUCROC.true_negatives
~AUCROC.false_positives
~AUCROC.false_negatives
~AUCROC.num_thresholds


38 changes: 38 additions & 0 deletions docs/api/metrax.Accuracy.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
metrax.Accuracy
===============

.. currentmodule:: metrax

.. autoclass:: Accuracy


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~Accuracy.__init__
~Accuracy.compute
~Accuracy.compute_value
~Accuracy.empty
~Accuracy.from_fun
~Accuracy.from_model_output
~Accuracy.from_output
~Accuracy.merge
~Accuracy.reduce
~Accuracy.replace





.. rubric:: Attributes

.. autosummary::

~Accuracy.total
~Accuracy.count


38 changes: 38 additions & 0 deletions docs/api/metrax.Average.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
metrax.Average
==============

.. currentmodule:: metrax

.. autoclass:: Average


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~Average.__init__
~Average.compute
~Average.compute_value
~Average.empty
~Average.from_fun
~Average.from_model_output
~Average.from_output
~Average.merge
~Average.reduce
~Average.replace





.. rubric:: Attributes

.. autosummary::

~Average.total
~Average.count


39 changes: 39 additions & 0 deletions docs/api/metrax.AveragePrecisionAtK.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
metrax.AveragePrecisionAtK
==========================

.. currentmodule:: metrax

.. autoclass:: AveragePrecisionAtK


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~AveragePrecisionAtK.__init__
~AveragePrecisionAtK.average_precision_at_ks
~AveragePrecisionAtK.compute
~AveragePrecisionAtK.compute_value
~AveragePrecisionAtK.empty
~AveragePrecisionAtK.from_fun
~AveragePrecisionAtK.from_model_output
~AveragePrecisionAtK.from_output
~AveragePrecisionAtK.merge
~AveragePrecisionAtK.reduce
~AveragePrecisionAtK.replace





.. rubric:: Attributes

.. autosummary::

~AveragePrecisionAtK.total
~AveragePrecisionAtK.count


41 changes: 41 additions & 0 deletions docs/api/metrax.BLEU.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
metrax.BLEU
===========

.. currentmodule:: metrax

.. autoclass:: BLEU


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~BLEU.__init__
~BLEU.compute
~BLEU.compute_value
~BLEU.empty
~BLEU.from_fun
~BLEU.from_model_output
~BLEU.from_output
~BLEU.merge
~BLEU.reduce
~BLEU.replace





.. rubric:: Attributes

.. autosummary::

~BLEU.max_order
~BLEU.matches_by_order
~BLEU.possible_matches_by_order
~BLEU.translation_length
~BLEU.reference_length


38 changes: 38 additions & 0 deletions docs/api/metrax.DCGAtK.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
metrax.DCGAtK
=============

.. currentmodule:: metrax

.. autoclass:: DCGAtK


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~DCGAtK.__init__
~DCGAtK.compute
~DCGAtK.compute_value
~DCGAtK.empty
~DCGAtK.from_fun
~DCGAtK.from_model_output
~DCGAtK.from_output
~DCGAtK.merge
~DCGAtK.reduce
~DCGAtK.replace





.. rubric:: Attributes

.. autosummary::

~DCGAtK.total
~DCGAtK.count


39 changes: 39 additions & 0 deletions docs/api/metrax.Dice.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
metrax.Dice
===========

.. currentmodule:: metrax

.. autoclass:: Dice


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~Dice.__init__
~Dice.compute
~Dice.compute_value
~Dice.empty
~Dice.from_fun
~Dice.from_model_output
~Dice.from_output
~Dice.merge
~Dice.reduce
~Dice.replace





.. rubric:: Attributes

.. autosummary::

~Dice.intersection
~Dice.sum_pred
~Dice.sum_true


40 changes: 40 additions & 0 deletions docs/api/metrax.FBetaScore.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
metrax.FBetaScore
=================

.. currentmodule:: metrax

.. autoclass:: FBetaScore


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~FBetaScore.__init__
~FBetaScore.compute
~FBetaScore.compute_value
~FBetaScore.empty
~FBetaScore.from_fun
~FBetaScore.from_model_output
~FBetaScore.from_output
~FBetaScore.merge
~FBetaScore.reduce
~FBetaScore.replace





.. rubric:: Attributes

.. autosummary::

~FBetaScore.beta
~FBetaScore.true_positives
~FBetaScore.false_positives
~FBetaScore.false_negatives


Loading