[bugfix?] update outdated unittest document#18919
[bugfix?] update outdated unittest document#18919SoluMilken wants to merge 1 commit intosgl-project:mainfrom
Conversation
Summary of ChangesHello @SoluMilken, 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 improves the clarity and accuracy of the unit testing documentation. It updates outdated commands and directory references, making it much easier for new contributors to set up and run tests locally. The changes also reflect the current CI test suite structure and provide more comprehensive guidance for adding and updating tests, ensuring the documentation aligns with the project's evolving test infrastructure. 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. Changelog
Activity
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
Thank you for this contribution! It's great to see you jumping in and improving the documentation for new contributors. Your changes correctly update the testing instructions to reflect the new project structure, which is a big help.
I've added a couple of suggestions to make the command examples even more user-friendly by making them self-contained.
To answer your questions:
- Which tests to run locally? The
stage-b-test-small-1-gpusuite you've added is a great example for a local run. Generally, any of thePer-Commit (CUDA)suites with1-gpuare good candidates. The larger multi-GPU suites (e.g.,stage-c-*) are usually best left for CI due to resource requirements. - Which tests for CI? All suites listed under "Available Suites" are run in CI. The per-commit suites run on every PR, while the nightly suites run, as the name suggests, on a schedule.
- Test directory structure: Yes, as you've correctly identified, the structure has changed. Tests for CI are now under
test/registered/and are managed by the CI registry system described in the README.test/manual/is for tests that are not part of the automated CI. Your updates to the README accurately reflect this new structure.
Overall, this is a valuable improvement. Well done!
c4656ed to
82ee519
Compare
Motivation
As a newcomer trying to contribute to this repo, I carefully studied how to run the unit tests. However, the commands in the README resulted in path not found errors. After investigating the current test structure, it seems like tests have been reorganized—new tests are now under
test/registered/, andtest/srt/appears to be deprecated.I did my best to update the commands to reflect the current structure. Please let me know if anything is incorrect!
If possible, I'd appreciate some guidance from maintainers:
Modifications
Accuracy Tests
X
Benchmarking and Profiling
X
Checklist
Review Process
/tag-run-ci-label,/rerun-failed-ci,/tag-and-rerun-ci