Skip to content

[Docs] Improve docstring formatting for FusedMoEParallelConfig.make #21117

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

Jump to bottom
Merged
merged 4 commits into from
Jul 17, 2025
Merged

[Docs] Improve docstring formatting for FusedMoEParallelConfig.make #21117

merged 4 commits into from
Jul 17, 2025

Conversation

hmellor
Copy link
Member

@hmellor hmellor commented Jul 17, 2025

This docstring contains some really nice examples explaining parallelism for the FusedMoE. This PR updates the formatting so that it renders nicely in the API reference.

@hmellor
Improve docstring formatting for FusedMoEParallelConfig.make
172c263 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@github-actions GitHub Actions
Copy link

👋 Hi! Thank you for contributing to the vLLM project.

💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels.

Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can either: Add ready label to the PR or enable auto-merge.

🚀

gemini-code-assist[bot]
gemini-code-assist bot reviewed Jul 17, 2025
View reviewed changes
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request improves the docstring formatting for FusedMoEParallelConfig.make, which is great for readability. However, I've identified a correctness issue in the docstring where it incorrectly lists ep_size_ as a parameter. I've provided a suggestion to fix this to ensure the documentation accurately reflects the method's signature.

hmellor added 2 commits July 17, 2025 12:43
@hmellor
Fix args and allow longer lines
d344496 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@hmellor
Fix multiline arg description
58c01ae 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@hmellor
Copy link
Member Author

hmellor commented Jul 17, 2025

Preview here, looks good to me now https://vllm--21117.org.readthedocs.build/en/21117/api/vllm/model_executor/layers/fused_moe/config.html#vllm.model_executor.layers.fused_moe.config.FusedMoEParallelConfig.make

@DarkLight1337
Copy link
Member

Pre-commit failed

@hmellor
pre-commit
6dfa737 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@vllm-bot vllm-bot merged commit fe8a2c5 into vllm-project:main Jul 17, 2025
6 of 9 checks passed
@hmellor hmellor deleted the improve-docstring branch July 17, 2025 12:34
hj-mistral pushed a commit to hj-mistral/vllm that referenced this pull request Jul 19, 2025
@hmellor @hj-mistral
[Docs] Improve docstring formatting for FusedMoEParallelConfig.make (…
9da956e 
…vllm-project#21117)

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Himanshu Jaju <hj@mistral.ai>
LyrisZhong pushed a commit to LyrisZhong/vllm that referenced this pull request Jul 23, 2025
@hmellor @LyrisZhong
[Docs] Improve docstring formatting for FusedMoEParallelConfig.make (…
c11fdaf 
…vllm-project#21117)

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
avigny pushed a commit to avigny/vllm that referenced this pull request Jul 31, 2025
@hmellor @avigny
[Docs] Improve docstring formatting for FusedMoEParallelConfig.make (…
f4f8043 
…vllm-project#21117)

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: avigny <47987522+avigny@users.noreply.github.com>
x22x22 pushed a commit to x22x22/vllm that referenced this pull request Aug 5, 2025
@hmellor @x22x22
[Docs] Improve docstring formatting for FusedMoEParallelConfig.make (…
1b7398c 
…vllm-project#21117)

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: x22x22 <wadeking@qq.com>
Pradyun92 pushed a commit to Pradyun92/vllm that referenced this pull request Aug 6, 2025
@hmellor
[Docs] Improve docstring formatting for FusedMoEParallelConfig.make (…
a516083 
…vllm-project#21117)

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
npanpaliya pushed a commit to odh-on-pz/vllm-upstream that referenced this pull request Aug 6, 2025
@hmellor @npanpaliya
[Docs] Improve docstring formatting for FusedMoEParallelConfig.make (…
19c6cfc 
…vllm-project#21117)

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
jinzhen-lin pushed a commit to jinzhen-lin/vllm that referenced this pull request Aug 9, 2025
@hmellor @jinzhen-lin
[Docs] Improve docstring formatting for FusedMoEParallelConfig.make (…
e2dfb55 
…vllm-project#21117)

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Jinzhen Lin <linjinzhen@hotmail.com>
paulpak58 pushed a commit to paulpak58/vllm that referenced this pull request Aug 13, 2025
@hmellor @paulpak58
[Docs] Improve docstring formatting for FusedMoEParallelConfig.make (…
fb6cb8c 
…vllm-project#21117)

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Paul Pak <paulpak58@gmail.com>
taneem-ibrahim pushed a commit to taneem-ibrahim/vllm that referenced this pull request Aug 14, 2025
@hmellor @taneem-ibrahim
[Docs] Improve docstring formatting for FusedMoEParallelConfig.make (…
9e925c8 
…vllm-project#21117)

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
diegocastanibm pushed a commit to diegocastanibm/vllm that referenced this pull request Aug 15, 2025
@hmellor @diegocastanibm
[Docs] Improve docstring formatting for FusedMoEParallelConfig.make (…
1c7eb25 
…vllm-project#21117)

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Diego-Castan <diego.castan@ibm.com>
epwalsh pushed a commit to epwalsh/vllm that referenced this pull request Aug 27, 2025
@hmellor @epwalsh
[Docs] Improve docstring formatting for FusedMoEParallelConfig.make (…
d446039 
…vllm-project#21117)

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
googlercolin pushed a commit to googlercolin/vllm that referenced this pull request Aug 29, 2025
@hmellor @googlercolin
[Docs] Improve docstring formatting for FusedMoEParallelConfig.make (…
44fa245 
…vllm-project#21117)

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DarkLight1337 DarkLight1337 DarkLight1337 approved these changes

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@hmellor @DarkLight1337 @vllm-bot