From e053cfeec0040bd5f61600c0638eca9eb2368f00 Mon Sep 17 00:00:00 2001
From: Paul Zhang <paulzhan@meta.com>
Date: Fri, 9 Aug 2024 15:16:14 -0700
Subject: [PATCH] Generate docs for recmetrics (#2283)

Summary: Pull Request resolved: https://github.com/pytorch/torchrec/pull/2283

Reviewed By: sarckk

Differential Revision: D61029859

fbshipit-source-id: 6d8a3ed536e234286bd497f2348cc4e90d3bd72e
---
 docs/source/index.rst            |   1 +
 docs/source/torchrec.metrics.rst | 148 +++++++++++++++++++++++++++++++
 2 files changed, 149 insertions(+)
 create mode 100644 docs/source/torchrec.metrics.rst

diff --git a/docs/source/index.rst b/docs/source/index.rst
index 09f3a6f2c..e01b67441 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -44,6 +44,7 @@ TorchRec API
    torchrec.optim.rst
    torchrec.quant.rst
    torchrec.sparse.rst
+   torchrec.metrics.rst
 
 Indices and tables
 ==================
diff --git a/docs/source/torchrec.metrics.rst b/docs/source/torchrec.metrics.rst
new file mode 100644
index 000000000..0a8e7f418
--- /dev/null
+++ b/docs/source/torchrec.metrics.rst
@@ -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: