Skip to content

Commit

Permalink
Expose ZCH modules in Documentation (#1613)
Browse files Browse the repository at this point in the history
Summary:

Expose the ZCH modules in the documentation for the TorchRec page

Differential Revision: D52603324
  • Loading branch information
PaulZhang12 authored and facebook-github-bot committed Jan 9, 2024
1 parent 3c23d82 commit 216a9b2
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 2 deletions.
24 changes: 24 additions & 0 deletions docs/source/torchrec.distributed.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
12 changes: 10 additions & 2 deletions docs/source/torchrec.modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

0 comments on commit 216a9b2

Please sign in to comment.