[Docs, Dependencies] Docs update and add pynvml dependencies

[Wangmerlyn]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @Wangmerlyn, I'm Gemini Code Assist¹! 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 focuses on improving the project's documentation and updating its dependencies. It adds a new required library for GPU interaction and enhances the clarity and completeness of the project's public-facing information, particularly regarding contributions and API usage.

Highlights

• Dependency Management: Added pynvml to the project's core dependencies, likely enabling more direct NVIDIA GPU monitoring capabilities.
• Documentation Enhancement: Updated the README.md to include clearer contribution guidelines, a call for ROCm GPU support, and a dynamic contributors section.
• API Documentation Expansion: Configured the API documentation to automatically include details for single_gpu_controller and global_gpu_controller modules.

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

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]

Code Review

This pull request updates the project's documentation and adds pynvml as a dependency. The changes are beneficial, and I've offered a few suggestions to enhance them further. My feedback includes a fix for a potential issue in the API documentation generation, and a recommendation to sort project dependencies for better maintainability.

[gemini-code-assist]

To improve maintainability and make it easier to see what dependencies are included, it's a good practice to keep the list of dependencies sorted alphabetically.

  "colorlog",
  "pynvml",
  "torch",
  "typer",