docs(dynamo_run): fix typos and improve clarity #1603
Conversation
Signed-off-by: Shriyash.Patil <shriyash81@gmail.com>
- Fix inconsistent capitalization of 'Hugging Face' - Fix verb agreement: 'downloads' -> 'download' These changes improve documentation readability with no functional impact. Signed-off-by: Shriyash.Patil <shriyash81@gmail.com>
|
👋 Hi ShriyashP! Thank you for contributing to ai-dynamo/dynamo. Just a reminder: The 🚀 |
github-actions
bot
added
the
external-contribution
WalkthroughThe documentation for the Changes
Possibly related PRs
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (13)
docs/guides/dynamo_run.md (13)
34-35: Fix verb agreement in instruction
Change “and starts it in interactive text mode” to “and start it in interactive text mode” for grammatical correctness.
61-61: Convert bare URL to markdown link
Replace the bare URL with a markdown link (e.g.,[Llama-3.2-3B-Instruct-GGUF](https://huggingface.co/bartowski/Llama-3.2-3B-Instruct-GGUF)) to satisfy MD034 and improve consistency.
66-66: Add language specifier to fenced code block
Specify a language (e.g.,bash) for this code fence to enable syntax highlighting (MD040).
74-75: Use heading instead of emphasis
Convert_Text interface_to a proper subheading (e.g.,#### Text interface) instead of italic for clarity and accessibility.
80-81: Replace emphasis with heading
Change_HTTP interface_to a heading (#### HTTP interface) to maintain consistent styling.
88-89: Use heading for list title
Convert_List the models_into a heading (#### List the models) to align with other section titles.
94-94: Use heading instead of italic for section
Replace_Send a request_with a heading (#### Send a request) for consistency.
128-131: Refine list punctuation and style
Add a comma after “Usually,” in the first bullet for clarity and ensure code‐style backticks aroundNamespace,Component,Endpoint, andInstanceare consistent.
176-176: Improve list formatting for “or”
The standalone**or**breaks the numbered list. Merge it into the preceding item or indent it as a sub-point to preserve numbering.
195-195: Align indentation of explanatory text
The line “If you patched locally (instead of installingai-dynamo-vllm)…” should align under the surrounding code block context for readability.
232-232: Add language to code fence
Mark this fence asbash(or appropriate) to enable syntax highlighting (MD040).
240-240: Specify language for code block
Add a language label (e.g.,bash) to this fence to satisfy MD040.
267-267: Add language specifiers across multiple fences
Several newly formatted code blocks at the listed lines lack a language label. Please specify languages (bash,python,json, etc.) for proper syntax highlighting.Also applies to: 273-273, 292-292, 392-392, 429-429, 543-543, 551-551, 561-561, 665-665
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/guides/dynamo_run.md(22 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/guides/dynamo_run.md
36-36: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
61-61: Bare URL used
null
(MD034, no-bare-urls)
62-62: Bare URL used
null
(MD034, no-bare-urls)
66-66: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
74-74: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
76-76: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
80-80: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
82-82: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
88-88: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
90-90: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
94-94: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
139-139: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
232-232: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
240-240: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
267-267: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
273-273: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
292-292: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
392-392: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
429-429: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
543-543: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
551-551: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
561-561: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
🪛 LanguageTool
docs/guides/dynamo_run.md
[typographical] ~128-~128: Consider adding a comma after ‘Usually’ for more clarity.
Context: ...ger system. - Namespace: A pipeline. Usually a model. e.g "llama_8b". Just a name. -...
(RB_LY_COMMA)
[uncategorized] ~548-~548: Possible missing comma found.
Context: ...er in output.jsonl. At the end of the run some statistics are printed. The output...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~653-~653: Loose punctuation mark.
Context: ...ke the following kwargs: - model_name: The name to call the model. Your incomi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~654-~654: Loose punctuation mark.
Context: ...r the GGUF file name. - context_length: Max model length in tokens. Defaults to...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~655-~655: Loose punctuation mark.
Context: ...o fit into VRAM. - kv_cache_block_size: Size of a KV block for the engine, in t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~665-~665: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...hello_world/server_sglang_tok.py) More fully-featured Backend engines (used by dynamo-run):...
(HYPHENATED_LY_ADVERB_ADJECTIVE)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Build and Test - vllm
🔇 Additional comments (1)
docs/guides/dynamo_run.md (1)
10-10: Approve: Blank line before usage block
Adding a blank line before theUsage:code block improves readability.
WalkthroughThe documentation for the Changes
Possibly related PRs
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
docs/guides/dynamo_run.md (1)
172-177: Restructure ‘either/or’ list for consistency
Embedding or as a bold line breaks the ordered list structure. Turn it into a second list item:-1. Install Dynamo's vllm branch: - ```bash - uv pip install ai-dynamo-vllm - ``` - **or** -1. Install upstream vllm 0.8.4: - ```bash - uv pip install vllm==0.8.4 - ``` +1. Install Dynamo's vllm branch: + ```bash + uv pip install ai-dynamo-vllm + ``` +2. Install upstream vllm 0.8.4: + ```bash + uv pip install vllm==0.8.4 + ```
🧹 Nitpick comments (2)
docs/guides/dynamo_run.md (2)
60-63: Convert bare URLs to markdown links
Raw URLs reduce readability and can’t carry descriptive text. Wrap model references in markdown links. Example:-One of the models available from Hugging Face should be high quality and fast on almost any machine: https://huggingface.co/bartowski/Llama-3.2-3B-Instruct-GGUF +One high-quality model available on Hugging Face is [bartowski/Llama-3.2-3B-Instruct-GGUF](https://huggingface.co/bartowski/Llama-3.2-3B-Instruct-GGUF), which runs efficiently on most machines.
195-200: Clarify patch‐reversion instructions and formatting
The note about undoing the local patch would be clearer as a subheading with consistent indentation, and code fences should specify the diff language.##### Undo local vllm patch (if not using `ai-dynamo-vllm`) 1. Open `platforms/__init__.py` in your patched vllm installation. 2. Revert the version assignment: ```diff - #vllm_version = version("ai_dynamo_vllm") - vllm_version = version("vllm") + #vllm_version = version("ai_dynamo_vllm") + vllm_version = version("vllm")</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: .coderabbit.yaml** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 9622caaa7bf7429ef3c943c6f5659531808178d8 and 60ef75c18250a79d9a89101fbc26177225b44a25. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `docs/guides/dynamo_run.md` (22 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> <details> <summary>docs/guides/dynamo_run.md</summary> 36-36: Fenced code blocks should have a language specified null (MD040, fenced-code-language) --- 61-61: Bare URL used null (MD034, no-bare-urls) --- 62-62: Bare URL used null (MD034, no-bare-urls) --- 66-66: Fenced code blocks should have a language specified null (MD040, fenced-code-language) --- 74-74: Emphasis used instead of a heading null (MD036, no-emphasis-as-heading) --- 76-76: Fenced code blocks should have a language specified null (MD040, fenced-code-language) --- 80-80: Emphasis used instead of a heading null (MD036, no-emphasis-as-heading) --- 82-82: Fenced code blocks should have a language specified null (MD040, fenced-code-language) --- 88-88: Emphasis used instead of a heading null (MD036, no-emphasis-as-heading) --- 90-90: Fenced code blocks should have a language specified null (MD040, fenced-code-language) --- 94-94: Emphasis used instead of a heading null (MD036, no-emphasis-as-heading) --- 139-139: Fenced code blocks should have a language specified null (MD040, fenced-code-language) --- 232-232: Fenced code blocks should have a language specified null (MD040, fenced-code-language) --- 240-240: Fenced code blocks should have a language specified null (MD040, fenced-code-language) --- 267-267: Fenced code blocks should have a language specified null (MD040, fenced-code-language) --- 273-273: Fenced code blocks should have a language specified null (MD040, fenced-code-language) --- 292-292: Fenced code blocks should have a language specified null (MD040, fenced-code-language) --- 392-392: Fenced code blocks should have a language specified null (MD040, fenced-code-language) --- 429-429: Fenced code blocks should have a language specified null (MD040, fenced-code-language) --- 543-543: Fenced code blocks should have a language specified null (MD040, fenced-code-language) --- 551-551: Fenced code blocks should have a language specified null (MD040, fenced-code-language) --- 561-561: Fenced code blocks should have a language specified null (MD040, fenced-code-language) </details> </details> <details> <summary>🪛 LanguageTool</summary> <details> <summary>docs/guides/dynamo_run.md</summary> [typographical] ~128-~128: Consider adding a comma after ‘Usually’ for more clarity. Context: ...ger system. - _Namespace_: A pipeline. Usually a model. e.g "llama_8b". Just a name. -... (RB_LY_COMMA) --- [uncategorized] ~548-~548: Possible missing comma found. Context: ...er in `output.jsonl`. At the end of the run some statistics are printed. The output... (AI_HYDRA_LEO_MISSING_COMMA) --- [uncategorized] ~653-~653: Loose punctuation mark. Context: ...ke the following kwargs: - `model_name`: The name to call the model. Your incomi... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~654-~654: Loose punctuation mark. Context: ...r the GGUF file name. - `context_length`: Max model length in tokens. Defaults to... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~655-~655: Loose punctuation mark. Context: ...o fit into VRAM. - `kv_cache_block_size`: Size of a KV block for the engine, in t... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~665-~665: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’. Context: ...hello_world/server_sglang_tok.py) More fully-featured Backend engines (used by `dynamo-run`):... (HYPHENATED_LY_ADVERB_ADJECTIVE) </details> </details> </details> <details> <summary>⏰ Context from checks skipped due to timeout of 90000ms (1)</summary> * GitHub Check: Build and Test - vllm </details> <details> <summary>🔇 Additional comments (1)</summary><blockquote> <details> <summary>docs/guides/dynamo_run.md (1)</summary> `10-13`: **Add blank line before usage code block** The inserted blank line before the fenced code block under “Usage:” improves visual separation and readability. </details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
ShriyashP
changed the title
Fix Documentation Typos in dynamo_run.md
Description
This PR addresses minor typos and formatting issues in the dynamo_run.md documentation to improve readability.
Changes Made
Type of Change
Checklist
Testing
No testing required - these are purely documentation formatting fixes with no impact on functionality.
Summary by CodeRabbit
dynamo runcommand.