Skip to content

Commit f1430c3

Browse files
jshin1394jshin1394
committed
update metrax readthedocs
1 parent e025f74 commit f1430c3

31 files changed

+1096
-21
lines changed

‎docs/api/metrax.AUCPR.rst‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
metrax.AUCPR
2+
============
3+
4+
.. currentmodule:: metrax
5+
6+
.. autoclass:: AUCPR
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~AUCPR.__init__
17+
~AUCPR.compute
18+
~AUCPR.compute_value
19+
~AUCPR.empty
20+
~AUCPR.from_fun
21+
~AUCPR.from_model_output
22+
~AUCPR.from_output
23+
~AUCPR.interpolate_pr_auc
24+
~AUCPR.merge
25+
~AUCPR.reduce
26+
~AUCPR.replace
27+
28+
29+
30+
31+
32+
.. rubric:: Attributes
33+
34+
.. autosummary::
35+
36+
~AUCPR.true_positives
37+
~AUCPR.false_positives
38+
~AUCPR.false_negatives
39+
~AUCPR.num_thresholds
40+
41+

‎docs/api/metrax.AUCROC.rst‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
metrax.AUCROC
2+
=============
3+
4+
.. currentmodule:: metrax
5+
6+
.. autoclass:: AUCROC
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~AUCROC.__init__
17+
~AUCROC.compute
18+
~AUCROC.compute_value
19+
~AUCROC.empty
20+
~AUCROC.from_fun
21+
~AUCROC.from_model_output
22+
~AUCROC.from_output
23+
~AUCROC.merge
24+
~AUCROC.reduce
25+
~AUCROC.replace
26+
27+
28+
29+
30+
31+
.. rubric:: Attributes
32+
33+
.. autosummary::
34+
35+
~AUCROC.true_positives
36+
~AUCROC.true_negatives
37+
~AUCROC.false_positives
38+
~AUCROC.false_negatives
39+
~AUCROC.num_thresholds
40+
41+

‎docs/api/metrax.Accuracy.rst‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
metrax.Accuracy
2+
===============
3+
4+
.. currentmodule:: metrax
5+
6+
.. autoclass:: Accuracy
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~Accuracy.__init__
17+
~Accuracy.compute
18+
~Accuracy.compute_value
19+
~Accuracy.empty
20+
~Accuracy.from_fun
21+
~Accuracy.from_model_output
22+
~Accuracy.from_output
23+
~Accuracy.merge
24+
~Accuracy.reduce
25+
~Accuracy.replace
26+
27+
28+
29+
30+
31+
.. rubric:: Attributes
32+
33+
.. autosummary::
34+
35+
~Accuracy.total
36+
~Accuracy.count
37+
38+

‎docs/api/metrax.Average.rst‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
metrax.Average
2+
==============
3+
4+
.. currentmodule:: metrax
5+
6+
.. autoclass:: Average
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~Average.__init__
17+
~Average.compute
18+
~Average.compute_value
19+
~Average.empty
20+
~Average.from_fun
21+
~Average.from_model_output
22+
~Average.from_output
23+
~Average.merge
24+
~Average.reduce
25+
~Average.replace
26+
27+
28+
29+
30+
31+
.. rubric:: Attributes
32+
33+
.. autosummary::
34+
35+
~Average.total
36+
~Average.count
37+
38+

‎docs/api/metrax.AveragePrecisionAtK.rst‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
metrax.AveragePrecisionAtK
2+
==========================
3+
4+
.. currentmodule:: metrax
5+
6+
.. autoclass:: AveragePrecisionAtK
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~AveragePrecisionAtK.__init__
17+
~AveragePrecisionAtK.average_precision_at_ks
18+
~AveragePrecisionAtK.compute
19+
~AveragePrecisionAtK.compute_value
20+
~AveragePrecisionAtK.empty
21+
~AveragePrecisionAtK.from_fun
22+
~AveragePrecisionAtK.from_model_output
23+
~AveragePrecisionAtK.from_output
24+
~AveragePrecisionAtK.merge
25+
~AveragePrecisionAtK.reduce
26+
~AveragePrecisionAtK.replace
27+
28+
29+
30+
31+
32+
.. rubric:: Attributes
33+
34+
.. autosummary::
35+
36+
~AveragePrecisionAtK.total
37+
~AveragePrecisionAtK.count
38+
39+

‎docs/api/metrax.BLEU.rst‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
metrax.BLEU
2+
===========
3+
4+
.. currentmodule:: metrax
5+
6+
.. autoclass:: BLEU
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~BLEU.__init__
17+
~BLEU.compute
18+
~BLEU.compute_value
19+
~BLEU.empty
20+
~BLEU.from_fun
21+
~BLEU.from_model_output
22+
~BLEU.from_output
23+
~BLEU.merge
24+
~BLEU.reduce
25+
~BLEU.replace
26+
27+
28+
29+
30+
31+
.. rubric:: Attributes
32+
33+
.. autosummary::
34+
35+
~BLEU.max_order
36+
~BLEU.matches_by_order
37+
~BLEU.possible_matches_by_order
38+
~BLEU.translation_length
39+
~BLEU.reference_length
40+
41+

‎docs/api/metrax.DCGAtK.rst‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
metrax.DCGAtK
2+
=============
3+
4+
.. currentmodule:: metrax
5+
6+
.. autoclass:: DCGAtK
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~DCGAtK.__init__
17+
~DCGAtK.compute
18+
~DCGAtK.compute_value
19+
~DCGAtK.empty
20+
~DCGAtK.from_fun
21+
~DCGAtK.from_model_output
22+
~DCGAtK.from_output
23+
~DCGAtK.merge
24+
~DCGAtK.reduce
25+
~DCGAtK.replace
26+
27+
28+
29+
30+
31+
.. rubric:: Attributes
32+
33+
.. autosummary::
34+
35+
~DCGAtK.total
36+
~DCGAtK.count
37+
38+

‎docs/api/metrax.Dice.rst‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
metrax.Dice
2+
===========
3+
4+
.. currentmodule:: metrax
5+
6+
.. autoclass:: Dice
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~Dice.__init__
17+
~Dice.compute
18+
~Dice.compute_value
19+
~Dice.empty
20+
~Dice.from_fun
21+
~Dice.from_model_output
22+
~Dice.from_output
23+
~Dice.merge
24+
~Dice.reduce
25+
~Dice.replace
26+
27+
28+
29+
30+
31+
.. rubric:: Attributes
32+
33+
.. autosummary::
34+
35+
~Dice.intersection
36+
~Dice.sum_pred
37+
~Dice.sum_true
38+
39+

‎docs/api/metrax.FBetaScore.rst‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
metrax.FBetaScore
2+
=================
3+
4+
.. currentmodule:: metrax
5+
6+
.. autoclass:: FBetaScore
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~FBetaScore.__init__
17+
~FBetaScore.compute
18+
~FBetaScore.compute_value
19+
~FBetaScore.empty
20+
~FBetaScore.from_fun
21+
~FBetaScore.from_model_output
22+
~FBetaScore.from_output
23+
~FBetaScore.merge
24+
~FBetaScore.reduce
25+
~FBetaScore.replace
26+
27+
28+
29+
30+
31+
.. rubric:: Attributes
32+
33+
.. autosummary::
34+
35+
~FBetaScore.beta
36+
~FBetaScore.true_positives
37+
~FBetaScore.false_positives
38+
~FBetaScore.false_negatives
39+
40+

0 commit comments

Comments
 (0)