PEFT documentation

配置

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

配置

PeftConfigMixin 是用于存储 PeftModel 适配器配置的基础配置类,而 PromptLearningConfig 是软提示方法(p-tuning、prefix tuning 和 prompt tuning)的基础配置类。这些基础类包含用于从 Hub 保存和加载模型配置的方法,并用于指定要使用的 PEFT 方法、要执行的任务类型,以及模型配置(如层数和注意力头数)。

PeftConfigMixin

类 peft.config.PeftConfigMixin

< >

( task_type: Optional[TaskType] = Nonepeft_type: Optional[PeftType] = Noneauto_mapping: Optional[dict] = Nonepeft_version: Optional[str] = None )

参数

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

这是 PEFT 适配器模型的基础配置类。它包含了所有 PEFT 适配器模型共有的方法。该类继承自 PushToHubMixin,后者包含了将模型推送到 Hub 的方法。save_pretrained 方法会将您的适配器模型的配置保存到一个目录中。from_pretrained 方法会从目录中加载您的适配器模型的配置。

check_kwargs

< >

( **kwargs )

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

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

from_json_file

< >

( path_json_file: str**kwargs )

参数

  • path_json_file (str) — json 文件的路径。

从 json 文件加载配置文件。

from_peft_type

< >

( **kwargs )

参数

  • kwargs(配置关键字参数) — 传递给配置初始化的关键字参数。

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

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

from_pretrained

< >

( pretrained_model_name_or_path: strsubfolder: Optional[str] = None**kwargs )

参数

  • pretrained_model_name_or_path (str) — 保存配置的目录或 Hub 仓库 id。
  • subfolder (str, 可选) — pretrained_model_name_or_path 下的可选子文件夹。
  • kwargs(额外的关键字参数,可选) — 转发给 huggingface_hub.hf_hub_download 的关键字参数(例如 token、revision、 cache_dir)。PEFT 配置特有的参数(如 task_type 或 r)不能作为覆盖项传入。若要修改属性,请在加载后于返回的配置对象上设置。

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

save_pretrained

< >

( save_directory: str**kwargs )

参数

  • save_directory (str) — 保存配置的目录。
  • kwargs(额外的关键字参数,可选)— 传递给 push_to_hub 方法的额外关键字参数。

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

to_dict

< >

( )

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

PeftConfig

类 peft.PeftConfig

< >

( task_type: Optional[Union[str, TaskType]] = Nonepeft_type: Optional[Union[str, PeftType]] = Noneauto_mapping: Optional[dict] = Nonepeft_version: Optional[str] = Nonebase_model_name_or_path: Optional[str] = Nonerevision: Optional[str] = Noneinference_mode: bool = False )

参数

  • peft_type (Union[~peft.utils.config.PeftType, str]) — 要使用的 Peft 方法类型。
  • task_type (Union[~peft.utils.config.TaskType, str]) — 要执行的任务类型。
  • inference_mode (bool,默认为 False) — 是否以推理模式使用 Peft 模型。

这是用于存储 PeftModel 配置的基础配置类。

PromptLearningConfig

类 peft.PromptLearningConfig

< >

( task_type: Optional[Union[str, TaskType]] = Nonepeft_type: Optional[Union[str, PeftType]] = Noneauto_mapping: Optional[dict] = Nonepeft_version: Optional[str] = Nonebase_model_name_or_path: Optional[str] = Nonerevision: Optional[str] = Noneinference_mode: bool = Falsenum_virtual_tokens: int = Nonetoken_dim: int = Nonenum_transformer_submodules: Optional[int] = Nonenum_attention_heads: Optional[int] = Nonenum_layers: Optional[int] = Nonemodules_to_save: Optional[list[str]] = None )

参数

  • 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 或 PromptTuning 配置的基础配置类。

get_peft_config

peft.get_peft_config

< >

( config_dict: dict[str, Any] )

参数

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

从字典返回 Peft 配置对象。

Update on GitHub