# 配置

`PeftConfigMixin` 是用于存储 [PeftModel](/docs/peft/v0.22.0/zh/package_reference/peft_model#peft.PeftModel) 适配器配置的基础配置类，而 [PromptLearningConfig](/docs/peft/v0.22.0/zh/package_reference/config#peft.PromptLearningConfig) 是软提示方法（p-tuning、prefix tuning 和 prompt tuning）的基础配置类。这些基础类包含用于从 Hub 保存和加载模型配置的方法，并用于指定要使用的 PEFT 方法、要执行的任务类型，以及模型配置（如层数和注意力头数）。

## PeftConfigMixin[[peft.config.PeftConfigMixin]]

#### peft.config.PeftConfigMixin[[peft.config.PeftConfigMixin]]

```python
peft.config.PeftConfigMixin(task_type: Optional[TaskType] = None, peft_type: Optional[PeftType] = None, auto_mapping: Optional[dict] = None, peft_version: Optional[str] = None)
```

[源代码](https://github.com/huggingface/peft/blob/v0.22.0/src/peft/config.py#L97)

**参数：**

peft_type (Union[`~peft.utils.config.PeftType`, `str`]) : 要使用的 Peft 方法类型。

这是 PEFT 适配器模型的基础配置类。它包含了所有 PEFT 适配器模型共有的方法。该类继承自 [PushToHubMixin](https://huggingface.co/docs/transformers/v5.23.0/en/main_classes/model#transformers.utils.PushToHubMixin)，后者包含将模型推送到 Hub 的方法。`save_pretrained` 方法会将您的适配器模型配置保存到一个目录中。`from_pretrained` 方法会从目录中加载您的适配器模型配置。

#### check_kwargs[[peft.config.PeftConfigMixin.check_kwargs]]

```python
check_kwargs(**kwargs)
```

[源代码](https://github.com/huggingface/peft/blob/v0.22.0/src/peft/config.py#L369)

在初始化配置实例之前检查 kwargs。

子类可以重写此方法以添加特定的检查。

#### from_json_file[[peft.config.PeftConfigMixin.from_json_file]]

```python
from_json_file(path_json_file: str, **kwargs)
```

[源代码](https://github.com/huggingface/peft/blob/v0.22.0/src/peft/config.py#L304)

**参数：**

path_json_file (`str`) : json 文件的路径。

从 json 文件加载配置文件。

#### from_peft_type[[peft.config.PeftConfigMixin.from_peft_type]]

```python
from_peft_type(**kwargs)
```

[源代码](https://github.com/huggingface/peft/blob/v0.22.0/src/peft/config.py#L194)

**参数：**

kwargs （configuration 关键字参数）：传递给配置初始化的关键字参数。

此方法从一组 kwargs 中加载您的适配器模型的配置。

适当的配置类型由 `peft_type` 参数决定。如果未提供 `peft_type`，则会实例化调用方的类类型。

#### from_pretrained[[peft.config.PeftConfigMixin.from_pretrained]]

```python
from_pretrained(pretrained_model_name_or_path: str, subfolder: Optional[str] = None, **kwargs)
```

[源代码](https://github.com/huggingface/peft/blob/v0.22.0/src/peft/config.py#L259)

**参数：**

pretrained_model_name_or_path (`str`) : 保存配置的目录或 Hub 仓库 id。

subfolder (`str`, *可选*) : `pretrained_model_name_or_path` 下的一个可选子文件夹。

kwargs （额外的关键字参数，*可选*）：转发给 [huggingface_hub.hf_hub_download](https://huggingface.co/docs/huggingface_hub/v2.4.0/en/package_reference/file_download#huggingface_hub.hf_hub_download) 的关键字参数（例如 `token`、`revision`、`cache_dir`）。PEFT 配置特有的参数（如 `task_type` 或 `r`）不能作为覆盖项传入。若要修改属性，请在加载后在返回的配置对象上设置它们。

此方法从目录中加载您的适配器模型的配置。

#### save_pretrained[[peft.config.PeftConfigMixin.save_pretrained]]

```python
save_pretrained(save_directory: str, **kwargs)
```

[源代码](https://github.com/huggingface/peft/blob/v0.22.0/src/peft/config.py#L160)

**参数：**

save_directory (`str`) : 配置将保存到的目录。

kwargs （额外的关键字参数，*可选*）：传递给 [push_to_hub](https://huggingface.co/docs/transformers/v5.23.0/en/main_classes/model#transformers.utils.PushToHubMixin.push_to_hub) 方法的额外关键字参数。

此方法将您的适配器模型的配置保存到一个目录中。

#### to_dict[[peft.config.PeftConfigMixin.to_dict]]

```python
to_dict()
```

[源代码](https://github.com/huggingface/peft/blob/v0.22.0/src/peft/config.py#L154)

以字典形式返回适配器模型的配置。

## PeftConfig[[peft.PeftConfig]]

#### peft.PeftConfig[[peft.PeftConfig]]

```python
peft.PeftConfig(task_type: Optional[Union[str, TaskType]] = None, peft_type: Optional[Union[str, PeftType]] = None, auto_mapping: Optional[dict] = None, peft_version: Optional[str] = None, base_model_name_or_path: Optional[str] = None, revision: Optional[str] = None, inference_mode: bool = False)
```

[源代码](https://github.com/huggingface/peft/blob/v0.22.0/src/peft/config.py#L392)

**参数：**

peft_type (Union[`~peft.utils.config.PeftType`, `str`]) : 要使用的 Peft 方法类型。

task_type (Union[`~peft.utils.config.TaskType`, `str`]) : 要执行的任务类型。

inference_mode (`bool`，默认为 `False`)：是否以推理模式使用 Peft 模型。

这是用于存储 [PeftModel](/docs/peft/v0.22.0/zh/package_reference/peft_model#peft.PeftModel) 配置的基础配置类。

## PromptLearningConfig[[peft.PromptLearningConfig]]

#### peft.PromptLearningConfig[[peft.PromptLearningConfig]]

```python
peft.PromptLearningConfig(task_type: Optional[Union[str, TaskType]] = None, peft_type: Optional[Union[str, PeftType]] = None, auto_mapping: Optional[dict] = None, peft_version: Optional[str] = None, base_model_name_or_path: Optional[str] = None, revision: Optional[str] = None, inference_mode: bool = False, num_virtual_tokens: int = None, token_dim: int = None, num_transformer_submodules: Optional[int] = None, num_attention_heads: Optional[int] = None, num_layers: Optional[int] = None, modules_to_save: Optional[list[str]] = None)
```

[源代码](https://github.com/huggingface/peft/blob/v0.22.0/src/peft/config.py#L412)

**参数：**

num_virtual_tokens (`int`) : 要使用的虚拟 token 数量。

token_dim (`int`) : 基础 transformer 模型的隐藏嵌入维度。

num_transformer_submodules (`int`) : 基础 transformer 模型中 transformer 子模块的数量。

num_attention_heads (`int`) : 基础 Transformer 模型中的注意力头数量。

num_layers (`int`) : 基础 transformer 模型中的层数。

这是用于存储 `PrefixTuning`、[PromptEncoder](/docs/peft/v0.22.0/zh/package_reference/p_tuning#peft.PromptEncoder) 或 `PromptTuning` 配置的基础配置类。

## get_peft_config[[peft.get_peft_config]]

#### peft.get_peft_config[[peft.get_peft_config]]

```python
peft.get_peft_config(config_dict: dict[str, Any])
```

[源代码](https://github.com/huggingface/peft/blob/v0.22.0/src/peft/mapping.py#L36)

**参数：**

config_dict (`Dict[str, Any]`) : 包含配置参数的字典。

从字典返回 Peft 配置对象。

