backward compat namespace move

tests/test_base_config_on_cpu.py

@@ -0,0 +1,42 @@
+# Copyright 2024 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 pytest
+
+from verl.base_config import BaseConfig
+
+
+@pytest.fixture
+def base_config_mock():
+    """Fixture to create a mock BaseConfig instance with test attributes."""
+    mock_config = BaseConfig()
+    mock_config.test_attr = "test_value"
+    return mock_config
+
+
+def test_getitem_success(base_config_mock):
+    """Test __getitem__ with existing attribute (happy path)."""
+    assert base_config_mock["test_attr"] == "test_value"
+
+
+def test_getitem_nonexistent_attribute(base_config_mock):
+    """Test __getitem__ with non-existent attribute (exception path 1)."""
+    with pytest.raises(AttributeError):
+        _ = base_config_mock["nonexistent_attr"]
+
+
+def test_getitem_invalid_key_type(base_config_mock):
+    """Test __getitem__ with invalid key type (exception path 2)."""
+    with pytest.raises(TypeError):
+        _ = base_config_mock[123]  # type: ignore

tests/utils/test_nvtx_profile.py

@@ -115,10 +115,14 @@ def test_config_init(self):
             self.assertEqual(profiler_config.ranks, config.ranks)
             assert isinstance(profiler_config, ProfilerConfig)
             with self.assertRaises(AttributeError):
-                profiler_config.non_existing_key
-            assert config.get('non_existing_key') == profiler_config.get('non_existing_key')
-            assert config.get('non_existing_key', 1) == profiler_config.get('non_existing_key', 1)
-            assert config['discrete'] == profiler_config['discrete']
+                _ = profiler_config.non_existing_key
+            assert config.get("non_existing_key") == profiler_config.get("non_existing_key")
+            assert config.get("non_existing_key", 1) == profiler_config.get("non_existing_key", 1)
+            assert config["discrete"] == profiler_config["discrete"]
+            from dataclasses import FrozenInstanceError
+
+            with self.assertRaises(FrozenInstanceError):
+                profiler_config.discrete = False
 
 
 if __name__ == "__main__":

verl/base_config.py

@@ -13,23 +13,62 @@
 # limitations under the License.
 
 import collections
-from dataclasses import asdict
+from dataclasses import fields  # Import the fields function to inspect dataclass fields
+from typing import Any
 
 
+# BaseConfig class inherits from collections.abc.Mapping, which means it can act like a dictionary
 class BaseConfig(collections.abc.Mapping):
+    """The BaseConfig provides omegaconf DictConfig-like interface for a dataclass config.
 
-    def get(self, key, default=None):
+    The BaseConfig class implements the Mapping Abstract Base Class.
+    This allows instances of this class to be used like dictionaries.
+    """
+
+    def get(self, key: str, default: Any = None):
+        """Get the value associated with the given key. If the key does not exist, return the default value.
+
+        Args:
+            key (str): The attribute name to retrieve.
+            default (Any, optional): The value to return if the attribute does not exist. Defaults to None.
+
+        Returns:
+            Any: The value of the attribute or the default value.
+        """
         try:
             return getattr(self, key)
-        except AttributeError as e:
+        except AttributeError:
             return default
 
-    def __getitem__(self, key):
+    def __getitem__(self, key: str):
+        """Implement the [] operator for the class. Allows accessing attributes like dictionary items.
+
+        Args:
+            key (str): The attribute name to retrieve.
+
+        Returns:
+            Any: The value of the attribute.
+
+        Raises:
+            AttributeError: If the attribute does not exist.
+            TypeError: If the key type is not string
+        """
         return getattr(self, key)
 
     def __iter__(self):
+        """Implement the iterator protocol. Allows iterating over the attribute names of the instance.
+
+        Yields:
+            str: The name of each field in the dataclass.
+        """
         for f in fields(self):
             yield f.name
 
     def __len__(self):
+        """
+        Return the number of fields in the dataclass.
+
+        Returns:
+            int: The number of fields in the dataclass.
+        """
         return len(fields(self))

verl/utils/debug/__init__.py

@@ -12,15 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from ..import_utils import is_nvtx_available
-from .performance import GPUMemoryLogger, log_gpu_memory_usage, log_print, simple_timer
-from .profile import DistProfilerExtension, ProfilerConfig
-
-if is_nvtx_available():
-    from .nvtx_profile import NsightSystemsProfiler as DistProfiler
-    from .nvtx_profile import mark_annotate, mark_end_range, mark_start_range, marked_timer
-else:
-    from .performance import marked_timer
-    from .profile import DistProfiler, mark_annotate, mark_end_range, mark_start_range
-
-__all__ = ["GPUMemoryLogger", "log_gpu_memory_usage", "log_print", "mark_start_range", "mark_end_range", "mark_annotate", "DistProfiler", "DistProfilerExtension", "ProfilerConfig", "simple_timer", "marked_timer"]
+# APIs kept for backward compatibility purpose
+# For new features please develop in verl/utils/profiler/
+from ..profiler import *  # noqa

verl/utils/profiler/__init__.py

@@ -0,0 +1,26 @@
+# Copyright 2024 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.
+
+from ..import_utils import is_nvtx_available
+from .performance import GPUMemoryLogger, log_gpu_memory_usage, simple_timer
+from .profile import DistProfilerExtension, ProfilerConfig
+
+if is_nvtx_available():
+    from .nvtx_profile import NsightSystemsProfiler as DistProfiler
+    from .nvtx_profile import mark_annotate, mark_end_range, mark_start_range, marked_timer
+else:
+    from .performance import marked_timer
+    from .profile import DistProfiler, mark_annotate, mark_end_range, mark_start_range
+
+__all__ = ["GPUMemoryLogger", "log_gpu_memory_usage", "mark_start_range", "mark_end_range", "mark_annotate", "DistProfiler", "DistProfilerExtension", "ProfilerConfig", "simple_timer", "marked_timer"]

verl/utils/profiler/config.py

@@ -0,0 +1,49 @@
+# Copyright 2024 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.
+
+from dataclasses import dataclass, field
+
+from verl.base_config import BaseConfig
+
+
+@dataclass(frozen=True)
+class ProfilerConfig(BaseConfig):
+    """Worker profiler config. Currently only support Nsight system profiler."""
+
+    # True for each task has its own database, False for all tasks in one training step share one database.
+    discrete: bool = False
+
+    # Whether to profile all ranks.
+    all_ranks: bool = False
+
+    # The ranks that will be profiled. [] or [0,1,...]
+    ranks: list[int] = field(default_factory=list)
+
+    def union(self, other: "ProfilerConfig") -> "ProfilerConfig":
+        return ProfilerConfig(
+            all_ranks=self.all_ranks or other.all_ranks,
+            ranks=list(set(self.ranks or []) | set(other.ranks or [])),
+            discrete=self.discrete or other.discrete,
+        )
+
+    def intersect(self, other: "ProfilerConfig") -> "ProfilerConfig":
+        return ProfilerConfig(
+            all_ranks=self.all_ranks and other.all_ranks,
+            ranks=list(set(self.ranks or []) & set(other.ranks or [])),
+            discrete=self.discrete and other.discrete,
+        )
+
+    def __post_init__(self) -> None:
+        """config validation logics go here"""
+        assert isinstance(self.ranks, (set, list, tuple))

verl/workers/megatron_workers.py

@@ -20,7 +20,7 @@
 import os
 import time
 import warnings
-from typing import Union
+from typing import Optional, Union
 
 import torch
 import torch.distributed
@@ -335,8 +335,6 @@ def init_model(self):
 
             importlib.import_module(self.config.model.external_lib)
 
-        from omegaconf import OmegaConf
-
         from verl.utils.torch_dtypes import PrecisionType
 
         override_model_config = OmegaConf.to_container(self.config.model.get("override_config", OmegaConf.create()))
@@ -720,7 +718,6 @@ def megatron_critic_model_provider(pre_process, post_process):
     @register(dispatch_mode=Dispatch.ONE_TO_ALL)
     def init_model(self):
         # create critic
-        from omegaconf import OmegaConf
 
         from verl.utils.torch_dtypes import PrecisionType
 
@@ -926,7 +923,6 @@ def megatron_rm_model_provider(pre_process, post_process):
     @register(dispatch_mode=Dispatch.ONE_TO_ALL)
     def init_model(self):
         # create critic
-        from omegaconf import OmegaConf
 
         from verl.utils.torch_dtypes import PrecisionType