Conversation
WalkthroughThis update refines documentation for model inference runtimes and model repository management by improving formatting, list structures, and clarity. Headings and lists are standardized, and Git upload instructions are expanded. Additionally, the "@alauda/doom" development dependency is updated in the package configuration. Changes
Possibly related PRs
Suggested reviewers
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
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
docs/en/model_inference/inference_service/how_to/custom_inference_runtime.mdx (1)
117-120: YAML likely invalid – stray- bashafter script.Inside the
containers:stanza you already set:command: - bash - -c - | # long script …The extra list item on lines 119-120:
118 # see: … 119 - bash 120 resources:adds a fourth element to
command, turningresources:into a child of that list and breaking the manifest. Drop the stray- bash:- - bash - resources: + resources:Kube-api-server will reject otherwise.
🧹 Nitpick comments (2)
docs/en/model_inference/model_management/functions/model_repository.mdx (1)
124-135: Warn users about destructivegit lfs migrate import --above 100MB.Good call mentioning history-rewrite, but newcomers may still run this in a shared repo and nuke colleagues’ work. Consider adding an explicit caution line:
> ⚠️ **History rewrite ahead** – run this *only* before the first push, or coordinate a force-push with all collaborators.Helps avoid accidental data loss.
docs/en/model_inference/inference_service/how_to/custom_inference_runtime.mdx (1)
35-43: Minor spacing: “” tag should be followed by a blank line.Some MDX processors treat
<Steps>as a custom component needing a trailing newline; otherwise the first heading may stick to the tag. Just add one empty line after<Steps>to be safe.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (3)
docs/en/model_inference/inference_service/how_to/custom_inference_runtime.mdx(3 hunks)docs/en/model_inference/model_management/functions/model_repository.mdx(2 hunks)package.json(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/en/model_inference/model_management/functions/model_repository.mdx
[grammar] ~10-~10: Use correct spacing
Context: ...ges via commits/branches/tags, ensuring reproducibility. High-Speed Transfers - CLI/Notebook...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~13-~13: Use correct spacing
Context: ...ebook uploads leverage internal network bandwidth. Cross-Tenant Sharing - Shared models ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~16-~16: Use correct spacing
Context: ...s namespaces (e.g., public as a model marketplace). Seamless Integration - Directly deplo...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~19-~19: Use correct spacing
Context: ...models from the repository to inference services. ## Core Features **Model Repository Creati...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~24-~24: Use correct spacing
Context: ...hecks (e.g., ensure no active inference services). File Management 1. *Web UI Upload...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~31-~31: Use correct spacing
Context: ... files (e.g., *.bin, *.h5). - Example: bash git clone <model_repo_url> git lfs install cp ~/local_model/* . && git add . && git commit -m "v1.0" && git push Version Control 1. Branching ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~44-~44: Use correct spacing
Context: ...E.md` from the default branch for model descriptions. Cross-Tenant Sharing 1. **Shared Mo...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~50-~50: Use articles correctly
Context: ...ss. 2. Public Marketplace - Use public namespace to publish open-sour...
(QB_NEW_EN_OTHER_ERROR_IDS_11)
[grammar] ~50-~50: There might be a problem here.
Context: ...ce to publish open-source models (e.g., HuggingFace conversions). Integration with MLOps 1. **Deploym...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~56-~56: Use correct spacing
Context: ... models directly into AML Notebooks for testing: bash !git clone https://aml-public/resnet50.git ## Technical Notes 1. **Git LFS Requiremen...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~66-~66: Use correct spacing
Context: ...README.md` metadata may block inference deployment. ## Create Model Repository ### S...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~90-~90: There might be a mistake here.
Context: ...the File Management interface to upload files * Drag and drop files/folders into ...
(QB_NEW_EN_OTHER)
[grammar] ~91-~91: There might be a mistake here.
Context: ... drop files/folders into the designated area * Supported formats: All model file...
(QB_NEW_EN_OTHER)
[grammar] ~93-~93: Use correct spacing
Context: ...Progress tracking with real-time upload status * Option 2: Git Command Line Upload ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~95-~95: Use correct spacing
Context: ... status * Option 2: Git Command Line Upload 1. Get Repository Address: * Nav...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~98-~98: There might be a mistake here.
Context: ... * Navigate to Detail Info → Basic Info * Copy the Git repository URL (...
(QB_NEW_EN_OTHER)
[grammar] ~99-~99: There might be a mistake here.
Context: ... * Copy the Git repository URL (e.g., https://<your-domain>/<namespace>/<repo-name>.git) 2. Upload via Git: ```bash # Clone the...
(QB_NEW_EN_OTHER)
[grammar] ~101-~101: Use correct spacing
Context: ...<repo-name>.git) 2. Upload via Git: bash # Clone the repository git clone <repository-url> # Navigate to repo directory cd <repo-name> # Initialize Git LFS (if not already set up) git lfs install # Add model files (replace with your actual files) cp -r /path/to/your/model/files/* . # Configure LFS tracking (for large files) git lfs track "*.h5" "*.bin" "*.pt" # Commit and push git add . git commit -m "Add model files v1.0" # Perform LFS migration check for existing large files (as seen in screenshot) git lfs migrate info # Migrate existing large files to LFS, specifically those above 100MB. # NOTE: This command rewrites commit history. If the repository is already shared, # coordinate with collaborators and push with --force, or prefer running it # before the first public push. # This limit (100MB) is chosen based on GitHub's recommended file size limits # for optimal performance and handling, as documented at: # https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-large-files-on-github#file-size-limits git lfs migrate import --above 100MB git push origin main
(QB_NEW_EN_OTHER_ERROR_IDS_5)
docs/en/model_inference/inference_service/how_to/custom_inference_runtime.mdx
[grammar] ~39-~39: Use correct spacing
Context: ... ### Create Inference Runtime Resources You'll need to create the corresponding...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~41-~41: Use correct spacing
Context: ...sed on your target hardware environment (GPU/CPU/NPU). 1. *Prepare the Runtime YAML Configuration...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~43-~43: Use correct spacing
Context: ...PU/NPU). 1. Prepare the Runtime YAML Configuration: Based on the type of runtime you want t...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~153-~153: Use correct spacing
Context: ...erence Inference Service and Select the Runtime Once the Xinference inference runtime r...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~155-~155: Use correct spacing
Context: ...ng your LLM inference service on the AI Platform. 1. **Configure Inference Framework for the M...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~157-~157: Use correct spacing
Context: ...Configure Inference Framework for the Model: Ensure that on the model details page o...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~160-~160: Use correct spacing
Context: ...ate to the Inference Service Publishing Page**: Log in to the AI Platform and navigate ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~163-~163: Use correct spacing
Context: ...e Service." 3. Select the Xinference Runtime: In the inference service creation wizar...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
🔇 Additional comments (1)
package.json (1)
3-3: Verify compatibility impact of bumping@alauda/doomto^1.9.0.Jumping from the
1.4.xrange to1.9.xcan bring breaking changes in the Doom build pipeline (e.g., updated MDX processing rules, plugin renames). Please double-check:
- Local
yarn dev/doom buildstill complete successfully.- Any custom Doom plugins or theme overrides still resolve.
- The generated site in CI remains identical (diff HTML output).
If everything looks green, feel free to ignore.
docs/en/model_inference/model_management/functions/model_repository.mdx
Outdated
Show resolved
Hide resolved
Signed-off-by: Yuan Fang <yuanfang@alauda.io>
fyuan1316
force-pushed
the
format-doom_1.9
branch
from
8677c94 to
72bdf0d
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/en/model_inference/model_management/functions/model_repository.mdx (1)
8-19: Consolidate headline & bullet into one list item for cleaner MDXThe headline is rendered as a paragraph and its description as a separate bullet. Collapsing them into a single bullet keeps the list tight and avoids awkward spacing.
-**Git-native Version Control** -- Track model changes via commits/branches/tags, ensuring reproducibility. + - **Git-native Version Control**: Track model changes via commits/branches/tags, ensuring reproducibility.Repeat the same pattern for High-Speed Transfers, Cross-Tenant Sharing, and Seamless Integration to maintain consistency.
docs/en/model_inference/inference_service/how_to/custom_inference_runtime.mdx (1)
43-44: Nest numbered sub-steps two spaces deeper for proper Markdown hierarchyInside a
<Steps>block, any ordered list that belongs to the current step should be indented by two spaces. Without the indent, Markdown starts a new top-level list, which breaks the auto-numbering in Docusaurus.-1. **Prepare the Runtime YAML Configuration**: + 1. **Prepare the Runtime YAML Configuration**: -2. **Apply the YAML File to Create the Resource**: + 2. **Apply the YAML File to Create the Resource**:Same rule applies to similar sub-steps later in the file.
Also applies to: 142-144
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (3)
docs/en/model_inference/inference_service/how_to/custom_inference_runtime.mdx(3 hunks)docs/en/model_inference/model_management/functions/model_repository.mdx(2 hunks)package.json(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- package.json
🧰 Additional context used
🪛 LanguageTool
docs/en/model_inference/inference_service/how_to/custom_inference_runtime.mdx
[grammar] ~39-~39: Use correct spacing
Context: ... ### Create Inference Runtime Resources You'll need to create the corresponding...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~41-~41: Use correct spacing
Context: ...sed on your target hardware environment (GPU/CPU/NPU). 1. *Prepare the Runtime YAML Configuration...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~43-~43: Use correct spacing
Context: ...PU/NPU). 1. Prepare the Runtime YAML Configuration: Based on the type of runtime you want t...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~153-~153: Use correct spacing
Context: ...erence Inference Service and Select the Runtime Once the Xinference inference runtime r...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~155-~155: Use correct spacing
Context: ...ng your LLM inference service on the AI Platform. 1. **Configure Inference Framework for the M...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~157-~157: Use correct spacing
Context: ...Configure Inference Framework for the Model: Ensure that on the model details page o...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~160-~160: Use correct spacing
Context: ...ate to the Inference Service Publishing Page**: Log in to the AI Platform and navigate ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~163-~163: Use correct spacing
Context: ...e Service." 3. Select the Xinference Runtime: In the inference service creation wizar...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
docs/en/model_inference/model_management/functions/model_repository.mdx
[grammar] ~10-~10: Use correct spacing
Context: ...ges via commits/branches/tags, ensuring reproducibility. High-Speed Transfers - CLI/Notebook...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~13-~13: Use correct spacing
Context: ...ebook uploads leverage internal network bandwidth. Cross-Tenant Sharing - Shared models ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~16-~16: Use correct spacing
Context: ...s namespaces (e.g., public as a model marketplace). Seamless Integration - Directly deplo...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~19-~19: Use correct spacing
Context: ...models from the repository to inference services. ## Core Features **Model Repository Creati...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~24-~24: Use correct spacing
Context: ...hecks (e.g., ensure no active inference services). File Management 1. *Web UI Upload...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~31-~31: Use correct spacing
Context: ... files (e.g., *.bin, *.h5). - Example: bash git clone <model_repo_url> git lfs install cp ~/local_model/* . && git add . && git commit -m "v1.0" && git push Version Control 1. Branching ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~44-~44: Use correct spacing
Context: ...E.md` from the default branch for model descriptions. Cross-Tenant Sharing 1. **Shared Mo...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~50-~50: Use articles correctly
Context: ...ss. 2. Public Marketplace - Use public namespace to publish open-sour...
(QB_NEW_EN_OTHER_ERROR_IDS_11)
[grammar] ~50-~50: There might be a problem here.
Context: ...ce to publish open-source models (e.g., HuggingFace conversions). Integration with MLOps 1. **Deploym...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~56-~56: Use correct spacing
Context: ... models directly into AML Notebooks for testing: bash !git clone https://aml-public/resnet50.git ## Technical Notes 1. **Git LFS Requiremen...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~66-~66: Use correct spacing
Context: ...README.md` metadata may block inference deployment. ## Create Model Repository ### S...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
🔇 Additional comments (1)
docs/en/model_inference/model_management/functions/model_repository.mdx (1)
89-138: Indentation fix looks good – nested list now renders correctlyThe added four-space indent keeps Option 1 and Option 2 inside “Step 3”, resolving the rendering issue from the previous review.
1 participant
Summary by CodeRabbit
Documentation
Chores