@@ -61,7 +61,7 @@ styles can be used in a single-file or directory layout.
6161Single-file format
6262------------------
6363
64- The simplest form is a single ``.yml `` or `` . yaml `` file.
64+ The simplest form is a single ``.yaml `` file.
6565
6666**Inline style ** — all config values are written directly:
6767
@@ -131,18 +131,18 @@ example:
131131.. code-block :: text
132132
133133 my_recipe/
134- recipe.yml # metadata section (+ optional imports)
135- quantize.yml # quantize section (quant_cfg + algorithm )
134+ recipe.yaml # metadata section (+ optional imports)
135+ quantize.yaml # quantize section (+ optional imports )
136136
137- ``recipe.yml ``:
137+ ``recipe.yaml ``:
138138
139139.. code-block :: yaml
140140
141141 metadata :
142142 recipe_type : ptq
143143 description : My custom NVFP4 recipe.
144144
145- ``quantize.yml ``:
145+ ``quantize.yaml ``:
146146
147147.. code-block :: yaml
148148
@@ -159,8 +159,9 @@ example:
159159 num_bits : e4m3
160160 axis :
161161
162- Both inline and import styles work with the directory format. When using
163- imports in a directory recipe, place the ``imports `` section in ``recipe.yml ``.
162+ Both inline and import styles work with the directory format. Any YAML file
163+ in the directory can have its own ``imports `` section — ``recipe.yaml ``,
164+ ``quantize.yaml ``, or any other config file.
164165
165166.. _composable-imports :
166167
@@ -475,7 +476,7 @@ type depends on the ``recipe_type`` in the metadata:
475476 .. code-block :: python
476477
477478 # Load a custom recipe from the filesystem (file or directory)
478- recipe = load_recipe(" /path/to/my_custom_recipe.yml " )
479+ recipe = load_recipe(" /path/to/my_custom_recipe.yaml " )
479480 # or: recipe = load_recipe("/path/to/my_recipe_dir/")
480481
481482 Command-line usage
@@ -529,7 +530,7 @@ This means built-in recipes can be referenced without any prefix:
529530
530531 # These are all equivalent:
531532 load_recipe(" general/ptq/fp8_default-fp8_kv" )
532- load_recipe(" general/ptq/fp8_default-fp8_kv.yml " )
533+ load_recipe(" general/ptq/fp8_default-fp8_kv.yaml " )
533534
534535
535536 Writing a custom recipe
@@ -547,7 +548,7 @@ Example -- creating a custom PTQ recipe using imports:
547548
548549.. code-block :: yaml
549550
550- # my_int8_recipe.yml
551+ # my_int8_recipe.yaml
551552 imports :
552553 base_disable_all : configs/ptq/units/base_disable_all
553554 default_disabled : configs/ptq/units/default_disabled_quantizers
@@ -586,19 +587,19 @@ The ``modelopt_recipes/`` package is organized as follows:
586587 +-- __init__.py
587588 +-- general/ # Model-agnostic recipes
588589 | +-- ptq/
589- | +-- fp8_default-fp8_kv.yml
590- | +-- nvfp4_default-fp8_kv.yml
591- | +-- nvfp4_mlp_only-fp8_kv.yml
592- | +-- nvfp4_experts_only-fp8_kv.yml
593- | +-- nvfp4_omlp_only-fp8_kv.yml
590+ | +-- fp8_default-fp8_kv.yaml
591+ | +-- nvfp4_default-fp8_kv.yaml
592+ | +-- nvfp4_mlp_only-fp8_kv.yaml
593+ | +-- nvfp4_experts_only-fp8_kv.yaml
594+ | +-- nvfp4_omlp_only-fp8_kv.yaml
594595 +-- models/ # Model-specific recipes
595596 | +-- Step3.5-Flash/
596597 | +-- nvfp4-mlp-only.yaml
597598 +-- configs/ # Reusable config snippets (imported via $import)
598599 +-- numerics/ # Numeric format definitions
599- | +-- fp8.yml
600- | +-- nvfp4_static.yml
601- | +-- nvfp4.yml
600+ | +-- fp8.yaml
601+ | +-- nvfp4_static.yaml
602+ | +-- nvfp4.yaml
602603 +-- ptq/ # PTQ-specific entry snippets
603604 +-- base_disable_all.yaml
604605 +-- default_disabled_quantizers.yaml
0 commit comments