PEFT documentation
配置
配置
PeftConfigMixin 是用于存储 PeftModel 适配器配置的基础配置类,而 PromptLearningConfig 是软提示方法(p-tuning、prefix tuning 和 prompt tuning)的基础配置类。这些基础类包含用于从 Hub 保存和加载模型配置的方法,并用于指定要使用的 PEFT 方法、要执行的任务类型,以及模型配置(如层数和注意力头数)。
PeftConfigMixin
类 peft.config.PeftConfigMixin
< source >( task_type: Optional[TaskType] = Nonepeft_type: Optional[PeftType] = Noneauto_mapping: Optional[dict] = Nonepeft_version: Optional[str] = None )
这是 PEFT 适配器模型的基础配置类。它包含了所有 PEFT 适配器模型共有的方法。该类继承自 PushToHubMixin,后者包含了将模型推送到 Hub 的方法。save_pretrained 方法会将您的适配器模型的配置保存到一个目录中。from_pretrained 方法会从目录中加载您的适配器模型的配置。
从 json 文件加载配置文件。
此方法从一组 kwargs 中加载您的适配器模型的配置。
适当的配置类型由 peft_type 参数决定。如果未提供 peft_type,
则会实例化调用方的类类型。
from_pretrained
< source >( 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
< source >( save_directory: str**kwargs )
参数
- save_directory (
str) — 保存配置的目录。 - kwargs(额外的关键字参数,可选)— 传递给 push_to_hub 方法的额外关键字参数。
此方法将您的适配器模型的配置保存到一个目录中。
以字典形式返回适配器模型的配置。
PeftConfig
类 peft.PeftConfig
< source >( 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 )
这是用于存储 PeftModel 配置的基础配置类。
PromptLearningConfig
类 peft.PromptLearningConfig
< source >( 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 )
这是用于存储 PrefixTuning、PromptEncoder 或 PromptTuning 配置的基础配置类。
get_peft_config
peft.get_peft_config
< source >( config_dict: dict[str, Any] )
从字典返回 Peft 配置对象。