配置详解¶

本深入指南将指导您完成编写用于运行食谱的配置。

本深入指南涵盖的内容

如何编写 YAML 配置文件并使用它运行食谱
如何使用 instantiate 和 parse API
如何有效地使用配置和 CLI 覆盖来运行食谱

先决条件

参数在哪里？¶

您可以通过两个主要入口点配置参数：**配置**和**CLI 覆盖**。配置是 YAML 文件，用于在一个位置定义运行食谱所需的所有参数。它们是重现运行的唯一真相来源。可以使用 tune 在命令行中覆盖配置文件参数，以便快速更改和实验，而无需修改配置文件。

编写配置¶

配置是 torchtune 中运行食谱的主要入口点。它们应为 YAML 文件，只需列出您要为特定运行定义的参数的值。

seed: null
shuffle: True
device: cuda
dtype: fp32
enable_fsdp: True
...

使用 `instantiate` 配置组件¶

许多字段将需要指定具有相关关键字参数的 torchtune 对象作为参数。模型、数据集、优化器和损失函数是常见的示例。您可以使用 _component_ 子字段轻松实现此目的。在 _component_ 中，您需要指定要在食谱中实例化的对象的点路径。点路径是在 Python 文件中正常导入对象时使用的确切路径。例如，要在您的配置中指定具有自定义参数的 alpaca_dataset

dataset:
  _component_: torchtune.datasets.alpaca_dataset
  train_on_input: False

在这里，我们将 train_on_input 的默认值从 True 更改为 False。

在配置中指定 _component_ 后，您可以在食谱的设置中像这样创建指定对象的实例

from torchtune import config

# Access the dataset field and create the object instance
dataset = config.instantiate(cfg.dataset)

这将自动使用在 dataset 下的字段中指定的任何关键字参数。

按上述编写，前面的示例实际上会引发错误。如果您查看 alpaca_dataset 的方法，您会注意到我们缺少一个必需的位置参数，即分词器。由于这是另一个可配置的 torchtune 对象，让我们了解如何通过查看 instantiate() API 来处理它。

def instantiate(
    config: DictConfig,
    *args: Tuple[Any, ...],
    **kwargs: Dict[str, Any],
)

instantiate() 还接受位置参数和关键字参数，并在创建对象时自动将其与配置一起使用。这意味着我们不仅可以传入分词器，还可以根据需要添加配置中未指定的其他关键字参数

# Tokenizer is needed for the dataset, configure it first
tokenizer:
  _component_: torchtune.models.llama2.llama2_tokenizer
  path: /tmp/tokenizer.model

dataset:
  _component_: torchtune.datasets.alpaca_dataset

# Note the API of the tokenizer we specified - we need to pass in a path
def llama2_tokenizer(path: str) -> Llama2Tokenizer:

# Note the API of the dataset we specified - we need to pass in a model tokenizer
# and any optional keyword arguments
def alpaca_dataset(
    tokenizer: ModelTokenizer,
    train_on_input: bool = True,
    max_seq_len: int = 512,
) -> InstructDataset:

from torchtune import config

# Since we've already specified the path in the config, we don't need to pass
# it in
tokenizer = config.instantiate(cfg.tokenizer)
# We pass in the instantiated tokenizer as the first required argument, then
# we change an optional keyword argument
dataset = config.instantiate(
    cfg.dataset,
    tokenizer,
    train_on_input=False,
)

请注意，其他关键字参数将覆盖配置中任何重复的键。

使用插值引用其他配置字段¶

有时您需要对多个字段使用相同的值。您可以使用插值来引用另一个字段，而 instantiate() 会自动为您解析它。

output_dir: /tmp/alpaca-llama2-finetune
metric_logger:
  _component_: torchtune.training.metric_logging.DiskLogger
  log_dir: ${output_dir}

验证您的配置¶

我们提供了一个方便的 CLI 实用程序 tune validate，可以快速验证您的配置是否格式正确，以及所有组件是否可以正确实例化。如果要测试将运行实验的确切命令，您还可以传入覆盖。如果任何参数格式不正确，tune validate 将列出发现错误的所有位置。

tune cp llama2/7B_lora_single_device ./my_config.yaml
tune validate ./my_config.yaml

编写配置的最佳实践¶

让我们讨论一些编写配置的指南，以充分利用它们。

严谨的配置¶

虽然将尽可能多的内容放入配置以提供最大灵活性来切换实验的参数可能很诱人，但我们建议您只在配置中包含将在食谱中使用或实例化的字段。这确保了对食谱运行选项的完全清晰度，并将大大简化调试。

# dont do this
alpaca_dataset:
  _component_: torchtune.datasets.alpaca_dataset
slimorca_dataset:
  ...

# do this
dataset:
  # change this in config or override when needed
  _component_: torchtune.datasets.alpaca_dataset

仅使用公共 API¶

如果要在配置中指定的组件位于私有文件中，请在配置中使用公共点路径。这些组件通常在其父模块的 __init__.py 文件中公开。这样，您可以保证在配置中使用的 API 的稳定性。组件点路径中不应包含下划线。

# don't do this
dataset:
  _component_: torchtune.datasets._alpaca.alpaca_dataset

# do this
dataset:
  _component_: torchtune.datasets.alpaca_dataset

命令行覆盖¶

配置是收集运行配方所需的所有参数的主要位置，但有时您可能希望快速尝试不同的值，而无需更新配置本身。为了启用快速实验，您可以通过tune命令在您的配置中为参数指定覆盖值。这些应指定为键值对k1=v1 k2=v2 ...

例如，要使用自定义模型和分词器目录运行LoRA 单设备微调配方，您可以提供覆盖

tune run lora_finetune_single_device \
--config llama2/7B_lora_single_device \
checkpointer.checkpoint_dir=/home/my_model_checkpoint \
checkpointer.checkpoint_files=['file_1','file_2'] \
tokenizer.path=/home/my_tokenizer_path

覆盖组件¶

如果您想覆盖配置中通过_component_字段实例化的类或函数，您可以通过直接赋值给参数名称来实现。组件中的任何嵌套字段都可以使用点表示法进行覆盖。

dataset:
  _component_: torchtune.datasets.alpaca_dataset

# Change to slimorca_dataset and set train_on_input to True
tune run lora_finetune_single_device --config my_config.yaml \
dataset=torchtune.datasets.slimorca_dataset dataset.train_on_input=True

删除配置字段¶

当通过需要不同关键字参数的覆盖更改组件时，您可能需要从配置中删除某些参数。您可以使用~标志并指定要删除的配置字段的点路径来实现。例如，如果您想覆盖内置配置并使用bitsandbytes.optim.PagedAdamW8bit优化器，您可能需要删除诸如foreach之类的特定于 PyTorch 优化器的参数。请注意，此示例要求您已安装bitsandbytes。

# In configs/llama3/8B_full.yaml
optimizer:
  _component_: torch.optim.AdamW
  lr: 2e-5
  foreach: False

# Change to PagedAdamW8bit and remove fused, foreach
tune run --nproc_per_node 4 full_finetune_distributed --config llama3/8B_full \
optimizer=bitsandbytes.optim.PagedAdamW8bit ~optimizer.foreach

配置详解¶

参数在哪里？¶

编写配置¶

使用 `instantiate` 配置组件¶

使用插值引用其他配置字段¶

验证您的配置¶

编写配置的最佳实践¶

严谨的配置¶

仅使用公共 API¶

命令行覆盖¶

覆盖组件¶

删除配置字段¶

文档

教程

资源

配置详解¶

参数在哪里？¶

编写配置¶

使用 instantiate 配置组件¶

使用插值引用其他配置字段¶

验证您的配置¶

编写配置的最佳实践¶

严谨的配置¶

仅使用公共 API¶

命令行覆盖¶

覆盖组件¶

删除配置字段¶

文档

教程

资源

使用 `instantiate` 配置组件¶