Skip to content

Commit

Permalink
build-docs job builds from source (#2466)
Browse files Browse the repository at this point in the history
Summary:
Pull Request resolved: #2466

Previously we build docs from nightly. Hard for us to see previews of docstring changes, here we change it to build from source.

Reviewed By: svekars

Differential Revision: D63784555

fbshipit-source-id: 2402fc7d31b91c9f1b7a503211c9d3e6b8f7641e
  • Loading branch information
PaulZhang12 committed Oct 8, 2024
1 parent 9c7c1bd commit 92ac355
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ jobs:
include:
- os: linux.20_04.4x
python-version: 3.9
python-tag: "py39"
steps:
- name: Check ldd --version
run: ldd --version
Expand Down Expand Up @@ -66,7 +67,8 @@ jobs:
conda run -n build_binary pip install torchmetrics==1.0.3
- name: Install TorchRec
run: |
conda run -n build_binary pip install torchrec --index-url https://download.pytorch.org/whl/nightly/cpu
conda run -n build_binary pip install -r requirements.txt
conda run -n build_binary python setup.py bdist_wheel --python-tag=${{ matrix.python-tag }}
- name: Test fbgemm_gpu and torchrec installation
shell: bash
run: |
Expand Down
3 changes: 1 addition & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
import sys

import pytorch_sphinx_theme
import torchrec

current_dir = os.path.dirname(__file__)
target_dir = os.path.abspath(os.path.join(current_dir, "../.."))
Expand All @@ -36,7 +35,7 @@

try:
# pyre-ignore
version = torchrec.__version__
version = "1.0.0" # TODO: Hardcode stable version for now
except Exception:
# when run internally, we don't have a version yet
version = "0.0.0"
Expand Down
1 change: 1 addition & 0 deletions torchrec/distributed/planner/planners.py
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ class EmbeddingShardingPlanner(ShardingPlanner):
debug (bool): whether to print debug information.
Example::
ebc = EmbeddingBagCollection(tables=eb_configs, device=torch.device("meta"))
planner = EmbeddingShardingPlanner()
plan = planner.plan(
Expand Down

0 comments on commit 92ac355

Please sign in to comment.