PEFT documentation

Cấu hình

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

Cấu hình

PeftConfigMixin là lớp cấu hình cơ sở để lưu trữ cấu hình adapter của một PeftModel, và PromptLearningConfig là lớp cấu hình cơ sở cho các phương pháp soft prompt (p-tuning, prefix tuning và prompt tuning). Các lớp cơ sở này chứa các phương thức để lưu và nạp cấu hình mô hình từ Hub, chỉ định phương pháp PEFT cần sử dụng, loại tác vụ cần thực hiện, và các cấu hình mô hình như số lượng lớp và số lượng đầu chú ý.

PeftConfigMixin

lớp peft.config.PeftConfigMixin

< >

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

Tham số

  • peft_type (Union[~peft.utils.config.PeftType, str]) — Kiểu phương pháp Peft cần sử dụng.

Đây là lớp cấu hình cơ bản cho các mô hình adapter PEFT. Nó chứa tất cả các phương thức chung cho mọi mô hình adapter PEFT. Lớp này kế thừa từ PushToHubMixin, bao gồm các phương thức để đẩy mô hình của bạn lên Hub. Phương thức save_pretrained sẽ lưu cấu hình của mô hình adapter của bạn vào một thư mục. Phương thức from_pretrained sẽ tải cấu hình của mô hình adapter của bạn từ một thư mục.

check_kwargs

< >

( **kwargs )

Kiểm tra kwargs trước khi khởi tạo instance cấu hình.

Các lớp con có thể ghi đè phương thức này để thêm các kiểm tra cụ thể.

from_json_file

< >

( path_json_file: str**kwargs )

Tham số

  • path_json_file (str) — Đường dẫn đến tệp json.

Tải tệp cấu hình từ tệp json.

from_peft_type

< >

( **kwargs )

Tham số

  • kwargs (các tham số cấu hình dạng từ khóa) — Các tham số từ khóa được truyền đến quá trình khởi tạo cấu hình.

Phương pháp này nạp cấu hình của mô hình adapter của bạn từ một tập hợp các kwargs.

Loại cấu hình phù hợp được xác định bởi đối số peft_type. Nếu peft_type không được cung cấp, loại lớp gọi sẽ được khởi tạo.

from_pretrained

< >

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

Tham số

  • pretrained_model_name_or_path (str) — Thư mục hoặc id kho Hub nơi cấu hình được lưu trữ.
  • subfolder (str, tùy chọn) — Một thư mục con tùy chọn dưới pretrained_model_name_or_path.
  • kwargs (các đối số từ khóa bổ sung, tùy chọn) — Các đối số từ khóa được chuyển tiếp đến huggingface_hub.hf_hub_download (ví dụ token, revision, cache_dir). Các đối số cụ thể của cấu hình PEFT, chẳng hạn như task_type hoặc r, không thể được truyền dưới dạng các giá trị ghi đè. Để thay đổi các thuộc tính, hãy đặt chúng trên cấu hình đã trả về sau khi tải.

Phương pháp này nạp cấu hình của mô hình adapter của bạn từ một thư mục.

save_pretrained

< >

( save_directory: str**kwargs )

Tham số

  • save_directory (str) — Thư mục nơi cấu hình sẽ được lưu.
  • kwargs (các đối số từ khóa bổ sung, tùy chọn) — Các đối số từ khóa bổ sung được truyền đến phương thức push_to_hub.

Phương pháp này lưu cấu hình của mô hình adapter của bạn vào một thư mục.

to_dict

< >

( )

Trả về cấu hình cho mô hình adapter của bạn dưới dạng từ điển.

PeftConfig

lớp 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 )

Tham số

  • peft_type (Union[~peft.utils.config.PeftType, str]) — Kiểu phương pháp Peft cần sử dụng.
  • task_type (Union[~peft.utils.config.TaskType, str]) — Loại tác vụ cần thực hiện.
  • inference_mode (bool, mặc định là False) — Có sử dụng mô hình Peft ở chế độ suy luận hay không.

Đây là lớp cấu hình cơ bản để lưu trữ cấu hình của một PeftModel.

PromptLearningConfig

lớp 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 )

Tham số

  • num_virtual_tokens (int) — Số lượng token ảo cần sử dụng.
  • token_dim (int) — Kích thước nhúng ẩn của mô hình transformer cơ sở.
  • num_transformer_submodules (int) — Số lượng các submodule transformer trong mô hình transformer cơ sở.
  • num_attention_heads (int) — Số lượng đầu chú ý trong mô hình transformer cơ bản.
  • num_layers (int) — Số lượng lớp trong mô hình transformer cơ bản.

Đây là lớp cấu hình cơ bản để lưu trữ cấu hình của PrefixTuning, PromptEncoder hoặc PromptTuning.

get_peft_config

peft.get_peft_config

< >

( config_dict: dict[str, Any] )

Tham số

  • config_dict (Dict[str, Any]) — Từ điển chứa các tham số cấu hình.

Trả về một đối tượng cấu hình Peft từ một từ điển.

Update on GitHub