Files
verl/tests/utils/test_config_on_cpu.py
H d0c7bbbc05 [cfg] refactor: support +extra.any_key usage for the base dataclass config in verl (#2502)
### What does this PR do?

This PR makes update to the base config in verl:
- support +extra.any_key usage for the base config in verl.
- allow selective subfields to be frozen
- add a auto-generated config yaml file
`verl/trainer/config/_generated_ppo_trainer.yaml` for reference purpose,
in case the nested inheritance structure makes the config information
too scattered

### Checklist Before Starting

- [x] Search for similar PRs. Paste at least one query link here: ...
- [x] Format the PR title as `[{modules}] {type}: {description}` (This
will be checked by the CI)
- `{modules}` include `fsdp`, `megatron`, `sglang`, `vllm`, `rollout`,
`trainer`, `ci`, `training_utils`, `recipe`, `hardware`, `deployment`,
`ray`, `worker`, `single_controller`, `misc`, `perf`, `model`, `algo`,
`env`, `tool`, `ckpt`, `doc`, `data`
- If this PR involves multiple modules, separate them with `,` like
`[megatron, fsdp, doc]`
  - `{type}` is in `feat`, `fix`, `refactor`, `chore`, `test`
- If this PR breaks any API (CLI arguments, config, function signature,
etc.), add `[BREAKING]` to the beginning of the title.
  - Example: `[BREAKING][fsdp, megatron] feat: dynamic batching`

### Test

- added frozen field tests

### API and Usage Example

> Demonstrate how the API changes if any, and provide usage example(s)
if possible.

Now you can pass `--xx.profiler.extra.any_new_key=any_plain_value` in
command line to a dataclass inheriting `verl.BaseConfig`. This way we
can still pass dataclass configs inside verl but allow some flexiblity
in accepting new keys from users' adhoc usage.


### Checklist Before Submitting

> [!IMPORTANT]
> Please check all the following items before requesting a review,
otherwise the reviewer might deprioritize this PR for review.

- [x] Read the [Contribute
Guide](https://github.com/volcengine/verl/blob/main/CONTRIBUTING.md).
- [x] Apply [pre-commit
checks](https://github.com/volcengine/verl/blob/main/CONTRIBUTING.md#code-linting-and-formatting):
`pre-commit install && pre-commit run --all-files --show-diff-on-failure
--color=always`
- [ ] Add / Update [the
documentation](https://github.com/volcengine/verl/tree/main/docs).
- [ ] Add unit or end-to-end test(s) to [the CI
workflow](https://github.com/volcengine/verl/tree/main/.github/workflows)
to cover all the code. If not feasible, explain why: ...
- [ ] Once your PR is ready for CI, send a message in [the `ci-request`
channel](https://verl-project.slack.com/archives/C091TCESWB1) in [the
`verl` Slack
workspace](https://join.slack.com/t/verl-project/shared_invite/zt-3855yhg8g-CTkqXu~hKojPCmo7k_yXTQ).

---------

Co-authored-by: Lin <haibin@Lins-Laptop.hsd1.wa.comcast.net>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
2025-07-15 09:06:56 +08:00

96 lines
3.0 KiB
Python

# Copyright 2025 Bytedance Ltd. and/or its affiliates
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import unittest
from dataclasses import dataclass
from omegaconf import OmegaConf
from verl.utils import omega_conf_to_dataclass
@dataclass
class TestDataclass:
hidden_size: int
activation: str
@dataclass
class TestTrainConfig:
batch_size: int
model: TestDataclass
_cfg_str = """train_config:
batch_size: 32
model:
hidden_size: 768
activation: relu"""
class TestConfigOnCPU(unittest.TestCase):
"""Test cases for configuration utilities on CPU.
Test Plan:
1. Test basic OmegaConf to dataclass conversion for simple nested structures
2. Test nested OmegaConf to dataclass conversion for complex hierarchical configurations
3. Verify all configuration values are correctly converted and accessible
"""
def setUp(self):
self.config = OmegaConf.create(_cfg_str)
def test_omega_conf_to_dataclass(self):
sub_cfg = self.config.train_config.model
cfg = omega_conf_to_dataclass(sub_cfg, TestDataclass)
self.assertEqual(cfg.hidden_size, 768)
self.assertEqual(cfg.activation, "relu")
assert isinstance(cfg, TestDataclass)
def test_nested_omega_conf_to_dataclass(self):
cfg = omega_conf_to_dataclass(self.config.train_config, TestTrainConfig)
self.assertEqual(cfg.batch_size, 32)
self.assertEqual(cfg.model.hidden_size, 768)
self.assertEqual(cfg.model.activation, "relu")
assert isinstance(cfg, TestTrainConfig)
assert isinstance(cfg.model, TestDataclass)
class TestPrintCfgCommand(unittest.TestCase):
"""Test suite for the print_cfg.py command-line tool."""
def test_command_with_override(self):
"""Test that the command runs without error when overriding config values."""
import subprocess
# Run the command
result = subprocess.run(
["python3", "scripts/print_cfg.py", "critic.profiler.discrete=True", "+critic.profiler.extra.any_key=val"],
capture_output=True,
text=True,
)
# Verify the command exited successfully
self.assertEqual(result.returncode, 0, f"Command failed with stderr: {result.stderr}")
# Verify the output contains expected config information
self.assertIn("critic", result.stdout)
self.assertIn("profiler", result.stdout)
self.assertIn("discrete=True", result.stdout)
self.assertIn("extra={'any_key': 'val'}", result.stdout)
if __name__ == "__main__":
unittest.main()