Hugging Face's logo

PEFT documentation

Конфигурация

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v0.21.0).
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) — Каталог или идентификатор репозитория на Hugging Face Hub, где сохранена конфигурация.
  • 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) — Размерность скрытых эмбеддингов базовой трансформерной модели.
  • num_transformer_submodules (int) — Количество подмодулей трансформера в базовой трансформерной модели.
  • num_attention_heads (int) — Количество головок внимания в базовой трансформерной модели.
  • num_layers (int) — Количество слоев в базовой трансформерной модели.

Это базовый класс конфигурации для хранения настроек PrefixTuning, PromptEncoder или PromptTuning.

get_peft_config

peft.get_peft_config

< >

( config_dict: dict[str, Any] )

Параметры

  • config_dict (Dict[str, Any]) — Словарь, содержащий параметры конфигурации.

Возвращает объект конфигурации Peft из словаря.

Update on GitHub

←Типы PEFT Tuner→