-
Notifications
You must be signed in to change notification settings - Fork 47
Replace /PATH/TO to ${oc.env:TRINITY_XXX}
#267
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @chenyushuo, 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 focuses on improving the configurability and ease of use of the project by abstracting file paths into environment variables. By leveraging OmegaConf's environment variable resolution, users can now define critical paths for models, checkpoints, and datasets externally, eliminating the need for direct modifications within configuration files. This change streamlines setup processes and enhances the adaptability of the project across diverse deployment environments.
Highlights
- Standardized Path Configuration: Replaced hardcoded file paths (e.g., /PATH/TO/MODEL/) in numerous configuration and example YAML files with OmegaConf environment variable references (e.g., ${oc.env:TRINITY_MODEL_PATH,default_value}). This significantly improves configuration flexibility and portability.
- New Environment Variable Constants: Introduced a set of new environment variable constants (e.g., TRINITY_CHECKPOINT_ROOT_DIR, TRINITY_MODEL_PATH, TRINITY_TASKSET_PATH) in
trinity/common/constants.pyto centralize and standardize the naming of these critical environment variables. - Updated Test Utilities: Refactored test utility functions in
tests/tools.pyto utilize the newly defined environment variable constants, ensuring consistency and maintainability across the codebase. - Dataset Path Refinements: Updated specific dataset paths in several examples, such as replacing generic
/PATH/TO/DATASET/withopenai/gsm8kand addingsubset_namewhere applicable, providing more concrete examples for users.
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. 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
-
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.
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 introduces a significant and valuable refactoring by replacing hardcoded /PATH/TO/... placeholders with environment variable lookups (${oc.env:TRINITY_...}) across numerous documentation and example configuration files. This change greatly enhances the portability and usability of the examples. Furthermore, the PR centralizes environment variable names into constants within trinity/common/constants.py and refactors the test suite and benchmark scripts to use them, which is an excellent improvement for code maintainability and consistency. The changes are well-executed and systematically applied. Overall, this is a high-quality contribution that improves the project's developer experience.
|
/unittest-module-common |
Summary
Tests
Github Test Reporter by CTRF 💚 |
|
/unittest-all |
Summary
Skipped
Tests
Github Test Reporter by CTRF 💚 |
Description
As the title says, this pr is proposed to resolve #228 .
Checklist
Please check the following items before code is ready to be reviewed.