Skip to content

llmcompressor.args.utils

Utility functions for parsing and processing argument classes.

Provides helper functions for parsing command-line arguments and configuration dictionaries into structured argument dataclasses used in LLM compression workflows. Handles argument validation, deprecation warnings, and processor resolution.

Functions:

  • parse_args –

    Keyword arguments passed in from oneshot or train will

parse_args 

parse_args(
    **kwargs,
) -> tuple[
    ModelArguments,
    DatasetArguments,
    RecipeArguments | None,
    str | None,
]

Keyword arguments passed in from oneshot or train will separate the arguments into the following:

* ModelArguments in
    src/llmcompressor/args/model_args.py
* DatasetArguments in
    src/llmcompressor/args/dataset_args.py
* RecipeArguments in
    src/llmcompressor/args/recipe_args.py

ModelArguments, DatasetArguments, and RecipeArguments used for oneshot.

Source code in src/llmcompressor/args/utils.py 
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
def parse_args(
    **kwargs,
) -> tuple[
    ModelArguments,
    DatasetArguments,
    RecipeArguments | None,
    str | None,
]:
    """
    Keyword arguments passed in from `oneshot` or `train` will
    separate the arguments into the following:

        * ModelArguments in
            src/llmcompressor/args/model_args.py
        * DatasetArguments in
            src/llmcompressor/args/dataset_args.py
        * RecipeArguments in
            src/llmcompressor/args/recipe_args.py

    ModelArguments, DatasetArguments, and RecipeArguments used for
    oneshot.

    """
    output_dir = kwargs.pop("output_dir", None)

    parser_args = (ModelArguments, DatasetArguments, RecipeArguments)
    parser = HfArgumentParser(parser_args)
    parsed_args = parser.parse_dict(kwargs)

    model_args, dataset_args, recipe_args = parsed_args

    if recipe_args.recipe_args is not None:
        if not isinstance(recipe_args.recipe_args, dict):
            arg_dict = {}
            for recipe_arg in recipe_args.recipe_args:
                key, value = recipe_arg.split("=")
                arg_dict[key] = value
            recipe_args.recipe_args = arg_dict

    # raise deprecation warnings
    if dataset_args.remove_columns is not None:
        logger.warning(
            "`remove_columns` argument is deprecated. When tokenizing datasets, all "
            "columns which are invalid inputs the tokenizer will be removed",
            DeprecationWarning,
        )
    if not dataset_args.quantization_aware_calibration:
        logger.warning(
            "`quantization_aware_calibration` argument is deprecated and has no effect."
            "It will be removed in a future release.",
            DeprecationWarning,
        )

    # silently assign tokenizer to processor
    resolve_processor_from_model_args(model_args)

    return model_args, dataset_args, recipe_args, output_dir