From 3cf05fa891ad20f20d695d3c6b69a7889400f388 Mon Sep 17 00:00:00 2001 From: Paul Zhang Date: Tue, 9 Jan 2024 11:07:37 -0800 Subject: [PATCH] Expose ZCH modules in Documentation (#1613) Summary: Pull Request resolved: https://github.com/pytorch/torchrec/pull/1613 Differential Revision: D52603324 --- .github/workflows/docs.yml | 1 + docs/source/torchrec.modules.rst | 12 ++++++++++-- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 87776f6f4..067f19695 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,6 +1,7 @@ # This workflow builds the torchrec docs and deploys them to gh-pages. name: Generate documentation on: + pull_request: push: branches: - main diff --git a/docs/source/torchrec.modules.rst b/docs/source/torchrec.modules.rst index 95dcf35db..e2c9ee771 100644 --- 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: