Skip to content

Commit

Permalink
Generate docs for recmetrics (pytorch#2283)
Browse files Browse the repository at this point in the history
Summary: Pull Request resolved: pytorch#2283

Reviewed By: sarckk

Differential Revision: D61029859

fbshipit-source-id: 6d8a3ed536e234286bd497f2348cc4e90d3bd72e
  • Loading branch information
PaulZhang12 authored and facebook-github-bot committed Aug 9, 2024
1 parent a5605d5 commit e053cfe
Show file tree
Hide file tree
Showing 2 changed files with 149 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ TorchRec API
torchrec.optim.rst
torchrec.quant.rst
torchrec.sparse.rst
torchrec.metrics.rst

Indices and tables
==================
Expand Down
148 changes: 148 additions & 0 deletions docs/source/torchrec.metrics.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
torchrec.metrics
==============

.. automodule:: torchrec.metrics

torchrec.metrics.accuracy
---------------------------------

.. automodule:: torchrec.metrics.accuracy
:members:
:undoc-members:
:show-inheritance:

torchrec.metrics.auc
---------------------------------

.. automodule:: torchrec.metrics.auc
:members:
:undoc-members:
:show-inheritance:

torchrec.metrics.auprc
---------------------------------

.. automodule:: torchrec.metrics.auprc
:members:
:undoc-members:
:show-inheritance:

torchrec.metrics.calibration
---------------------------------

.. automodule:: torchrec.metrics.calibration
:members:
:undoc-members:
:show-inheritance:

torchrec.metrics.ctr
---------------------------------

.. automodule:: torchrec.metrics.ctr
:members:
:undoc-members:
:show-inheritance:

torchrec.metrics.mae
---------------------------------

.. automodule:: torchrec.metrics.mae
:members:
:undoc-members:
:show-inheritance:

torchrec.metrics.mse
---------------------------------

.. automodule:: torchrec.metrics.mse
:members:
:undoc-members:
:show-inheritance:

torchrec.metrics.multiclass_recall
---------------------------------

.. automodule:: torchrec.metrics.multiclass_recall
:members:
:undoc-members:
:show-inheritance:

torchrec.metrics.ndcg
---------------------------------

.. automodule:: torchrec.metrics.ndcg
:members:
:undoc-members:
:show-inheritance:

torchrec.metrics.ne
---------------------------------

.. automodule:: torchrec.metrics.ne
:members:
:undoc-members:
:show-inheritance:

torchrec.metrics.recall
---------------------------------

.. automodule:: torchrec.metrics.recall
:members:
:undoc-members:
:show-inheritance:

torchrec.metrics.precision
---------------------------------

.. automodule:: torchrec.metrics.precision
:members:
:undoc-members:
:show-inheritance:

torchrec.metrics.rauc
---------------------------------

.. automodule:: torchrec.metrics.rauc
:members:
:undoc-members:
:show-inheritance:

torchrec.metrics.throughput
---------------------------------

.. automodule:: torchrec.metrics.throughput
:members:
:undoc-members:
:show-inheritance:

torchrec.metrics.weighted_avg
---------------------------------

.. automodule:: torchrec.metrics.weighted_avg
:members:
:undoc-members:
:show-inheritance:

torchrec.metrics.xauc
---------------------------------

.. automodule:: torchrec.metrics.xauc
:members:
:undoc-members:
:show-inheritance:

torchrec.metrics.metric_module
---------------------------------

.. automodule:: torchrec.metrics.metric_module
:members:
:undoc-members:
:show-inheritance:

torchrec.metrics.rec_metric
---------------------------------

.. automodule:: torchrec.metrics.rec_metric
:members:
:undoc-members:
:show-inheritance:

0 comments on commit e053cfe

Please sign in to comment.