Expose ZCH modules in Documentation (pytorch#1613)

Summary: Pull Request resolved: pytorch#1613 Expose the ZCH modules in the documentation for the TorchRec page Reviewed By: henrylhtsang Differential Revision: D52603324 fbshipit-source-id: aa6b5a6b9ba4d305e6307b1444a8679e3aa7a8c1
henrylhtsang · Jan 9, 2024 · fb41384 · fb41384
1 parent 3c23d82
commit fb41384
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 2 deletions.
diff --git a/docs/source/torchrec.distributed.rst b/docs/source/torchrec.distributed.rst
@@ -124,3 +124,27 @@ torchrec.distributed.utils
    :members:
    :undoc-members:
    :show-inheritance:
+
+torchrec.distributed.mc_modules
+--------------------------
+
+.. automodule:: torchrec.distributed.mc_modules
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+torchrec.distributed.mc_embeddingbag
+--------------------------
+
+.. automodule:: torchrec.distributed.mc_embeddingbag
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+torchrec.distributed.mc_embedding
+--------------------------
+
+.. automodule:: torchrec.distributed.mc_embedding
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/torchrec.modules.rst b/docs/source/torchrec.modules.rst
@@ -76,10 +76,18 @@ torchrec.modules.utils
    :undoc-members:
    :show-inheritance:
 
-Module contents
+torchrec.modules.mc_modules
 ---------------
 
-.. automodule:: torchrec.modules
+.. automodule:: torchrec.modules.mc_modules
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+torchrec.modules.mc_embedding_modules
+---------------
+
+.. automodule:: torchrec.modules.mc_embedding_modules
    :members:
    :undoc-members:
    :show-inheritance: