Skip to content

[docs] fix broken read-the-docs build #2075

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeffra merged 5 commits into from
Jul 6, 2022
Merged

[docs] fix broken read-the-docs build #2075

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d1897d9
Update requirements-readthedocs.txt
jeffra Jul 6, 2022
3d36bb5
Update requirements-readthedocs.txt
jeffra Jul 6, 2022
450d521
fix z2 and remove everything but z3
jeffra Jul 6, 2022
bf34545
revert
jeffra Jul 6, 2022
270a430
formatting
jeffra Jul 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/code-docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
author = 'Microsoft'

# The full version, including alpha/beta/rc tags
release = '0.3.0'
release = '0.6'

master_doc = 'index'

Expand Down
8 changes: 4 additions & 4 deletions docs/code-docs/source/memory.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ API To Estimate Memory Usage

ZeRO2:

.. autofunction:: deepspeed.runtime.zero.stage2.estimate_zero2_model_states_mem_needs_all_live
.. autofunction:: deepspeed.runtime.zero.stage_1_and_2.estimate_zero2_model_states_mem_needs_all_live

.. autofunction:: deepspeed.runtime.zero.stage2.estimate_zero2_model_states_mem_needs_all_cold
.. autofunction:: deepspeed.runtime.zero.stage_1_and_2.estimate_zero2_model_states_mem_needs_all_cold

Examples:

Expand All @@ -18,7 +18,7 @@ Let's try a 3B model with just 1 node with 8 gpus, using live model:
.. code-block:: bash

python -c 'from transformers import AutoModel; \
from deepspeed.runtime.zero.stage2 import estimate_zero2_model_states_mem_needs_all_live; \
from deepspeed.runtime.zero.stage_1_and_2 import estimate_zero2_model_states_mem_needs_all_live; \
model = AutoModel.from_pretrained("t5-3b"); \
estimate_zero2_model_states_mem_needs_all_live(model, num_gpus_per_node=8, num_nodes=1)'
Estimated memory needed for params, optim states and gradients for a:
Expand All @@ -34,7 +34,7 @@ faster as we don't need to load the model.

.. code-block:: bash

python -c 'from deepspeed.runtime.zero.stage2 import estimate_zero2_model_states_mem_needs_all_cold; \
python -c 'from deepspeed.runtime.zero.stage_1_and_2 import estimate_zero2_model_states_mem_needs_all_cold; \
estimate_zero2_model_states_mem_needs_all_cold(total_params=2851e6, num_gpus_per_node=8, num_nodes=1)'
Estimated memory needed for params, optim states and gradients for a:
HW: Setup with 1 node, 8 GPUs per node.
Expand Down
3 changes: 3 additions & 0 deletions requirements/requirements-readthedocs.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
docutils<0.18
hjson
packaging
psutil
py-cpuinfo
pydantic
torch
tqdm