Skip to content

Commit e3c9e50

Browse files
committed
use full name, do not short
Signed-off-by: Shengliang Xu <shengliangx@nvidia.com>
1 parent 0b79b9f commit e3c9e50

8 files changed

Lines changed: 35 additions & 34 deletions

File tree

docs/source/guides/10_recipes.rst

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ styles can be used in a single-file or directory layout.
6161
Single-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

modelopt_recipes/configs/ptq/presets/model/fp8.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
# Equivalent to the hardcoded FP8_DEFAULT_CFG in config.py.
1818
imports:
1919
base_disable_all: configs/ptq/units/base_disable_all
20-
w8a8: configs/ptq/units/w8a8_fp8_fp8
21-
default_disabled: configs/ptq/units/default_disabled_quantizers
20+
w8a8_fp8_fp8: configs/ptq/units/w8a8_fp8_fp8
21+
default_disabled_quantizers: configs/ptq/units/default_disabled_quantizers
2222

2323
algorithm: max
2424
quant_cfg:
2525
- $import: base_disable_all
26-
- $import: w8a8
27-
- $import: default_disabled
26+
- $import: w8a8_fp8_fp8
27+
- $import: default_disabled_quantizers

modelopt_recipes/general/ptq/fp8_default-fp8_kv.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
imports:
1717
base_disable_all: configs/ptq/units/base_disable_all
18-
default_disabled: configs/ptq/units/default_disabled_quantizers
18+
default_disabled_quantizers: configs/ptq/units/default_disabled_quantizers
1919
w8a8_fp8_fp8: configs/ptq/units/w8a8_fp8_fp8
2020
fp8_kv: configs/ptq/units/fp8_kv
2121

@@ -28,4 +28,4 @@ quantize:
2828
- $import: base_disable_all
2929
- $import: w8a8_fp8_fp8
3030
- $import: fp8_kv
31-
- $import: default_disabled
31+
- $import: default_disabled_quantizers

modelopt_recipes/general/ptq/nvfp4_default-fp8_kv.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
imports:
1717
base_disable_all: configs/ptq/units/base_disable_all
18-
default_disabled: configs/ptq/units/default_disabled_quantizers
18+
default_disabled_quantizers: configs/ptq/units/default_disabled_quantizers
1919
w4a4_nvfp4_nvfp4: configs/ptq/units/w4a4_nvfp4_nvfp4
2020
fp8_kv: configs/ptq/units/fp8_kv
2121

@@ -28,4 +28,4 @@ quantize:
2828
- $import: base_disable_all
2929
- $import: w4a4_nvfp4_nvfp4
3030
- $import: fp8_kv
31-
- $import: default_disabled
31+
- $import: default_disabled_quantizers

modelopt_recipes/general/ptq/nvfp4_default-none_kv_gptq.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
imports:
1717
base_disable_all: configs/ptq/units/base_disable_all
18-
default_disabled: configs/ptq/units/default_disabled_quantizers
18+
default_disabled_quantizers: configs/ptq/units/default_disabled_quantizers
1919
nvfp4_static: configs/numerics/nvfp4_static
2020
nvfp4: configs/numerics/nvfp4
2121

@@ -36,4 +36,4 @@ quantize:
3636
$import: nvfp4
3737
- quantizer_name: '*[kv]_bmm_quantizer'
3838
enable: false
39-
- $import: default_disabled
39+
- $import: default_disabled_quantizers

modelopt_recipes/general/ptq/nvfp4_experts_only-fp8_kv.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
imports:
1717
base_disable_all: configs/ptq/units/base_disable_all
18-
default_disabled: configs/ptq/units/default_disabled_quantizers
18+
default_disabled_quantizers: configs/ptq/units/default_disabled_quantizers
1919
nvfp4: configs/numerics/nvfp4
2020
fp8_kv: configs/ptq/units/fp8_kv
2121

@@ -39,4 +39,4 @@ quantize:
3939
cfg:
4040
$import: nvfp4
4141
- $import: fp8_kv
42-
- $import: default_disabled
42+
- $import: default_disabled_quantizers

modelopt_recipes/general/ptq/nvfp4_mlp_only-fp8_kv.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
imports:
1717
base_disable_all: configs/ptq/units/base_disable_all
18-
default_disabled: configs/ptq/units/default_disabled_quantizers
18+
default_disabled_quantizers: configs/ptq/units/default_disabled_quantizers
1919
nvfp4: configs/numerics/nvfp4
2020
fp8_kv: configs/ptq/units/fp8_kv
2121

@@ -39,4 +39,4 @@ quantize:
3939
cfg:
4040
$import: nvfp4
4141
- $import: fp8_kv
42-
- $import: default_disabled
42+
- $import: default_disabled_quantizers

modelopt_recipes/general/ptq/nvfp4_omlp_only-fp8_kv.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
imports:
1717
base_disable_all: configs/ptq/units/base_disable_all
18-
default_disabled: configs/ptq/units/default_disabled_quantizers
18+
default_disabled_quantizers: configs/ptq/units/default_disabled_quantizers
1919
nvfp4: configs/numerics/nvfp4
2020
fp8_kv: configs/ptq/units/fp8_kv
2121

@@ -45,4 +45,4 @@ quantize:
4545
cfg:
4646
$import: nvfp4
4747
- $import: fp8_kv
48-
- $import: default_disabled
48+
- $import: default_disabled_quantizers

0 commit comments

Comments
 (0)