Skip to content

Fix docs that are rendering Incorrectly#7344

Merged
loadams merged 10 commits into
deepspeedai:masterfrom
felixgondwe:master
Jun 9, 2025
Merged

Fix docs that are rendering Incorrectly#7344
loadams merged 10 commits into
deepspeedai:masterfrom
felixgondwe:master

Conversation

@felixgondwe
Copy link
Copy Markdown
Contributor

Fixes #6747

Changes

  • Added missing imports required for the documentation to render correctly.
  • Changed autoclass_content from auto to both
    The value auto is not valid according to the Sphinx documentation.

Preview

Sample fixed page: https://deepspeedfelixgondwefork.readthedocs.io/en/latest/model-checkpointing.html

Current broken page: https://deepspeed.readthedocs.io/en/latest/model-checkpointing.html

qgallouedec and others added 9 commits June 9, 2025 19:19
Fixes this warning:

```
 /fsx/qgallouedec/miniconda3/envs/trl/lib/python3.12/site-packages/deepspeed/runtime/config_utils.py:100: PydanticDeprecatedSince211: Accessing the 'model_fields' attribute on the instance is deprecated. Instead, you should access this attribute from the model class. Deprecated in Pydantic V2.11 to be removed in V3.0.
    fields = self.model_fields
```

Co-authored-by: Olatunji Ruwase <tjruwase@gmail.com>
Signed-off-by: felixgondwe <zungwala@gmail.com>
Signed-off-by: felixgondwe <zungwala@gmail.com>
This is needed to avoid the issue of ci failure in deepspeedai#7330 PR.

Signed-off-by: Shaik Raza Sikander <srsikander@habana.ai>
Co-authored-by: Olatunji Ruwase <tjruwase@gmail.com>
Signed-off-by: felixgondwe <zungwala@gmail.com>
This PR fixes an issue with symint input in backend. (See deepspeedai#7229)

---------

Signed-off-by: Masahiro Tanaka <mtanaka@microsoft.com>
Co-authored-by: Logan Adams <114770087+loadams@users.noreply.github.com>
Signed-off-by: felixgondwe <zungwala@gmail.com>
…ble (deepspeedai#7330)

This fix is required to prevent the below error:

=================================== FAILURES
===================================
__________________ TestFp8ComposabilityAcrossZero.test[fp16]
___________________
multiprocessing.pool.RemoteTraceback:
"""
Traceback (most recent call last):
File "/opt/conda/envs/py_3.10/lib/python3.10/multiprocessing/pool.py",
line 125, in worker
    result = (True, func(*args, **kwds))
File "/opt/conda/envs/py_3.10/lib/python3.10/multiprocessing/pool.py",
line 51, in starmapstar
    return list(itertools.starmap(args[0], args[1]))
File "/root/PR/test/DeepSpeed/tests/unit/common.py", line 322, in
_dist_run
    raise e
File "/root/PR/test/DeepSpeed/tests/unit/common.py", line 314, in
_dist_run
    self.run(**self._fixture_kwargs)
  File "/root/PR/test/DeepSpeed/tests/unit/common.py", line 470, in run
    self._current_test(**fixture_kwargs)
File
"/root/PR/test/DeepSpeed/tests/unit/runtime/half_precision/test_fp8.py",
line 88, in test
    loss = run_zero(stage, model_dtype)
File
"/root/PR/test/DeepSpeed/tests/unit/runtime/half_precision/test_fp8.py",
line 74, in run_zero
    model.step()
File "/root/PR/test/DeepSpeed/deepspeed/runtime/engine.py", line 2387,
in step
    self._take_model_step(lr_kwargs)
File "/root/PR/test/DeepSpeed/deepspeed/runtime/engine.py", line 2290,
in _take_model_step
    self.optimizer.step()
File
"/root/PR/test/DeepSpeed/deepspeed/runtime/fp16/fused_optimizer.py",
line 255, in step
    self.timers(OVERFLOW_CHECK_TIMER).start()
TypeError: 'NoneType' object is not callable
"""

Co-authored-by: Olatunji Ruwase <tjruwase@gmail.com>
Co-authored-by: Logan Adams <114770087+loadams@users.noreply.github.com>
Co-authored-by: Olatunji Ruwase <tunji.ruwase@snowflake.com>
Signed-off-by: felixgondwe <zungwala@gmail.com>
- FastPersist
- ZeRO-Inference+SGLang

---------

Signed-off-by: Olatunji Ruwase <olruwase@microsoft.com>
Signed-off-by: Olatunji Ruwase <tunji.ruwase@snowflake.com>
Co-authored-by: jerryyangli <jerryyangli@gmail.com>
Co-authored-by: Yang Li <yangli2@microsoft.com>
Co-authored-by: Guanhua Wang <alexwgh333@gmail.com>
Co-authored-by: Connor Holmes <connorholmes@microsoft.com>
Co-authored-by: Bing Xie <67908712+xiexbing@users.noreply.github.com>
Co-authored-by: cassieesvelt <73311224+cassieesvelt@users.noreply.github.com>
Co-authored-by: Jeff Rasley <jerasley@microsoft.com>
Co-authored-by: Logan Adams <114770087+loadams@users.noreply.github.com>
Co-authored-by: Michael Wyatt <michaelwyatt@microsoft.com>
Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
Co-authored-by: swli <47371259+lucasleesw@users.noreply.github.com>
Co-authored-by: Cheng Li <pistasable@gmail.com>
Co-authored-by: Molly Smith <112220543+molly-smith@users.noreply.github.com>
Co-authored-by: Ubuntu <jomayeri@microsoft.com>
Co-authored-by: Olatunji Ruwase <tunji.ruwase@snowflake.com>
Co-authored-by: Zhipeng Wang <zhipeng.rainbowserie@gmail.com>
Signed-off-by: felixgondwe <zungwala@gmail.com>
…e for testing (deepspeedai#7163)

Since the previous PR encountered the DCO problem and could not be
solved for some reason, I resubmitted a completely identical PR but
without the problem.

---------

Signed-off-by: xiongjyu <xiongjyu@gmail.com>
Co-authored-by: Logan Adams <114770087+loadams@users.noreply.github.com>
Co-authored-by: Olatunji Ruwase <tjruwase@gmail.com>
Co-authored-by: Masahiro Tanaka <81312776+tohtana@users.noreply.github.com>
Signed-off-by: felixgondwe <zungwala@gmail.com>
## PR Summary
This small PR fixes the LoRA arxiv reference in
`mixed_precision_zeropp.md`. Relevant docs page:
https://www.deepspeed.ai/tutorials/mixed_precision_zeropp/

Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
Signed-off-by: felixgondwe <zungwala@gmail.com>
Sync folder name with release date

---------

Signed-off-by: Olatunji Ruwase <tunji.ruwase@snowflake.com>
Signed-off-by: felixgondwe <zungwala@gmail.com>
@loadams loadams merged commit 4d0c159 into deepspeedai:master Jun 9, 2025
2 checks passed
deepcharm pushed a commit to deepcharm/DeepSpeed that referenced this pull request Jun 16, 2025
Fixes deepspeedai#6747

### Changes

- Added missing imports required for the documentation to render
correctly.
- Changed `autoclass_content` from `auto` to `both`
The value `auto` is **not valid** according to the [Sphinx
documentation](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autoclass_content).

### Preview

Sample fixed page:
https://deepspeedfelixgondwefork.readthedocs.io/en/latest/model-checkpointing.html

Current broken page:
https://deepspeed.readthedocs.io/en/latest/model-checkpointing.html

---------

Signed-off-by: felixgondwe <zungwala@gmail.com>
Signed-off-by: Shaik Raza Sikander <srsikander@habana.ai>
Signed-off-by: Masahiro Tanaka <mtanaka@microsoft.com>
Signed-off-by: Olatunji Ruwase <olruwase@microsoft.com>
Signed-off-by: Olatunji Ruwase <tunji.ruwase@snowflake.com>
Signed-off-by: xiongjyu <xiongjyu@gmail.com>
Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
Co-authored-by: Quentin Gallouédec <45557362+qgallouedec@users.noreply.github.com>
Co-authored-by: Olatunji Ruwase <tjruwase@gmail.com>
Co-authored-by: Raza Sikander <srsikander@habana.ai>
Co-authored-by: Masahiro Tanaka <81312776+tohtana@users.noreply.github.com>
Co-authored-by: Logan Adams <114770087+loadams@users.noreply.github.com>
Co-authored-by: Ramya Ramineni <62723901+rraminen@users.noreply.github.com>
Co-authored-by: Olatunji Ruwase <tunji.ruwase@snowflake.com>
Co-authored-by: jerryyangli <jerryyangli@gmail.com>
Co-authored-by: Yang Li <yangli2@microsoft.com>
Co-authored-by: Guanhua Wang <alexwgh333@gmail.com>
Co-authored-by: Connor Holmes <connorholmes@microsoft.com>
Co-authored-by: Bing Xie <67908712+xiexbing@users.noreply.github.com>
Co-authored-by: cassieesvelt <73311224+cassieesvelt@users.noreply.github.com>
Co-authored-by: Jeff Rasley <jerasley@microsoft.com>
Co-authored-by: Michael Wyatt <michaelwyatt@microsoft.com>
Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
Co-authored-by: swli <47371259+lucasleesw@users.noreply.github.com>
Co-authored-by: Cheng Li <pistasable@gmail.com>
Co-authored-by: Molly Smith <112220543+molly-smith@users.noreply.github.com>
Co-authored-by: Ubuntu <jomayeri@microsoft.com>
Co-authored-by: Zhipeng Wang <zhipeng.rainbowserie@gmail.com>
Co-authored-by: xiongjyu <xiongjyu@gmail.com>
Co-authored-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
Signed-off-by: Max Kovalenko <mkovalenko@habana.ai>
Antlera pushed a commit to Antlera/DeepSpeed that referenced this pull request Jun 27, 2025
Fixes deepspeedai#6747 

### Changes

- Added missing imports required for the documentation to render
correctly.
- Changed `autoclass_content` from `auto` to `both`
The value `auto` is **not valid** according to the [Sphinx
documentation](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autoclass_content).


### Preview

Sample fixed page:
https://deepspeedfelixgondwefork.readthedocs.io/en/latest/model-checkpointing.html

Current broken page:
https://deepspeed.readthedocs.io/en/latest/model-checkpointing.html

---------

Signed-off-by: felixgondwe <zungwala@gmail.com>
Signed-off-by: Shaik Raza Sikander <srsikander@habana.ai>
Signed-off-by: Masahiro Tanaka <mtanaka@microsoft.com>
Signed-off-by: Olatunji Ruwase <olruwase@microsoft.com>
Signed-off-by: Olatunji Ruwase <tunji.ruwase@snowflake.com>
Signed-off-by: xiongjyu <xiongjyu@gmail.com>
Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
Co-authored-by: Quentin Gallouédec <45557362+qgallouedec@users.noreply.github.com>
Co-authored-by: Olatunji Ruwase <tjruwase@gmail.com>
Co-authored-by: Raza Sikander <srsikander@habana.ai>
Co-authored-by: Masahiro Tanaka <81312776+tohtana@users.noreply.github.com>
Co-authored-by: Logan Adams <114770087+loadams@users.noreply.github.com>
Co-authored-by: Ramya Ramineni <62723901+rraminen@users.noreply.github.com>
Co-authored-by: Olatunji Ruwase <tunji.ruwase@snowflake.com>
Co-authored-by: jerryyangli <jerryyangli@gmail.com>
Co-authored-by: Yang Li <yangli2@microsoft.com>
Co-authored-by: Guanhua Wang <alexwgh333@gmail.com>
Co-authored-by: Connor Holmes <connorholmes@microsoft.com>
Co-authored-by: Bing Xie <67908712+xiexbing@users.noreply.github.com>
Co-authored-by: cassieesvelt <73311224+cassieesvelt@users.noreply.github.com>
Co-authored-by: Jeff Rasley <jerasley@microsoft.com>
Co-authored-by: Michael Wyatt <michaelwyatt@microsoft.com>
Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
Co-authored-by: swli <47371259+lucasleesw@users.noreply.github.com>
Co-authored-by: Cheng Li <pistasable@gmail.com>
Co-authored-by: Molly Smith <112220543+molly-smith@users.noreply.github.com>
Co-authored-by: Ubuntu <jomayeri@microsoft.com>
Co-authored-by: Zhipeng Wang <zhipeng.rainbowserie@gmail.com>
Co-authored-by: xiongjyu <xiongjyu@gmail.com>
Co-authored-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
mauryaavinash95 pushed a commit to DataStates/DeepSpeed that referenced this pull request Oct 4, 2025
Fixes deepspeedai#6747 

### Changes

- Added missing imports required for the documentation to render
correctly.
- Changed `autoclass_content` from `auto` to `both`
The value `auto` is **not valid** according to the [Sphinx
documentation](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autoclass_content).


### Preview

Sample fixed page:
https://deepspeedfelixgondwefork.readthedocs.io/en/latest/model-checkpointing.html

Current broken page:
https://deepspeed.readthedocs.io/en/latest/model-checkpointing.html

---------

Signed-off-by: felixgondwe <zungwala@gmail.com>
Signed-off-by: Shaik Raza Sikander <srsikander@habana.ai>
Signed-off-by: Masahiro Tanaka <mtanaka@microsoft.com>
Signed-off-by: Olatunji Ruwase <olruwase@microsoft.com>
Signed-off-by: Olatunji Ruwase <tunji.ruwase@snowflake.com>
Signed-off-by: xiongjyu <xiongjyu@gmail.com>
Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
Co-authored-by: Quentin Gallouédec <45557362+qgallouedec@users.noreply.github.com>
Co-authored-by: Olatunji Ruwase <tjruwase@gmail.com>
Co-authored-by: Raza Sikander <srsikander@habana.ai>
Co-authored-by: Masahiro Tanaka <81312776+tohtana@users.noreply.github.com>
Co-authored-by: Logan Adams <114770087+loadams@users.noreply.github.com>
Co-authored-by: Ramya Ramineni <62723901+rraminen@users.noreply.github.com>
Co-authored-by: Olatunji Ruwase <tunji.ruwase@snowflake.com>
Co-authored-by: jerryyangli <jerryyangli@gmail.com>
Co-authored-by: Yang Li <yangli2@microsoft.com>
Co-authored-by: Guanhua Wang <alexwgh333@gmail.com>
Co-authored-by: Connor Holmes <connorholmes@microsoft.com>
Co-authored-by: Bing Xie <67908712+xiexbing@users.noreply.github.com>
Co-authored-by: cassieesvelt <73311224+cassieesvelt@users.noreply.github.com>
Co-authored-by: Jeff Rasley <jerasley@microsoft.com>
Co-authored-by: Michael Wyatt <michaelwyatt@microsoft.com>
Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
Co-authored-by: swli <47371259+lucasleesw@users.noreply.github.com>
Co-authored-by: Cheng Li <pistasable@gmail.com>
Co-authored-by: Molly Smith <112220543+molly-smith@users.noreply.github.com>
Co-authored-by: Ubuntu <jomayeri@microsoft.com>
Co-authored-by: Zhipeng Wang <zhipeng.rainbowserie@gmail.com>
Co-authored-by: xiongjyu <xiongjyu@gmail.com>
Co-authored-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Model Checkpoint docs are incorrectly rendered on deepspeed.readthedocs.io

10 participants