docs: update quickstart instructions to use (or include) cli option#291
docs: update quickstart instructions to use (or include) cli option#291jpfbastos wants to merge 8 commits into
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @jpfbastos, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request updates the quickstart documentation to align with the recent introduction of the sllm-store command-line interface. The primary goal is to streamline the user experience by promoting the use of the CLI for model saving and loading operations, moving away from older, script-based instructions.
Highlights
- Documentation Enhancement: Added a new tip in the main quickstart guide (
quickstart.md) to inform users about thesllm-storeCLI as an alternative for performing quickstart steps, promoting a simpler setup. - CLI Adoption in Examples: Updated the ROCm-specific quickstart guide (
rocm_quickstart.md) to replace direct Python script calls for saving and loading Transformer and vLLM models with the more concise and integratedsllm-storeCLI commands.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request updates the quickstart documentation to guide users towards using the sllm-store command-line interface, which is a positive change for user experience. I've suggested a minor wording improvement in quickstart.md and added comments to the commands in rocm_quickstart.md to enhance clarity.
|
Not entirely sure how to feel about two tip blocks one below the other - should I put it at the end instead? The only reason I am reluctant to is that I want to offer people both options before they commit to following a set of instructions |
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
…s/ServerlessLLM into jp/update_docs_with_cli
1 participant
Description
Change the save and load instruction commands on rocm_quickstart.md, and suggest it on quickstart.md
Motivation
As the CLI now supports model saving and loading, use that instead of the example script
Type of Change
Checklist