Update documentation for Quick Start and Base Model deployment #745
+12
−5
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Jeffwan
reviewed
Feb 26, 2025
| ^^^^^^^^^^^^^^^^^ | ||
|
|
||
| .. note:: | ||
| In the given example, please ensure that your node is equipped with NVIDIA GPUs. Otherwise, the pod will stuck in pending state. |
There was a problem hiding this comment.
Most users will expect to run this on GPU env. I think here we do not want to implicitly mention NVIDIA GPUs is needed. Technically, amd gpus or other NPUs works as well. we can say device plugin for accelerator is needed.
|
|
||
| ```shell | ||
| # Prerequisites: | ||
| # After installing Docker and Kubernetes, please make sure your Kubernetes cluster ready, and then run the following commands to install AIBrix components in your Kubernetes cluster. |
There was a problem hiding this comment.
Technically, docker is not necessary, people may need other container runtimes like containerd or cri-o. After getting Kubernetes ready should be good. container runtime is prerequsite to run kubernetes. Most of the users will use public cloud provides kubernetes in prod, there's no need to install it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Description
Update documentation to list prerequisites for Quick Start and Base Model deployment.
Related Issues
Resolves: #[Insert issue number(s)]
Important: Before submitting, please complete the description above and review the checklist below.
Contribution Guidelines (Expand for Details)
We appreciate your contribution to aibrix! To ensure a smooth review process and maintain high code quality, please adhere to the following guidelines:
Pull Request Title Format
Your PR title should start with one of these prefixes to indicate the nature of the change:
[Bug]: Corrections to existing functionality[CI]: Changes to build process or CI pipeline[Docs]: Updates or additions to documentation[API]: Modifications to aibrix's API or interface[CLI]: Changes or additions to the Command Line Interface[Misc]: For changes not covered above (use sparingly)Note: For changes spanning multiple categories, use multiple prefixes in order of importance.
Submission Checklist
By submitting this PR, you confirm that you've read these guidelines and your changes align with the project's contribution standards.