# 設定

`PeftConfigMixin` は [PeftModel](/docs/peft/v0.22.0/ja/package_reference/peft_model#peft.PeftModel) のアダプター設定を保存するためのベース設定クラスであり、[PromptLearningConfig](/docs/peft/v0.22.0/ja/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アダプターモデルに共通するメソッドが含まれています。このクラスは、モデルをHubにプッシュするためのメソッドを含む[PushToHubMixin](https://huggingface.co/docs/transformers/v5.23.0/en/main_classes/model#transformers.utils.PushToHubMixin)を継承しています。`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)

configインスタンスを初期化する前に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 keyword arguments) : 設定の初期化に渡されるキーワード引数。

このメソッドは、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`）。`task_type` や `r` などの PEFT 設定固有の引数は、オーバーライドとして渡すことはできません。属性を変更するには、読み込み後に返された設定に設定してください。

このメソッドは、ディレクトリからアダプターモデルの設定を読み込みます。

#### 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/ja/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_dim (`int`) : ベースとなるtransformerモデルの隠れ埋め込み次元。

num_transformer_submodules (`int`) : ベースとなるtransformerモデル内のtransformerサブモジュールの数。

num_attention_heads (`int`) : ベースとなるtransformerモデルのattention headの数。

num_layers (`int`) : ベースとなるtransformerモデルの層数。

これは`PrefixTuning`、[PromptEncoder](/docs/peft/v0.22.0/ja/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設定オブジェクトを返します。

