Skip to content
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.

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

Update documentation for Quick Start and Base Model deployment #745

Open
wants to merge 19 commits into
base: main
Choose a base branch
from

Conversation

xieus
Copy link
Collaborator

@xieus xieus commented Feb 26, 2025

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

  • PR title includes appropriate prefix(es)
  • Changes are clearly explained in the PR description
  • New and existing tests pass successfully
  • Code adheres to project style and best practices
  • Documentation updated to reflect changes (if applicable)
  • Thorough testing completed, no regressions introduced

By submitting this PR, you confirm that you've read these guidelines and your changes align with the project's contribution standards.

@xieus xieus requested a review from Jeffwan February 26, 2025 00:46
xieus and others added 19 commits March 5, 2025 09:52
Signed-off-by: Yuan Tang <[email protected]>
Signed-off-by: Liguang Xie <[email protected]>
Use native codegen command for client-go

Signed-off-by: kerthcet <[email protected]>
Signed-off-by: Liguang Xie <[email protected]>
fix(docs): changed to kubectl create to prevent error seen in Issue #743

Signed-off-by: jolfr <[email protected]>
Signed-off-by: Liguang Xie <[email protected]>
…ounting, etc) (#738)

Fixing bugs
- Fixing header setting bug in AsyncOpenAI client
- Fixing wrong token count issue in streaming client
- Handling failed request properly for streaming client.
- Added request id in output log

Signed-off-by: “Gangmuk <[email protected]>
Signed-off-by: Liguang Xie <[email protected]>
* Add webhook framework

Signed-off-by: kerthcet <[email protected]>

* Revert back the `make manifest` command

Signed-off-by: kerthcet <[email protected]>

---------

Signed-off-by: kerthcet <[email protected]>
Signed-off-by: Liguang Xie <[email protected]>
Signed-off-by: Varun Gupta <[email protected]>
Signed-off-by: Liguang Xie <[email protected]>
Create SECURITY.md

Signed-off-by: Liguang Xie <[email protected]>
Add integration test

Signed-off-by: kerthcet <[email protected]>
Signed-off-by: Liguang Xie <[email protected]>
fix: correct non-inherited context

Signed-off-by: Abirdcfly <[email protected]>
Signed-off-by: Liguang Xie <[email protected]>
Parametrize Makefile for mocked vLLM apps

Allow setting:
- CONTAINER_TOOL
- AIBRIX_CONTAINER_REGISTRY_NAMESPACE

Variables names follow the main root Makefile

Signed-off-by: Pierangelo Di Pilato <[email protected]>
Signed-off-by: Liguang Xie <[email protected]>
Creating benchmarks utils
- moved common functions to utils dir
- cleaned up benchmarks/autoscaling
- updated benchmarks/autoscaling/run-test.sh

Signed-off-by: “Gangmuk <[email protected]>
Signed-off-by: Liguang Xie <[email protected]>
* Ignore worker pods for gateway routing
* ignore worker pods in UpdatePod as well
* use node worker as const

Signed-off-by: Varun Gupta <[email protected]>
Signed-off-by: Liguang Xie <[email protected]>
fix env error caused by helm set command, use —set-string for env bool

Signed-off-by: Jiaxin Shan <[email protected]>
Signed-off-by: Liguang Xie <[email protected]>
* Make stream include usage as optional

---------

Signed-off-by: Varun Gupta <[email protected]>
Signed-off-by: Liguang Xie <[email protected]>
It helps to only consider the engine pod for multi-node inference. Ray worker doesn’t have http server running and it can not expose any application but only resource metrics. For resource metrics, since we use Tensor Parallelism, we think the utilization across GPU are same.

Signed-off-by: Jiaxin Shan <[email protected]>
Signed-off-by: Liguang Xie <[email protected]>
Signed-off-by: Varun Gupta <[email protected]>
Signed-off-by: Liguang Xie <[email protected]>
@xieus xieus force-pushed the xieus/add_install_prerequisites branch from 8950c23 to a599316 Compare March 5, 2025 17:52
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.

10 participants