File size: 18,726 Bytes
1fa3c6c | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 | # Copyright 2020-2026 The HuggingFace Team. All rights reserved.
#
# 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 argparse
import importlib
import inspect
import logging
import os
import subprocess
import sys
from collections.abc import Iterable
from dataclasses import dataclass, field
from typing import TYPE_CHECKING
# Temporarily import from the local module instead of transformers to avoid an upstream latency issue
# See: https://github.com/huggingface/transformers/issues/44273
# This workaround can be reverted once the fix is included in the minimum required transformers version
from trl.scripts._hf_argparser import DataClass, DataClassType, HfArgumentParser
if TYPE_CHECKING:
from datasets import DatasetDict
logger = logging.getLogger(__name__)
@dataclass
class DatasetConfig:
"""
Configuration for a dataset.
This class matches the signature of [`~datasets.load_dataset`] and the arguments are used directly in the
[`~datasets.load_dataset`] function. You can refer to the [`~datasets.load_dataset`] documentation for more
details.
Parameters:
path (`str`):
Path or name of the dataset.
name (`str`, *optional*):
Defining the name of the dataset configuration.
data_dir (`str`, *optional*):
Defining the `data_dir` of the dataset configuration. If specified for the generic builders(csv, text etc.)
or the Hub datasets and `data_files` is `None`, the behavior is equal to passing `os.path.join(data_dir,
**)` as `data_files` to reference all the files in a directory.
data_files (`str` or `Sequence` or `Mapping`, *optional*):
Path(s) to source data file(s).
split (`str`, *optional*, defaults to `"train"`):
Which split of the data to load.
columns (`list[str]`, *optional*):
List of column names to select from the dataset. If `None`, all columns are selected.
"""
path: str
name: str | None = None
data_dir: str | None = None
data_files: str | list[str] | dict[str, str] | None = None
split: str = "train"
columns: list[str] | None = None
@dataclass
class DatasetMixtureConfig:
"""
Configuration class for a mixture of datasets.
Using [`~transformers.HfArgumentParser`] we can turn this class into
[argparse](https://docs.python.org/3/library/argparse#module-argparse) arguments that can be specified on the
command line.
Parameters:
datasets (`list[DatasetConfig]`):
List of dataset configurations to include in the mixture.
streaming (`bool`, *optional*, defaults to `False`):
Whether to stream the datasets. If `True`, the datasets will be loaded in streaming mode.
test_split_size (`float`, *optional*):
Size of the test split. Refer to the `test_size` parameter in the [`~datasets.train_test_split`] function
for more details. If `None`, the dataset will not be split into train and test sets.
Usage:
When using the CLI, you can add the following section to your YAML config file:
```yaml
datasets:
- path: ...
name: ...
data_dir: ...
data_files: ...
split: ...
columns: ...
- path: ...
name: ...
data_dir: ...
data_files: ...
split: ...
columns: ...
streaming: ...
test_split_size: ...
```
"""
datasets: list[DatasetConfig] = field(
default_factory=list,
metadata={"help": "List of dataset configurations to include in the mixture."},
)
streaming: bool = field(
default=False,
metadata={"help": "Whether to stream the datasets. If True, the datasets will be loaded in streaming mode."},
)
test_split_size: float | None = field(
default=None,
metadata={
"help": "Size of the test split. Refer to the `test_size` parameter in the `datasets.train_test_split` "
"function for more details. If None, the dataset will not be split into train and test sets."
},
)
def __post_init__(self):
# Convert any dataset dicts (from CLI/config parsing) into DatasetConfig objects
for idx, dataset in enumerate(self.datasets):
if isinstance(dataset, dict):
# If it's a dict, convert it to DatasetConfig
self.datasets[idx] = DatasetConfig(**dataset)
@dataclass
class ScriptArguments:
"""
Arguments common to all scripts.
Args:
dataset_name (`str`,, *optional*):
Path or name of the dataset to load. If `datasets` is provided, this will be ignored.
dataset_config (`str`, *optional*):
Dataset configuration name. Corresponds to the `name` argument of the [`~datasets.load_dataset`] function.
If `datasets` is provided, this will be ignored.
dataset_train_split (`str`, *optional*, defaults to `"train"`):
Dataset split to use for training. If `datasets` is provided, this will be ignored.
dataset_test_split (`str`, *optional*, defaults to `"test"`):
Dataset split to use for evaluation. If `datasets` is provided, this will be ignored.
dataset_streaming (`bool`, *optional*, defaults to `False`):
Whether to stream the dataset. If True, the dataset will be loaded in streaming mode. If `datasets` is
provided, this will be ignored.
ignore_bias_buffers (`bool`, *optional*, defaults to `False`):
Debug argument for distributed training. Fix for DDP issues with LM bias/mask buffers - invalid scalar
type, inplace operation. See
https://github.com/huggingface/transformers/issues/22482#issuecomment-1595790992.
"""
dataset_name: str | None = field(
default=None,
metadata={"help": "Path or name of the dataset to load. If `datasets` is provided, this will be ignored."},
)
dataset_config: str | None = field(
default=None,
metadata={
"help": "Dataset configuration name. Corresponds to the `name` argument of the `datasets.load_dataset` "
"function. If `datasets` is provided, this will be ignored."
},
)
dataset_train_split: str = field(
default="train",
metadata={"help": "Dataset split to use for training. If `datasets` is provided, this will be ignored."},
)
dataset_test_split: str = field(
default="test",
metadata={"help": "Dataset split to use for evaluation. If `datasets` is provided, this will be ignored."},
)
dataset_streaming: bool = field(
default=False,
metadata={
"help": "Whether to stream the dataset. If True, the dataset will be loaded in streaming mode. If "
"`datasets` is provided, this will be ignored."
},
)
ignore_bias_buffers: bool = field(
default=False,
metadata={
"help": "Debug argument for distributed training. Fix for DDP issues with LM bias/mask buffers - invalid "
"scalar type, inplace operation. See "
"https://github.com/huggingface/transformers/issues/22482#issuecomment-1595790992."
},
)
def init_zero_verbose():
"""
Perform zero verbose init - use this method on top of the CLI modules to make logging and warning output cleaner.
Uses Rich if available, falls back otherwise.
"""
import logging
import warnings
from transformers.utils import is_rich_available
FORMAT = "%(message)s"
if is_rich_available():
from rich.logging import RichHandler
handler = RichHandler()
else:
handler = logging.StreamHandler()
logging.basicConfig(format=FORMAT, datefmt="[%X]", handlers=[handler], level=logging.ERROR)
# Custom warning handler to redirect warnings to the logging system
def warning_handler(message, category, filename, lineno, file=None, line=None):
logging.warning(f"{filename}:{lineno}: {category.__name__}: {message}")
# Add the custom warning handler - we need to do that before importing anything to make sure the loggers work well
warnings.showwarning = warning_handler
class TrlParser(HfArgumentParser):
"""
A subclass of [`transformers.HfArgumentParser`] designed for parsing command-line arguments with dataclass-backed
configurations, while also supporting configuration file loading and environment variable management.
Args:
dataclass_types (`DataClassType | Iterable[DataClassType]`, *optional*):
Dataclass types to use for argument parsing.
**kwargs:
Additional keyword arguments passed to the [`transformers.HfArgumentParser`] constructor.
Examples:
```yaml
# config.yaml
env:
VAR1: value1
arg1: 23
```
```python
# main.py
import os
from dataclasses import dataclass
from trl import TrlParser
@dataclass
class MyArguments:
arg1: int
arg2: str = "alpha"
parser = TrlParser(dataclass_types=[MyArguments])
training_args = parser.parse_args_and_config()
print(training_args, os.environ.get("VAR1"))
```
```bash
$ python main.py --config config.yaml
(MyArguments(arg1=23, arg2='alpha'),) value1
$ python main.py --arg1 5 --arg2 beta
(MyArguments(arg1=5, arg2='beta'),) None
```
"""
def __init__(
self,
dataclass_types: DataClassType | Iterable[DataClassType] | None = None,
**kwargs,
):
# Make sure dataclass_types is an iterable
if dataclass_types is None:
dataclass_types = []
elif not isinstance(dataclass_types, Iterable):
dataclass_types = [dataclass_types]
# Check that none of the dataclasses have the "config" field
for dataclass_type in dataclass_types:
if "config" in dataclass_type.__dataclass_fields__:
raise ValueError(
f"Dataclass {dataclass_type.__name__} has a field named 'config'. This field is reserved for the "
f"config file path and should not be used in the dataclass."
)
super().__init__(dataclass_types=dataclass_types, **kwargs)
def parse_args_and_config(
self,
args: Iterable[str] | None = None,
return_remaining_strings: bool = False,
fail_with_unknown_args: bool = True,
separate_remaining_strings: bool = False,
) -> tuple[DataClass, ...]:
"""
Parse command-line args and config file into instances of the specified dataclass types.
This method wraps [`transformers.HfArgumentParser.parse_args_into_dataclasses`] and also parses the config file
specified with the `--config` flag. The config file (in YAML format) provides argument values that replace the
default values in the dataclasses. Command line arguments can override values set by the config file. The
method also sets any environment variables specified in the `env` field of the config file.
"""
import yaml
args = list(args) if args is not None else sys.argv[1:]
if "--config" in args:
# Get the config file path from
config_index = args.index("--config")
args.pop(config_index) # remove the --config flag
config_path = args.pop(config_index) # get the path to the config file
with open(config_path) as yaml_file:
config = yaml.safe_load(yaml_file)
# Set the environment variables specified in the config file
if "env" in config:
env_vars = config.pop("env", {})
if not isinstance(env_vars, dict):
raise ValueError("`env` field should be a dict in the YAML file.")
for key, value in env_vars.items():
os.environ[key] = str(value)
# Set the defaults from the config values
config_remaining_strings = self.set_defaults_with_config(**config)
else:
config_remaining_strings = []
# Parse the arguments from the command line
output = self.parse_args_into_dataclasses(args=args, return_remaining_strings=return_remaining_strings)
# Merge remaining strings from the config file with the remaining strings from the command line
if return_remaining_strings:
args_remaining_strings = output[-1]
if separate_remaining_strings:
return output[:-1] + (config_remaining_strings, args_remaining_strings)
return output[:-1] + (config_remaining_strings + args_remaining_strings,)
elif fail_with_unknown_args and config_remaining_strings:
raise ValueError(
f"Unknown arguments from config file: {config_remaining_strings}. Please remove them, add them to the "
"dataclass, or set `fail_with_unknown_args=False`."
)
else:
return output
def set_defaults_with_config(self, **kwargs) -> list[str]:
"""
Overrides the parser's default values with those provided via keyword arguments, including for subparsers.
Any argument with an updated default will also be marked as not required if it was previously required.
Returns a list of strings that were not consumed by the parser.
"""
def apply_defaults(parser, kw):
used_keys = set()
for action in parser._actions:
# Handle subparsers recursively
if isinstance(action, argparse._SubParsersAction):
for subparser in action.choices.values():
used_keys.update(apply_defaults(subparser, kw))
elif action.dest in kw:
action.default = kw[action.dest]
action.required = False
used_keys.add(action.dest)
return used_keys
used_keys = apply_defaults(self, kwargs)
# Remaining args not consumed by the parser
remaining = [
item for key, value in kwargs.items() if key not in used_keys for item in (f"--{key}", str(value))
]
return remaining
def get_git_commit_hash(package_name):
try:
# Import the package to locate its path
package = importlib.import_module(package_name)
# Get the path to the package using inspect
package_path = os.path.dirname(inspect.getfile(package))
# Navigate up to the Git repository root if the package is inside a subdirectory
git_repo_path = os.path.abspath(os.path.join(package_path, ".."))
git_dir = os.path.join(git_repo_path, ".git")
if os.path.isdir(git_dir):
# Run the git command to get the current commit hash
commit_hash = (
subprocess.check_output(["git", "rev-parse", "HEAD"], cwd=git_repo_path).strip().decode("utf-8")
)
return commit_hash
else:
return None
except Exception as e:
return f"Error: {str(e)}"
def get_dataset(mixture_config: DatasetMixtureConfig) -> "DatasetDict":
"""
Load a mixture of datasets based on the configuration.
Args:
mixture_config ([`DatasetMixtureConfig`]):
Script arguments containing dataset configuration.
Returns:
[`~datasets.DatasetDict`]:
Combined dataset(s) from the mixture configuration, with optional train/test split if `test_split_size` is
set.
Example:
```python
from trl import DatasetMixtureConfig, get_dataset
from trl.scripts.utils import DatasetConfig
mixture_config = DatasetMixtureConfig(datasets=[DatasetConfig(path="trl-lib/tldr")])
dataset = get_dataset(mixture_config)
print(dataset)
```
```
DatasetDict({
train: Dataset({
features: ['prompt', 'completion'],
num_rows: 116722
})
})
```
"""
import datasets
logger.info(f"Creating dataset mixture with {len(mixture_config.datasets)} datasets")
datasets_list = []
for dataset_config in mixture_config.datasets:
logger.info(f"Loading dataset for mixture: {dataset_config.path} (config name: {dataset_config.name})")
dataset = datasets.load_dataset(
path=dataset_config.path,
name=dataset_config.name,
data_dir=dataset_config.data_dir,
data_files=dataset_config.data_files,
split=dataset_config.split,
streaming=mixture_config.streaming,
)
if dataset_config.columns is not None:
dataset = dataset.select_columns(dataset_config.columns)
datasets_list.append(dataset)
if datasets_list:
combined_dataset = datasets.concatenate_datasets(datasets_list)
if isinstance(combined_dataset, datasets.Dataset): # IterableDataset does not have a length
logger.info(f"Created dataset mixture with {len(combined_dataset)} examples")
if mixture_config.test_split_size is not None:
logger.info(f"Splitting dataset into train and test sets with test size: {mixture_config.test_split_size}")
combined_dataset = combined_dataset.train_test_split(test_size=mixture_config.test_split_size)
return combined_dataset
else:
return datasets.DatasetDict({"train": combined_dataset})
else:
raise ValueError("No datasets were loaded from the mixture configuration")
|