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

[Docs] Update GPU Optimizer documentation #622

Merged
merged 76 commits into from
Feb 1, 2025
Merged

Conversation

zhangjyr
Copy link
Collaborator

@zhangjyr zhangjyr commented Jan 31, 2025

Pull Request Description

Update documentation for GPU Optimizer as requested.
Some configurations have been changed for a more generic purpose.

Address part of #613

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.

@zhangjyr zhangjyr requested review from Jeffwan and nwangfw January 31, 2025 07:55
Fix benchmark and gen_profile to work inside python module.
@Jeffwan
Copy link
Collaborator

Jeffwan commented Jan 31, 2025

image

are these file required? We will cut v0.2.0 pretty soon and we can just ask user to install official tools.

@zhangjyr
Copy link
Collaborator Author

Deleted, sorry

@zhangjyr zhangjyr requested a review from Jeffwan January 31, 2025 21:54
@Jeffwan
Copy link
Collaborator

Jeffwan commented Jan 31, 2025

I suggest to use simple render yamls for users. For dev workloads, it should be good to consider resubility. for sample, we just need ready to use yamls. like deployment-a10.yaml autoscaler-a10.yaml etc. no need to put many template folders which may confuse user.

I will make some minor changes to this branch to simplify the setups.

@nwangfw nwangfw force-pushed the jingyuan/gpu_optimizer branch from 7b96101 to a50ebcd Compare February 1, 2025 00:18
@nwangfw nwangfw force-pushed the jingyuan/gpu_optimizer branch from a50ebcd to 31a95e3 Compare February 1, 2025 00:51
Copy link
Collaborator

@Jeffwan Jeffwan left a comment

Choose a reason for hiding this comment

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

Now it looks good to me.

@Jeffwan Jeffwan merged commit 5ebed5e into main Feb 1, 2025
10 checks passed
@Jeffwan Jeffwan deleted the jingyuan/gpu_optimizer branch February 1, 2025 01:57
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.

3 participants