Skip to content

[Docs] Add example usage cases - #38

Merged
Wangmerlyn merged 6 commits into
mainfrom
docs/example-usage
Jul 21, 2025
Merged

[Docs] Add example usage cases#38
Wangmerlyn merged 6 commits into
mainfrom
docs/example-usage

Conversation

@Wangmerlyn

Copy link
Copy Markdown
Owner

No description provided.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Summary of Changes

Hello @Wangmerlyn, 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 aims to significantly enhance the keep-gpu project's documentation by providing detailed usage examples. It clarifies how to use the keep-gpu tool both from the command line and programmatically via its Python API, making it easier for users to understand and integrate the library into their workflows.

Highlights

  • Documentation Enhancement: Expanded the README.md to include more comprehensive usage examples for the keep-gpu library.
  • CLI Usage Examples: Added a dedicated sub-section demonstrating how to use keep-gpu as a command-line tool.
  • API Usage Examples: Introduced new examples showcasing the programmatic use of the CudaGPUController for managing GPU occupation, including non-blocking and context manager patterns.
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 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 or fill out our survey 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

  1. 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.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request adds usage examples for both the CLI and the Python API to the README.md. The new documentation is well-structured and improves usability. However, the Python API examples contain incorrect import paths and a wrong method name, which would prevent them from running correctly. I've provided suggestions to fix these issues.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Wangmerlyn and others added 5 commits July 22, 2025 01:45
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>
@Wangmerlyn
Wangmerlyn merged commit 6abeb90 into main Jul 21, 2025
2 checks passed
@Wangmerlyn
Wangmerlyn deleted the docs/example-usage branch July 22, 2025 07:34
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.

1 participant