Skip to content

Conversation

@chenyushuo
Copy link
Collaborator

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.

  • Code has passed all tests
  • Docstrings have been added/updated in Google Style
  • Documentation has been updated
  • Code is ready for review

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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.py to centralize and standardize the naming of these critical environment variables.
  • Updated Test Utilities: Refactored test utility functions in tests/tools.py to 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/ with openai/gsm8k and adding subset_name where 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

  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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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.

@chenyushuo
Copy link
Collaborator Author

/unittest-module-common

@github-actions
Copy link

Summary

Tests 📝 Passed ✅ Failed ❌ Skipped ⏭️ Other ❓ Flaky 🍂 Duration ⏱️
32 32 0 0 0 0 369ms

Tests

Test Name Status Flaky Duration
tests/common/config_test.py::TestConfig::test_all_examples_are_valid 11ms
tests/common/config_test.py::TestConfig::test_config_flatten 1ms
tests/common/config_test.py::TestConfig::test_continue_from_checkpoint_is_valid 1ms
tests/common/config_test.py::TestConfig::test_load_default_config 4ms
tests/common/experience_test.py::TestEID::test_eid_properties 1ms
tests/common/experience_test.py::TestExperience::test_action_mask_and_logprobs_type 1ms
tests/common/experience_test.py::TestExperience::test_assertions 1ms
tests/common/experience_test.py::TestExperience::test_dpo_experience 1ms
tests/common/experience_test.py::TestExperience::test_gather 1ms
tests/common/experience_test.py::TestExperience::test_hf_datasets_conversion 1ms
tests/common/experience_test.py::TestExperience::test_multi_turn_experience 1ms
tests/common/experience_test.py::TestExperience::test_serialize_deserialize 1ms
tests/common/experience_test.py::TestExperience::test_single_turn_experience 1ms
tests/common/experience_test.py::TestExperience::test_to_dict 1ms
tests/common/experience_test.py::TestExperienceConversion::test_batch_conversion 1ms
tests/common/experience_test.py::TestExperienceConversion::test_dpo_experience_batch_conversion 1ms
tests/common/experience_test.py::TestExperienceConversion::test_experience_model_experience_conversion 1ms
tests/common/experience_test.py::TestExperienceConversion::test_gather_experiences_with_custom_fields 1ms
tests/common/experience_test.py::TestExperienceConversion::test_multiturn_experience_batch_converstion 1ms
tests/common/vllm_test.py::ModelWrapperTest_0::test_generate 38ms
tests/common/vllm_test.py::ModelWrapperTest_1::test_generate 16ms
tests/common/vllm_test.py::ModelWrapperTest_2::test_generate 16ms
tests/common/vllm_test.py::ModelWrapperTest_3::test_generate 54ms
tests/common/vllm_test.py::ModelWrapperTest_4::test_generate 49ms
tests/common/vllm_test.py::ModelWrapperTest_5::test_generate 36ms
tests/common/vllm_test.py::ModelWrapperTest_6::test_generate 46ms
tests/common/vllm_test.py::TestAPIServer::test_api 24ms
tests/common/vllm_test.py::TestAsyncAPIServer::test_api_async 24ms
tests/common/vllm_test.py::TestTokenizer::test_action_mask 1ms
tests/common/vllm_test.py::TestTokenizer::test_action_mask_with_tools 1ms
tests/common/vllm_test.py::TestAPIServerToolCall_0_deepseek_r1::test_api_tool_calls 22ms
tests/common/vllm_test.py::TestAPIServerToolCall_1::test_api_tool_calls 20ms

Github Test Reporter by CTRF 💚

@chenyushuo chenyushuo requested a review from pan-x-c September 10, 2025 11:35
@chenyushuo
Copy link
Collaborator Author

/unittest-all

@github-actions
Copy link

Summary

Tests 📝 Passed ✅ Failed ❌ Skipped ⏭️ Other ❓ Flaky 🍂 Duration ⏱️
143 142 0 1 0 0 2.6s

Skipped

Tests Status
tests/trainer/trainer_test.py::TestTrainerMultiModal::test_trainer skipped ⏭️

Tests

Test Name Status Flaky Duration
tests/algorithm/advantage_fn_test.py::TestGroupedAdvantageFn::test_duplicate_grpo 1ms
tests/algorithm/advantage_fn_test.py::TestGroupedAdvantageFn::test_grpo_advantage 1ms
tests/algorithm/advantage_fn_test.py::TestGroupedAdvantageFn::test_grpo_correct_bias 1ms
tests/algorithm/advantage_fn_test.py::TestGroupedAdvantageFn::test_grpo_reward_std 1ms
tests/algorithm/advantage_fn_test.py::TestGroupedAdvantageFn::test_step_wise_grpo_advantage 1ms
tests/algorithm/policy_loss_test.py::VerlPolicyLossTest::test_dpo_policy_loss 1ms
tests/algorithm/policy_loss_test.py::VerlPolicyLossTest::test_gspo_policy_loss 1ms
tests/algorithm/policy_loss_test.py::VerlPolicyLossTest::test_mix_policy_loss 1ms
tests/algorithm/policy_loss_test.py::VerlPolicyLossTest::test_opmd_policy_loss 1ms
tests/algorithm/policy_loss_test.py::VerlPolicyLossTest::test_ppo_policy_loss 1ms
tests/algorithm/policy_loss_test.py::VerlPolicyLossTest::test_sft_policy_loss 1ms
tests/buffer/experience_pipeline_test.py::TestExperiencePipeline::test_experience_pipeline 11ms
tests/buffer/experience_storage_test.py::ExperienceStorageTest::test_sql_experience_buffer 2ms
tests/buffer/experience_storage_test.py::ExperienceStorageTest::test_sql_storage_0_sft 4ms
tests/buffer/experience_storage_test.py::ExperienceStorageTest::test_sql_storage_1_dpo 5ms
tests/buffer/file_test.py::TestFileBuffer::test_file_reader 1ms
tests/buffer/file_test.py::TestFileBuffer::test_file_writer 2ms
tests/buffer/formatter_test.py::TestFormatter::test_dpo_messages_formatter 1ms
tests/buffer/formatter_test.py::TestFormatter::test_dpo_plaintext_formatter 1ms
tests/buffer/formatter_test.py::TestFormatter::test_sft_messages_formatter 1ms
tests/buffer/formatter_test.py::TestFormatter::test_sft_plaintext_formatter 1ms
tests/buffer/formatter_test.py::TestFormatter::test_task_formatter 1ms
tests/buffer/queue_test.py::TestQueueBuffer::test_priority_queue_buffer_reuse 7ms
tests/buffer/queue_test.py::TestQueueBuffer::test_priority_queue_capacity 3ms
tests/buffer/queue_test.py::TestQueueBuffer::test_queue_buffer_0_queue 4ms
tests/buffer/queue_test.py::TestQueueBuffer::test_queue_buffer_1_priority_queue 4ms
tests/buffer/queue_test.py::TestQueueBuffer::test_queue_buffer_capacity 4ms
tests/buffer/reward_shaping_mapper_test.py::TestRewardShapingMapper::test_basic_usage 1ms
tests/buffer/sql_test.py::TestSQLBuffer::test_sql_buffer_read_write 3ms
tests/buffer/task_storage_test.py::TaskStorageTest::test_read_task_0 1ms
tests/buffer/task_storage_test.py::TaskStorageTest::test_read_task_1 3ms
tests/buffer/task_storage_test.py::TaskStorageTest::test_read_task_2 1ms
tests/buffer/task_storage_test.py::TaskStorageTest::test_read_task_3 3ms
tests/buffer/task_storage_test.py::TaskStorageTest::test_read_task_4 1ms
tests/buffer/task_storage_test.py::TaskStorageTest::test_read_task_5 3ms
tests/cli/launcher_test.py::TestLauncherMain::test_main_run_command 1ms
tests/cli/launcher_test.py::TestLauncherMain::test_main_run_in_dlc 1ms
tests/cli/launcher_test.py::TestLauncherMain::test_main_studio_command 1ms
tests/common/config_test.py::TestConfig::test_all_examples_are_valid 10ms
tests/common/config_test.py::TestConfig::test_config_flatten 1ms
tests/common/config_test.py::TestConfig::test_continue_from_checkpoint_is_valid 1ms
tests/common/config_test.py::TestConfig::test_load_default_config 4ms
tests/common/experience_test.py::TestEID::test_eid_properties 1ms
tests/common/experience_test.py::TestExperience::test_action_mask_and_logprobs_type 1ms
tests/common/experience_test.py::TestExperience::test_assertions 1ms
tests/common/experience_test.py::TestExperience::test_dpo_experience 1ms
tests/common/experience_test.py::TestExperience::test_gather 1ms
tests/common/experience_test.py::TestExperience::test_hf_datasets_conversion 1ms
tests/common/experience_test.py::TestExperience::test_multi_turn_experience 1ms
tests/common/experience_test.py::TestExperience::test_serialize_deserialize 1ms
tests/common/experience_test.py::TestExperience::test_single_turn_experience 1ms
tests/common/experience_test.py::TestExperience::test_to_dict 1ms
tests/common/experience_test.py::TestExperienceConversion::test_batch_conversion 1ms
tests/common/experience_test.py::TestExperienceConversion::test_dpo_experience_batch_conversion 1ms
tests/common/experience_test.py::TestExperienceConversion::test_experience_model_experience_conversion 1ms
tests/common/experience_test.py::TestExperienceConversion::test_gather_experiences_with_custom_fields 1ms
tests/common/experience_test.py::TestExperienceConversion::test_multiturn_experience_batch_converstion 1ms
tests/common/vllm_test.py::ModelWrapperTest_0::test_generate 39ms
tests/common/vllm_test.py::ModelWrapperTest_1::test_generate 17ms
tests/common/vllm_test.py::ModelWrapperTest_2::test_generate 16ms
tests/common/vllm_test.py::ModelWrapperTest_3::test_generate 53ms
tests/common/vllm_test.py::ModelWrapperTest_4::test_generate 50ms
tests/common/vllm_test.py::ModelWrapperTest_5::test_generate 37ms
tests/common/vllm_test.py::ModelWrapperTest_6::test_generate 47ms
tests/common/vllm_test.py::TestAPIServer::test_api 24ms
tests/common/vllm_test.py::TestAsyncAPIServer::test_api_async 23ms
tests/common/vllm_test.py::TestTokenizer::test_action_mask 1ms
tests/common/vllm_test.py::TestTokenizer::test_action_mask_with_tools 1ms
tests/common/vllm_test.py::TestAPIServerToolCall_0_deepseek_r1::test_api_tool_calls 21ms
tests/common/vllm_test.py::TestAPIServerToolCall_1::test_api_tool_calls 20ms
tests/explorer/explorer_test.py::BaseExplorerCase::test_explorer 1ms
tests/explorer/explorer_test.py::TestExplorerCountdownEval::test_explorer 58ms
tests/explorer/explorer_test.py::TestExplorerCountdownNoEval::test_explorer 54ms
tests/explorer/explorer_test.py::TestExplorerGSM8k::test_explorer 200ms
tests/explorer/scheduler_test.py::SchedulerTest::test_async_workflow 4ms
tests/explorer/scheduler_test.py::SchedulerTest::test_concurrent_operations 4ms
tests/explorer/scheduler_test.py::SchedulerTest::test_get_results 19ms
tests/explorer/scheduler_test.py::SchedulerTest::test_multi_step_execution 4ms
tests/explorer/scheduler_test.py::SchedulerTest::test_non_repeatable_workflow 4ms
tests/explorer/scheduler_test.py::SchedulerTest::test_scheduler_all_methods 14ms
tests/explorer/scheduler_test.py::SchedulerTest::test_scheduler_restart_after_stop 7ms
tests/explorer/scheduler_test.py::SchedulerTest::test_split_tasks 7ms
tests/explorer/scheduler_test.py::SchedulerTest::test_stepwise_experience_eid 4ms
tests/explorer/scheduler_test.py::SchedulerTest::test_wait_all 7ms
tests/explorer/scheduler_test.py::SchedulerTest::test_wait_all_timeout_with_multi_batch 13ms
tests/explorer/step_wise_workflow_test.py::WorkflowTest::test_reward_propagation_workflow 1ms
tests/explorer/step_wise_workflow_test.py::WorkflowTest::test_step_wise_reward_workflow 1ms
tests/explorer/step_wise_workflow_test.py::WorkflowTest::test_workflows_raise_error 1ms
tests/explorer/step_wise_workflow_test.py::WorkflowTest::test_workflows_stop_at_max_env_steps 1ms
tests/explorer/workflow_test.py::WorkflowTest::test_gsm8k_workflow 1ms
tests/explorer/workflow_test.py::WorkflowTest::test_math_boxed_workflow 1ms
tests/explorer/workflow_test.py::WorkflowTest::test_math_complex_workflow 1ms
tests/explorer/workflow_test.py::WorkflowTest::test_math_eval_workflow 1ms
tests/explorer/workflow_test.py::WorkflowTest::test_math_fraction_workflow 1ms
tests/explorer/workflow_test.py::WorkflowTest::test_math_workflow 1ms
tests/explorer/workflow_test.py::WorkflowTest::test_rm_gallery_workflow 1ms
tests/explorer/workflow_test.py::WorkflowTest::test_workflow_repeatable 1ms
tests/explorer/workflow_test.py::WorkflowTest::test_workflow_resettable 1ms
tests/manager/synchronizer_test.py::TestSynchronizerExit::test_synchronizer 28ms
tests/manager/synchronizer_test.py::TestStateDictBasedSynchronizer_0::test_synchronizer 59ms
tests/manager/synchronizer_test.py::TestStateDictBasedSynchronizer_1::test_synchronizer 65ms
tests/manager/synchronizer_test.py::TestStateDictBasedSynchronizer_2::test_synchronizer 95ms
tests/manager/synchronizer_test.py::TestStateDictBasedSynchronizer_3::test_synchronizer 84ms
tests/manager/synchronizer_test.py::TestNCCLBasedSynchronizer_0::test_synchronizer 51ms
tests/manager/synchronizer_test.py::TestNCCLBasedSynchronizer_1::test_synchronizer 52ms
tests/service/data_juicer_test.py::TestDataJuicer::test_config 1ms
tests/service/data_juicer_test.py::TestDataJuicer::test_server_start 22ms
tests/service/data_juicer_test.py::TestDataJuicerExperiencePipeline::test_data_juicer_operators 21ms
tests/service/data_juicer_test.py::TestDataJuicerTaskPipeline::test_data_juicer_task_pipeline 14ms
tests/trainer/trainer_test.py::TestTrainerCountdown_0_fsdp::test_trainer 130ms
tests/trainer/trainer_test.py::TestTrainerCountdown_1_megatron::test_trainer 317ms
tests/trainer/trainer_test.py::TestStepAheadAsyncRL::test_trainer 50ms
tests/trainer/trainer_test.py::TestTrainerGSM8K_0_fsdp::test_trainer 48ms
tests/trainer/trainer_test.py::TestTrainerGSM8K_1_fsdp2::test_trainer 47ms
tests/trainer/trainer_test.py::TestTrainerGSM8K_2_fsdp::test_trainer 46ms
tests/trainer/trainer_test.py::TestTrainerGSM8K_3_fsdp2::test_trainer 55ms
tests/trainer/trainer_test.py::TestTrainerSFTWarmupGSM8K::test_trainer 54ms
tests/trainer/trainer_test.py::TestTrainerDPO::test_trainer 32ms
tests/trainer/trainer_test.py::TestTrainerSFT::test_trainer 30ms
tests/trainer/trainer_test.py::TestTrainerToolsSFT::test_trainer_tools 30ms
tests/trainer/trainer_test.py::TestFullyAsyncMode_0_fsdp::test_fully_async_mode 67ms
tests/trainer/trainer_test.py::TestFullyAsyncMode_1_fsdp::test_fully_async_mode 65ms
tests/trainer/trainer_test.py::TestFullyAsyncMode_2_megatron::test_fully_async_mode 160ms
tests/trainer/trainer_test.py::TestTrainerMIX::test_trainer 57ms
tests/trainer/trainer_test.py::TestTrainerMultiModal::test_trainer ⏭️ 1ms
tests/utils/eval_utils_test.py::TestComputeScore::test_both_boxed_and_equivalent 1ms
tests/utils/eval_utils_test.py::TestComputeScore::test_both_boxed_and_not_equivalent 1ms
tests/utils/eval_utils_test.py::TestComputeScore::test_empty_ground_truth 1ms
tests/utils/eval_utils_test.py::TestComputeScore::test_empty_solution_string 1ms
tests/utils/eval_utils_test.py::TestComputeScore::test_multiple_boxed_answers_in_solution 1ms
tests/utils/eval_utils_test.py::TestComputeScore::test_solution_boxed_truth_raw_and_equivalent 1ms
tests/utils/eval_utils_test.py::TestComputeScore::test_solution_boxed_truth_raw_and_not_equivalent 1ms
tests/utils/eval_utils_test.py::TestComputeScore::test_solution_not_boxed 1ms
tests/utils/eval_utils_test.py::TestComputeScore::test_solution_raw_and_ground_truth_boxed_equivalent 1ms
tests/utils/eval_utils_test.py::TestMathEvalUtils::test_extract_answer 1ms
tests/utils/eval_utils_test.py::TestMathEvalUtils::test_verify_math_answer 1ms
tests/utils/eval_utils_test.py::TestEvalUtils::test_is_equiv 1ms
tests/utils/log_test.py::LogTest::test_actor_log 2ms
tests/utils/log_test.py::LogTest::test_group_by_node 2ms
tests/utils/log_test.py::LogTest::test_no_actor_log 1ms
tests/utils/plugin_test.py::TestPluginLoader::test_load_plugins_local 1ms
tests/utils/plugin_test.py::TestPluginLoader::test_load_plugins_remote 6ms
tests/utils/plugin_test.py::TestPluginLoader::test_passing_custom_class 3ms

Github Test Reporter by CTRF 💚

@pan-x-c pan-x-c merged commit 3b00dc9 into modelscope:main Sep 10, 2025
2 checks passed
yaochaorui pushed a commit to yaochaorui/Trinity-RFT that referenced this pull request Sep 19, 2025
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.

Reference environment variables from Trinity config

2 participants