Update test README with CI registry documentation and 5090/H100 guidance#17368
Update test README with CI registry documentation and 5090/H100 guidance#17368Kangyan-Zhou merged 1 commit intomainfrom
Conversation
- Expand CI Registry section with registration function examples - Add guidance for choosing between 1-GPU suites (5090 vs H100) - Document when to use stage-b-test-small-1-gpu (5090) vs stage-b-test-large-1-gpu (H100) - List available per-commit and nightly suites - Add run_suite.py usage examples
Summary of ChangesHello @alisonshao, 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 significantly enhances the documentation for the CI testing system by providing clearer guidelines and examples for test registration, suite selection, and execution. The updates aim to improve developer understanding of the testing infrastructure, particularly regarding GPU hardware choices for 1-GPU tests and the various available test suites, ensuring more efficient and appropriate test configuration. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe 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 by creating a comment using either
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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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
|
There was a problem hiding this comment.
Code Review
This pull request significantly improves the test documentation by adding detailed guidance on the CI registry system, criteria for selecting GPU suites (5090 vs. H100), and usage examples for run_suite.py. The changes are clear, well-structured, and will be very helpful for developers. I have a couple of minor suggestions to further enhance clarity and maintainability.
| - `stage-a-test-1`, `stage-b-test-small-1-gpu-amd`, `stage-b-test-large-2-gpu-amd` | ||
|
|
||
| **Nightly**: | ||
| - `nightly-1-gpu`, `nightly-2-gpu`, `nightly-4-gpu`, `nightly-8-gpu`, etc. |
There was a problem hiding this comment.
The use of "etc." is a bit vague and can become outdated. To improve maintainability and provide a single source of truth, consider removing "etc." and adding a note that directs users to the NIGHTLY_SUITES dictionary in test/run_suite.py for the complete and up-to-date list.
| - `nightly-1-gpu`, `nightly-2-gpu`, `nightly-4-gpu`, `nightly-8-gpu`, etc. | |
| - `nightly-1-gpu`, `nightly-2-gpu`, `nightly-4-gpu`, `nightly-8-gpu`, and more. See `test/run_suite.py` for the full list. |
| # Run per-commit tests | ||
| python test/run_suite.py --hw cuda --suite stage-b-test-small-1-gpu | ||
|
|
||
| # Run nightly tests |
There was a problem hiding this comment.
The comments in these examples are a bit too general. For instance, # Run per-commit tests is used for a command that runs a specific suite, not all of them. Making the comments more specific would improve clarity for developers using these examples.
| # Run per-commit tests | |
| python test/run_suite.py --hw cuda --suite stage-b-test-small-1-gpu | |
| # Run nightly tests | |
| # Run a specific per-commit suite | |
| python test/run_suite.py --hw cuda --suite stage-b-test-small-1-gpu | |
| # Run a specific nightly suite |
Summary
stage-b-test-small-1-gpu(5090) vsstage-b-test-large-1-gpu(H100)run_suite.pyusage examples with auto-partitioningTest plan