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

class 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アダプターモデルに共通するメソッドが含まれています。このクラスは、モデルをHubにプッシュするためのメソッドを含むPushToHubMixinを継承しています。save_pretrainedメソッドは、アダプターモデルの設定をディレクトリに保存します。from_pretrainedメソッドは、ディレクトリからアダプターモデルの設定を読み込みます。

check_kwargs

< >

( **kwargs )

configインスタンスを初期化する前に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_dim (int) — ベースとなる Transformer モデルの隠れ埋め込み次元。
  • num_transformer_submodules (int) — ベースとなるtransformerモデル内のtransformerサブモジュールの数。
  • num_attention_heads (int) — ベースの transformer モデルにおける attention head の数。
  • 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