Transformers documentation

CLVP

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v5.22.1).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Mô hình này được công bố trên HF papers vào ngày 12-05-2023 và được đóng góp cho Hugging Face Transformers vào ngày 10-11-2023.

CLVP

Tổng quan

Mô hình CLVP (Contrastive Language-Voice Pretrained Transformer) được đề xuất trong Better speech synthesis through scaling bởi James Betker.

Tóm tắt từ bài báo như sau:

Trong những năm gần đây, lĩnh vực tạo ảnh đã được cách mạng hóa nhờ việc ứng dụng các transformer tự hồi quy và DDPM. Các phương pháp này mô hình hóa quá trình tạo ảnh như một quy trình xác suất từng bước và tận dụng lượng lớn tài nguyên tính toán cùng dữ liệu để học phân phối ảnh. Phương pháp luận nhằm cải thiện hiệu năng này không nhất thiết phải bị giới hạn ở ảnh. Bài báo này mô tả cách áp dụng những tiến bộ trong lĩnh vực tạo ảnh vào tổng hợp giọng nói. Kết quả là TorToise - một hệ thống chuyển văn bản thành giọng nói (text-to-speech) biểu cảm, đa giọng.

Mô hình này được đóng góp bởi Susnato Dhar. Mã nguồn gốc có thể được tìm thấy tại đây.

Mẹo sử dụng

  1. CLVP là một phần không thể thiếu của mô hình Tortoise TTS.
  2. CLVP có thể được sử dụng để so sánh các ứng viên giọng nói đã tạo với văn bản được cung cấp, và các token giọng nói tốt nhất sẽ được chuyển đến mô hình khuếch tán.
  3. Việc sử dụng phương thức ClvpModelForConditionalGeneration.generate() được khuyến nghị mạnh mẽ khi sử dụng tortoise.
  4. Lưu ý rằng mô hình CLVP mong đợi âm thanh được lấy mẫu ở 22,05 kHz, trái ngược với các mô hình âm thanh khác mong đợi 16 kHz.

Giải thích ngắn gọn

  • ClvpTokenizer thực hiện token hóa đầu vào văn bản, và ClvpFeatureExtractor trích xuất log mel-spectrogram từ âm thanh mong muốn.
  • ClvpConditioningEncoder nhận các token văn bản và biểu diễn âm thanh đó, sau đó chuyển đổi chúng thành các embedding được điều kiện bởi văn bản và âm thanh.
  • ClvpForCausalLM sử dụng các embedding đó để tạo ra nhiều ứng viên giọng nói.
  • Mỗi ứng viên giọng nói được đưa qua bộ mã hóa giọng nói (ClvpEncoder) để chuyển đổi chúng thành biểu diễn vector, và bộ mã hóa văn bản (ClvpEncoder) chuyển đổi các token văn bản vào cùng không gian ẩn.
  • Cuối cùng, chúng ta so sánh mỗi vector giọng nói với vector văn bản để xem vector giọng nói nào giống nhất với vector văn bản.
  • ClvpModelForConditionalGeneration.generate() nén toàn bộ các logic được mô tả ở trên vào một phương thức duy nhất.

Ví dụ:

import datasets

from transformers import ClvpModelForConditionalGeneration, ClvpProcessor


# Define the Text and Load the Audio (We are taking an audio example from HuggingFace Hub using `datasets` library).
text = "This is an example text."

ds = datasets.load_dataset("hf-internal-testing/librispeech_asr_dummy", "clean", split="validation")
ds = ds.cast_column("audio", datasets.Audio(sampling_rate=22050))
sample = ds[0]["audio"]

# Define processor and model.
processor = ClvpProcessor.from_pretrained("susnato/clvp_dev")
model = ClvpModelForConditionalGeneration.from_pretrained("susnato/clvp_dev", device_map="auto")

# Generate processor output and model output.
processor_output = processor(raw_speech=sample["array"], sampling_rate=sample["sampling_rate"], text=text, return_tensors="pt").to(model.device)
generated_output = model.generate(**processor_output)

ClvpConfig

lớp transformers.ClvpConfig

< >

( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0is_encoder_decoder: bool = Falseid2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Nonetext_config: dict | transformers.configuration_utils.PreTrainedConfig | None = Nonespeech_config: dict | transformers.configuration_utils.PreTrainedConfig | None = Nonedecoder_config: dict | transformers.configuration_utils.PreTrainedConfig | None = Noneprojection_dim: int = 768logit_scale_init_value: float = 2.6592initializer_factor: float = 1.0 )

Tham số

  • text_config (Union[dict, ~configuration_utils.PreTrainedConfig], tùy chọn) — Đối tượng cấu hình hoặc từ điển của bộ khung văn bản.
  • speech_config (dict, tùy chọn) — Từ điển các tùy chọn cấu hình được sử dụng để khởi tạo bộ mã hóa giọng nói CLVP.
  • decoder_config (dict, tùy chọn) — Từ điển các tùy chọn cấu hình được sử dụng để khởi tạo ClvpDecoderConfig.
  • projection_dim (int, tùy chọn, mặc định là 768) — Số chiều của các lớp chiếu văn bản và thị giác.
  • logit_scale_init_value (float, tùy chọn, mặc định là 2.6592) — Giá trị ban đầu của tham số logit_scale.
  • initializer_factor (float, tùy chọn, mặc định là 1.0) — Hệ số để khởi tạo tất cả các ma trận trọng số (nên giữ ở mức 1, được sử dụng bên trong cho việc kiểm tra khởi tạo).

Đây là lớp cấu hình để lưu trữ cấu hình của một ClvpModelForConditionalGeneration. Nó được sử dụng để khởi tạo một mô hình Clvp theo các đối số được chỉ định, xác định kiến trúc của mô hình. Khởi tạo một cấu hình với các giá trị mặc định sẽ tạo ra một cấu hình tương tự như cấu hình của susnato/clvp_dev

Các đối tượng cấu hình kế thừa từ PreTrainedConfig và có thể được sử dụng để kiểm soát đầu ra của mô hình. Đọc tài liệu từ PreTrainedConfig để biết thêm thông tin.

Ví dụ:

>>> from transformers import ClvpConfig, ClvpModelForConditionalGeneration

>>> # Initializing a ClvpConfig with susnato/clvp_dev style configuration
>>> configuration = ClvpConfig()

>>> # Initializing a ClvpModelForConditionalGeneration (with random weights) from the susnato/clvp_dev style configuration
>>> model = ClvpModelForConditionalGeneration(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

>>> # We can also initialize a CLVPConfig from a CLVPTextConfig, CLVPSpeechConfig and a CLVPAutoRegressiveConfig
>>> from transformers import ClvpEncoderConfig, ClvpDecoderConfig

>>> # Initializing a CLVP text, CLVP speech and CLVP decoder configuration
>>> config_text = ClvpEncoderConfig()
>>> config_speech = ClvpEncoderConfig()
>>> decoder_config = ClvpDecoderConfig()

>>> config = ClvpConfig(config_text, config_speech, decoder_config)

ClvpEncoderConfig

lớp transformers.ClvpEncoderConfig

< >

( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0is_encoder_decoder: bool = Falseid2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Nonevocab_size: int = 256hidden_size: int = 768intermediate_size: int = 1536projection_dim: int = 768num_hidden_layers: int = 20num_attention_heads: int = 12hidden_act: str = 'gelu'layer_norm_eps: float = 1e-05attention_dropout: float | int = 0.1dropout: float | int = 0.1use_rotary_embedding: bool = Trueuse_attention_bias: bool = Falsesummary_type: str = 'mean'initializer_factor: float = 1.0bos_token_id: int | None = 255eos_token_id: int | list[int] | None = 0pad_token_id: int | None = None )

Tham số

  • vocab_size (int, tùy chọn, mặc định là 256) — Kích thước từ vựng của mô hình. Xác định số lượng token khác nhau có thể được biểu diễn bởi input_ids.
  • hidden_size (int, tùy chọn, mặc định là 768) — Kích thước của các biểu diễn ẩn.
  • intermediate_size (int, tùy chọn, mặc định là 1536) — Kích thước của các biểu diễn MLP.
  • projection_dim (int, tùy chọn, mặc định là 768) — Số chiều của các lớp chiếu văn bản và thị giác.
  • num_hidden_layers (int, tùy chọn, mặc định là 20) — Số lượng lớp ẩn trong bộ giải mã Transformer.
  • num_attention_heads (int, tùy chọn, mặc định là 12) — Số lượng đầu attention cho mỗi lớp attention trong bộ giải mã Transformer.
  • hidden_act (str, tùy chọn, mặc định là gelu) — Hàm kích hoạt phi tuyến (hàm hoặc chuỗi) trong bộ giải mã. Ví dụ, "gelu", "relu", "silu", v.v.
  • layer_norm_eps (float, tùy chọn, mặc định là 1e-05) — Giá trị epsilon được sử dụng bởi các lớp chuẩn hóa lớp (layer normalization).
  • attention_dropout (Union[float, int], tùy chọn, mặc định là 0.1) — Tỷ lệ dropout cho các xác suất chú ý.
  • dropout (Union[float, int], tùy chọn, mặc định là 0.1) — Tỷ lệ cho tất cả các lớp dropout.
  • use_rotary_embedding (bool, tùy chọn, mặc định là True) — Có sử dụng rotary_embedding hay không.
  • use_attention_bias (bool, tùy chọn, mặc định là False) — Có sử dụng bias trong các lớp Query, Key và Value trong quá trình self attention hay không.
  • summary_type (str, tùy chọn, mặc định là "mean") — Chiến lược sử dụng để lấy pooler_output từ last_hidden_state. Hỗ trợ "last", "first", "mean" và "cls_index".
  • initializer_factor (float, tùy chọn, mặc định là 1.0) — Hệ số để khởi tạo tất cả các ma trận trọng số (nên giữ ở mức 1, được sử dụng bên trong cho việc kiểm tra khởi tạo).
  • bos_token_id (int, tùy chọn, mặc định là 255) — Token id được sử dụng cho beginning-of-stream trong bảng từ vựng.
  • eos_token_id (Union[int, list[int]], tùy chọn, mặc định là 0) — Token id được sử dụng cho end-of-stream trong bảng từ vựng.
  • pad_token_id (int, tùy chọn) — Token id được sử dụng để đệm trong từ vựng.

Đây là lớp cấu hình để lưu trữ cấu hình của một ClvpModelForConditionalGeneration. Nó được sử dụng để khởi tạo một mô hình Clvp theo các đối số được chỉ định, xác định kiến trúc của mô hình. Khởi tạo một cấu hình với các giá trị mặc định sẽ tạo ra một cấu hình tương tự như cấu hình của susnato/clvp_dev

Các đối tượng cấu hình kế thừa từ PreTrainedConfig và có thể được sử dụng để kiểm soát đầu ra của mô hình. Đọc tài liệu từ PreTrainedConfig để biết thêm thông tin.

Ví dụ:

>>> from transformers import ClvpEncoderConfig, ClvpEncoder

>>> # Initializing a ClvpEncoderConfig with susnato/clvp_dev style configuration
>>> encoder_configuration = ClvpEncoderConfig()

>>> # Initializing a ClvpEncoder (with random weights) from the susnato/clvp_dev style configuration
>>> model = ClvpEncoder(encoder_configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

ClvpDecoderConfig

lớp transformers.ClvpDecoderConfig

< >

( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0is_encoder_decoder: bool = Falseid2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Nonevocab_size: int = 8194max_position_embeddings: int = 608max_text_tokens: int = 404hidden_size: int = 1024num_hidden_layers: int = 30num_attention_heads: int = 16n_inner: int | None = Nonenum_mel_attn_blocks: int = 6activation_function: str = 'gelu_new'resid_pdrop: float | int = 0.1embd_pdrop: float | int = 0.1attention_dropout: float | int = 0.1layer_norm_epsilon: float = 1e-05initializer_range: float = 0.02summary_type: str = 'cls_index'summary_use_proj: bool = Truesummary_activation: str | None = Nonesummary_proj_to_labels: bool = Truesummary_first_dropout: float | int = 0.1use_cache: bool = Truebos_token_id: int | None = 8192eos_token_id: int | list[int] | None = 8193pad_token_id: int | None = Nonefeature_size: int = 80use_attention_bias: bool = Trueinitializer_factor: float = 1.0decoder_fixing_codes: list[int] | tuple[int, ...] = (83, 45, 45, 248)add_cross_attention: bool = False )

Tham số

  • vocab_size (int, tuỳ chọn, mặc định là 8194) — Kích thước từ vựng của mô hình. Xác định số lượng token khác nhau có thể được biểu diễn bởi input_ids.
  • max_position_embeddings (int, tùy chọn, mặc định là 608) — Chiều dài chuỗi tối đa mà mô hình này có thể được sử dụng.
  • max_text_tokens (int, tùy chọn, mặc định là 404) — Chiều dài tối đa của chuỗi token văn bản mà mô hình này có thể được sử dụng. Tương tự như n_positions trong GPT2Config.
  • hidden_size (int, tùy chọn, mặc định là 1024) — Kích thước của các biểu diễn ẩn.
  • num_hidden_layers (int, tùy chọn, mặc định là 30) — Số lượng lớp ẩn trong bộ giải mã Transformer.
  • num_attention_heads (int, tùy chọn, mặc định là 16) — Số lượng đầu attention cho mỗi lớp attention trong bộ giải mã Transformer.
  • n_inner (int, tùy chọn) — Số chiều của các lớp feed-forward bên trong. None sẽ đặt nó bằng 4 lần hidden_size.
  • num_mel_attn_blocks (int, tùy chọn, mặc định là 6) — Chỉ ra số lượng lớp self attention trong ClvpConditioningEncoder.
  • activation_function (str, tùy chọn, mặc định là gelu_new) — Hàm kích hoạt phi tuyến (hàm hoặc chuỗi) trong bộ giải mã. Ví dụ, "gelu", "relu", "silu", v.v.
  • resid_pdrop (Union[float, int], tùy chọn, mặc định là 0.1) — Xác suất dropout cho tất cả các lớp fully connected trong embeddings, encoder và pooler.
  • embd_pdrop (Union[float, int], tùy chọn, mặc định là 0.1) — Tỷ lệ dropout cho các embedding.
  • attention_dropout (Union[float, int], tùy chọn, mặc định là 0.1) — Tỷ lệ dropout cho các xác suất chú ý.
  • layer_norm_epsilon (float, tùy chọn, mặc định là 1e-05) — Giá trị epsilon được sử dụng bởi các lớp chuẩn hóa lớp (layer normalization).
  • initializer_range (float, tùy chọn, mặc định là 0.02) — Độ lệch chuẩn của truncated_normal_initializer để khởi tạo tất cả các ma trận trọng số.
  • summary_type (string, tuỳ chọn, mặc định là "cls_index") — Tham số được sử dụng khi thực hiện tóm tắt chuỗi. Phải là một trong các tùy chọn sau:
    • "last": Lấy trạng thái ẩn của token cuối cùng (giống như XLNet).
    • "first": Lấy trạng thái ẩn của token đầu tiên (giống như BERT).
    • "mean": Lấy trung bình của các hidden states của tất cả các token.
    • "cls_index": Cung cấp một Tensor chứa vị trí của token phân loại (giống như GPT/GPT-2).
    • "attn": Chưa được triển khai, hãy sử dụng multi-head attention.
  • summary_use_proj (bool, tùy chọn, mặc định là True) — Có thêm một phép chiếu (projection) sau bước trích xuất vector hay không.
  • summary_activation (str, tùy chọn) — Truyền "tanh" để áp dụng hàm kích hoạt tanh cho đầu ra, mọi giá trị khác sẽ không áp dụng hàm kích hoạt nào.
  • summary_proj_to_labels (bool, tùy chọn, mặc định là True) — Xác định xem đầu ra của phép chiếu có config.num_labels hay config.hidden_size lớp.
  • summary_first_dropout (float, tùy chọn, mặc định là 0.1) — Tỷ lệ dropout được sử dụng sau khi chiếu và kích hoạt.
  • use_cache (bool, tùy chọn, mặc định là True) — Xác định xem mô hình có nên trả về các chú ý key/values cuối cùng hay không (không được sử dụng bởi tất cả các mô hình). Chỉ liên quan nếu config.is_decoder=True hoặc khi mô hình là mô hình sinh chỉ có decoder.
  • bos_token_id (int, tùy chọn, mặc định là 8192) — Token id được sử dụng cho beginning-of-stream trong bảng từ vựng.
  • eos_token_id (Union[int, list[int]], tùy chọn, mặc định là 8193) — Token id được sử dụng cho end-of-stream trong bảng từ vựng.
  • pad_token_id (int, tùy chọn) — Token id được sử dụng để đệm trong từ vựng.
  • feature_size (int, tuỳ chọn, mặc định là 80) — Kích thước chiều đặc trưng của các đặc trưng mel được trích xuất. Giá trị này được sử dụng trong ClvpConditioningEncoder.
  • use_attention_bias (bool, tùy chọn, mặc định là True) — Có sử dụng bias trong các lớp Query, Key và Value trong quá trình self attention hay không.
  • initializer_factor (float, tùy chọn, mặc định là 1.0) — Hệ số để khởi tạo tất cả các ma trận trọng số (nên giữ ở mức 1, được sử dụng bên trong cho việc kiểm tra khởi tạo).
  • decoder_fixing_codes (list, tùy chọn, mặc định là [83, 45, 45, 248]) — Các giá trị này được sử dụng trong phương thức fix_speech_decoder_output để sửa các đầu ra do decoder tạo ra.
  • add_cross_attention (bool, tùy chọn, mặc định là False) — Xác định xem có nên thêm các lớp cross-attention vào mô hình hay không.

Đây là lớp cấu hình để lưu trữ cấu hình của một ClvpModelForConditionalGeneration. Nó được sử dụng để khởi tạo một mô hình Clvp theo các đối số được chỉ định, xác định kiến trúc của mô hình. Khởi tạo một cấu hình với các giá trị mặc định sẽ tạo ra một cấu hình tương tự như cấu hình của susnato/clvp_dev

Các đối tượng cấu hình kế thừa từ PreTrainedConfig và có thể được sử dụng để kiểm soát đầu ra của mô hình. Đọc tài liệu từ PreTrainedConfig để biết thêm thông tin.

Ví dụ:

>>> from transformers import ClvpDecoderConfig, ClvpDecoder

>>> # Initializing a ClvpDecoderConfig with susnato/clvp_dev style configuration
>>> decoder_configuration = ClvpDecoderConfig()

>>> # Initializing a ClvpDecoder (with random weights) from the susnato/clvp_dev style configuration
>>> model = ClvpDecoder(decoder_configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

ClvpTokenizer

lớp transformers.ClvpTokenizer

< >

( vocab_filemerges_fileerrors = 'replace'unk_token = '[UNK]'bos_token = '<|endoftext|>'eos_token = '[STOP]'pad_token = '[STOP]'add_prefix_space = False**kwargs )

Tham số

  • vocab_file (str) — Đường dẫn đến tệp từ vựng.
  • merges_file (str) — Đường dẫn đến tệp merges.
  • errors (str, tùy chọn, mặc định là "replace") — Quy tắc áp dụng khi giải mã bytes sang UTF-8. Xem bytes.decode để biết thêm thông tin.
  • unk_token (str, tùy chọn, mặc định là "[UNK]") — Token không xác định. Một token không có trong từ vựng sẽ không thể được chuyển đổi thành ID và sẽ được gán thành token này thay thế.
  • bos_token (str, tùy chọn, mặc định là "<|endoftext|>") — Token bắt đầu chuỗi.
  • eos_token (str, tùy chọn, mặc định là "[STOP]") — Token kết thúc chuỗi.
  • pad_token (str, tùy chọn, mặc định là "[STOP]") — Token đệm của chuỗi.
  • add_prefix_space (bool, tùy chọn, mặc định là False) — Có thêm một khoảng trắng ban đầu vào đầu vào hay không. Điều này cho phép xử lý từ đầu tiên giống như bất kỳ từ nào khác. (tokenizer CLVP phát hiện đầu từ bằng khoảng trắng phía trước).

Xây dựng bộ phân từ CLVP. Dựa trên mã hóa cặp byte (Byte-Pair-Encoding) ở mức byte.

Tokenizer này được huấn luyện để coi khoảng trắng như một phần của các token (tương tự như sentencepiece) nên một từ sẽ

sẽ được mã hóa khác nhau tùy thuộc vào việc nó nằm ở đầu câu (không có khoảng trắng) hay không:

>>> from transformers import ClvpTokenizer

>>> tokenizer = ClvpTokenizer.from_pretrained("susnato/clvp_dev")
>>> tokenizer("Hello world")["input_ids"]
[62, 84, 28, 2, 179, 79]

>>> tokenizer(" Hello world")["input_ids"]
[2, 62, 84, 28, 2, 179, 79]

Bạn có thể tránh hành vi đó bằng cách truyền add_prefix_space=True khi khởi tạo tokenizer này hoặc khi bạn gọi nó trên một số văn bản, nhưng vì mô hình không được tiền huấn luyện theo cách này, nó có thể dẫn đến giảm hiệu suất.

Khi được sử dụng với is_split_into_words=True, tokenizer này sẽ thêm một khoảng trắng trước mỗi từ (kể cả từ đầu tiên).

Tokenizer này kế thừa từ PreTrainedTokenizer, lớp chứa hầu hết các phương thức chính. Người dùng nên tham khảo siêu lớp này để biết thêm thông tin về các phương thức đó.

save_vocabulary

< >

( save_directory: strfilename_prefix: str | None = None ) → tuple[str, ...]

Tham số

  • save_directory (str) — Thư mục để lưu trữ từ vựng.
  • filename_prefix (str, tùy chọn) — Một tiền tố tùy chọn để thêm vào tên của các tệp được lưu.

Trả về

tuple[str, ...]

Đường dẫn đến các tệp đã lưu, hoặc bộ rỗng nếu không có tệp nào được lưu.

Thực hiện mặc định cho các mẫu lưu trữ từ vựng phổ biến. Lưu self.encoder/self.vocab dưới dạng JSON, tùy chọn kèm self.bpe_ranks dưới dạng merges. Trả về bộ rỗng nếu không có từ vựng.

Ghi đè phương thức này nếu tokenizer của bạn cần logic lưu trữ tùy chỉnh (ví dụ: mô hình SentencePiece, nhiều tệp từ vựng, hoặc các định dạng tệp đặc biệt).

ClvpFeatureExtractor

lớp transformers.ClvpFeatureExtractor

< >

( feature_size = 80sampling_rate = 22050default_audio_length = 6hop_length = 256chunk_length = 30n_fft = 1024padding_value = 0.0mel_norms = Nonereturn_attention_mask = False**kwargs )

Tham số

  • feature_size (int, tùy chọn, mặc định là 80) — Kích thước chiều của các đặc trưng đã trích xuất.
  • sampling_rate (int, tùy chọn, mặc định là 22050) — Tần số lấy mẫu (tính bằng hertz (Hz)) mà các tệp âm thanh cần được số hóa.
  • default_audio_length (int, tùy chọn, mặc định là 6) — Độ dài mặc định của âm thanh thô tính bằng giây. Nếu max_length không được đặt trong __call__ thì nó sẽ được đặt tự động thành default_audio_length * self.sampling_rate.
  • hop_length (int, tùy chọn, mặc định là 256) — Chiều dài của các cửa sổ chồng lấn cho STFT được sử dụng để lấy các hệ số Mel Frequency.
  • chunk_length (int, tùy chọn, mặc định là 30) — Số lượng chunk tối đa của sampling_rate mẫu được sử dụng để cắt và đệm các chuỗi âm thanh dài hơn hoặc ngắn hơn.
  • n_fft (int, tùy chọn, mặc định là 1024) — Kích thước của phép biến đổi Fourier.
  • padding_value (float, tùy chọn, mặc định là 0.0) — Giá trị đệm được dùng để đệm âm thanh. Nên tương ứng với các khoảng im lặng.
  • mel_norms (list có độ dài feature_size, tùy chọn) — Nếu mel_norms được cung cấp, nó sẽ được sử dụng để chuẩn hóa các phổ log-mel dọc theo mỗi bộ lọc mel.
  • return_attention_mask (bool, tuỳ chọn, mặc định là False) — Có trả về attention mask hay không. Nếu để mặc định, nó sẽ trả về attention mask.

    Mặt nạ chú ý là gì?

Tạo một bộ trích xuất đặc trưng CLVP.

Feature extractor này kế thừa từ SequenceFeatureExtractor, bao gồm hầu hết các phương thức chính. Người dùng nên tham khảo lớp cha này để biết thêm thông tin về các phương thức đó.

Lớp này trích xuất các đặc trưng log-mel-spectrogram từ giọng nói thô bằng cách sử dụng một cài đặt numpy tùy chỉnh của Short Time Fourier Transform, vốn nên khớp với tương đương torch.stft của pytorch.

__call__

< >

( raw_speech: numpy.ndarray | list[float] | list[numpy.ndarray] | list[list[float]]sampling_rate: int | None = Nonetruncation: bool = Truepad_to_multiple_of: int | None = Nonereturn_tensors: str | transformers.utils.generic.TensorType | None = Nonereturn_attention_mask: bool | None = Truepadding: str | None = 'max_length'max_length: int | None = None**kwargs )

Tham số

  • raw_speech (np.ndarray, list[float], list[np.ndarray], list[list[float]]) — Chuỗi hoặc lô các chuỗi cần được đệm. Mỗi chuỗi có thể là một mảng numpy, một danh sách các giá trị float, một danh sách các mảng numpy hoặc một danh sách các danh sách giá trị float. Phải là âm thanh kênh đơn (mono), không phải stereo, tức là một giá trị float duy nhất cho mỗi bước thời gian.
  • sampling_rate (int, tùy chọn) — Tần số lấy mẫu mà đầu vào raw_speech được lấy mẫu. Rất khuyến nghị truyền sampling_rate tại cuộc gọi forward để ngăn các lỗi âm thầm và cho phép pipeline nhận dạng giọng nói tự động.
  • truncation (bool, tùy chọn, mặc định là True) — Bật tính năng cắt để giảm các chuỗi đầu vào dài hơn max_length xuống còn max_length.
  • pad_to_multiple_of (int, tuỳ chọn) — Nếu được đặt, chuỗi sẽ được đệm (pad) đến bội số của giá trị được cung cấp.

    Điều này đặc biệt hữu ích để cho phép sử dụng Tensor Cores trên phần cứng NVIDIA có khả năng tính toán >= 7.5 (Volta), hoặc trên TPU, nơi mà việc có độ dài chuỗi là bội số của 128 sẽ mang lại lợi ích.

  • return_attention_mask (bool, tuỳ chọn, mặc định là True) — Có trả về attention mask hay không. Nếu để mặc định, nó sẽ trả về attention mask.

    Mặt nạ chú ý là gì?

  • return_tensors (str hoặc TensorType, tùy chọn) — Nếu được đặt, sẽ trả về tensor thay vì danh sách các số nguyên Python. Các giá trị chấp nhận được là:
    • 'pt': Trả về các đối tượng torch.Tensor của PyTorch.
    • 'np': Trả về các đối tượng Numpy np.ndarray.
  • padding_value (float, tùy chọn, mặc định là 0.0) — Giá trị được sử dụng để điền vào các giá trị / vector đệm.
  • max_length (int, tùy chọn) — Chiều dài tối đa của đầu vào.

ClvpFeatureExtractor được sử dụng để trích xuất các thuộc tính đặc thù của giọng nói như cao độ và âm sắc, tốc độ nói, và thậm chí cả các khiếm khuyết khi nói như nói ngọng hoặc nói lắp từ một mẫu giọng nói hoặc raw_speech.

Trước tiên, giọng nói được đệm hoặc cắt bớt sao cho trở thành một dạng sóng có độ dài self.default_audio_length giây, sau đó phổ log-mel spectrogram được trích xuất từ đó.

ClvpProcessor

lớp transformers.ClvpProcessor

< >

( feature_extractortokenizer )

Tham số

  • feature_extractor (ClvpFeatureExtractor) — Bộ trích xuất đặc trưng là một đầu vào bắt buộc.
  • tokenizer (ClvpTokenizer) — Tokenizer là đầu vào bắt buộc.

Tạo một ClvpProcessor đóng gói một bộ trích xuất đặc trưng và một bộ phân từ thành một bộ xử lý duy nhất.

ClvpProcessor cung cấp đầy đủ các chức năng của ClvpFeatureExtractor và ClvpTokenizer. Xem ~ClvpFeatureExtractor và ~ClvpTokenizer để biết thêm thông tin.

__call__

< >

( *argstext = Noneaudio = None**kwargs )

Tham số

  • text (`) -- The sequence or batch of sequences to be encoded. Each sequence can be a string or a list of strings (pretokenized string). If you pass a pretokenized input, set is_split_into_words=True` to avoid ambiguity with batched inputs.
  • audio (“) — Âm thanh hoặc lô âm thanh cần được chuẩn bị. Mỗi âm thanh có thể là một mảng NumPy hoặc tensor PyTorch. Trong trường hợp là mảng NumPy/tensor PyTorch, mỗi âm thanh nên có hình dạng (C, T), trong đó C là số kênh, và T là độ dài mẫu của âm thanh.
  • return_tensors (str hoặc TensorType, tùy chọn) — Nếu được đặt, sẽ trả về tensor của một framework cụ thể. Các giá trị chấp nhận được là:
    • 'pt': Trả về các đối tượng torch.Tensor của PyTorch.
    • 'np': Trả về các đối tượng np.ndarray của NumPy.

decode

< >

( *args**kwargs )

Phương pháp này chuyển tiếp tất cả các đối số của nó đến decode() của PreTrainedTokenizer. Vui lòng tham khảo docstring của phương pháp này để biết thêm thông tin.

batch_decode

< >

( *args**kwargs )

Phương pháp này chuyển tiếp tất cả các đối số của nó đến batch_decode() của PreTrainedTokenizer. Vui lòng tham khảo docstring của phương pháp này để biết thêm thông tin.

ClvpModelForConditionalGeneration

lớp transformers.ClvpModelForConditionalGeneration

< >

( config: ClvpConfig )

Tham số

  • config (ClvpConfig) — Lớp cấu hình mô hình chứa tất cả các tham số của mô hình. Khởi tạo bằng tệp cấu hình không tải trọng số liên quan đến mô hình, chỉ tải cấu hình. Xem phương thức from_pretrained() để tải trọng số của mô hình.

Mô hình CLVP tổng hợp với bộ mã hóa văn bản, bộ mã hóa giọng nói và mô hình giải mã giọng nói.

Mô hình này kế thừa từ PreTrainedModel. Xem tài liệu của lớp cha để biết các phương thức chung mà thư viện triển khai cho tất cả các mô hình của nó (chẳng hạn như tải xuống hoặc lưu trữ, thay đổi kích thước các nhúng đầu vào, cắt tỉa các đầu, v.v.)

Mô hình này cũng là một lớp con của torch.nn.Module trong PyTorch. Hãy sử dụng nó như một Module PyTorch thông thường và tham khảo tài liệu PyTorch cho mọi vấn đề liên quan đến cách sử dụng và hành vi chung.

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = Noneinput_features: typing.Optional[torch.FloatTensor] = Noneconditioning_encoder_inputs_embeds: typing.Optional[torch.FloatTensor] = Nonetext_encoder_inputs_embeds: typing.Optional[torch.FloatTensor] = Noneattention_mask: typing.Optional[torch.LongTensor] = Nonereturn_loss: bool | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → ClvpOutput or tuple(torch.FloatTensor)

Tham số

  • input_ids (torch.LongTensor có dạng (batch_size, sequence_length), tùy chọn) — Chỉ số của các token trong chuỗi đầu vào theo từ điển. Mặc định, padding sẽ bị bỏ qua.

    Các chỉ số có thể được lấy bằng cách sử dụng AutoTokenizer. Xem PreTrainedTokenizer.encode() và PreTrainedTokenizer.call() để biết thêm chi tiết.

    ID đầu vào là gì?

  • input_features (torch.FloatTensor có shape (batch_size, sequence_length, feature_dim), tùy chọn) — Các tensor tương ứng với các đặc trưng âm thanh đầu vào. Các đặc trưng âm thanh có thể được lấy bằng cách sử dụng ClvpFeatureExtractor. Xem ClvpFeatureExtractor.call() để biết chi tiết (ClvpProcessor sử dụng ClvpFeatureExtractor để xử lý âm thanh).
  • conditioning_encoder_inputs_embeds (torch.FloatTensor, tùy chọn) — inputs_embeds cho ClvpConditioningEncoder. Có thể được sử dụng thay cho input_ids.
  • text_encoder_inputs_embeds (torch.FloatTensor, tùy chọn) — inputs_embeds cho mô hình text encoder được truyền thay cho input_ids.
  • attention_mask (torch.LongTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện attention trên các chỉ số token padding. Các giá trị mặt nạ được chọn trong [0, 1]:
    • 1 cho các token không bị che,
    • 0 cho các token bị che.

    Mặt nạ chú ý là gì?

  • return_loss (bool, tùy chọn) — Có trả về tổn thất tương phản hay không.

Trả về

ClvpOutput hoặc tuple(torch.FloatTensor)

Một ClvpOutput hoặc một tuple của torch.FloatTensor (nếu return_dict=False được truyền hoặc khi config.return_dict=False) bao gồm các thành phần khác nhau tùy thuộc vào cấu hình (ClvpConfig) và đầu vào.

Phương thức forward của ClvpModelForConditionalGeneration ghi đè lên phương thức đặc biệt __call__.

Mặc dù công thức cho bước truyền tiến cần được định nghĩa bên trong hàm này, người dùng nên gọi instance của Module sau đó thay vì gọi hàm này, vì instance Module sẽ đảm nhận việc thực hiện các bước tiền xử lý và hậu xử lý, trong khi hàm này sẽ lặng lẽ bỏ qua chúng.

  • loss (torch.FloatTensor có shape (1,), optional, được trả về khi return_loss là True) — Mất tương phản (contrastive loss) cho độ tương đồng giữa giọng nói và văn bản.
  • speech_ids (torch.LongTensor, tùy chọn) — speech_ids (hoặc các ứng viên speech) do mô hình ClvpForCausalLM tạo ra.
  • logits_per_speech (torch.FloatTensor có hình dạng (speech_batch_size, text_batch_size)) — Điểm tích vô hướng có trọng số giữa speech_embeds và text_embeds. Đây là điểm tương đồng giữa giọng nói và văn bản.
  • logits_per_text (torch.FloatTensor có hình dạng (text_batch_size, speech_batch_size)) — Điểm tích vô hướng có trọng số giữa text_embeds và speech_embeds. Đây là các điểm tương đồng giữa văn bản và giọng nói.
  • text_embeds (torch.FloatTensor có shape (batch_size, output_dim) — Các embedding văn bản thu được bằng cách áp dụng lớp projection lên pooled output của text encoder model.
  • speech_embeds (torch.FloatTensor có shape (batch_size, output_dim) — Các embedding giọng nói thu được bằng cách áp dụng lớp projection lên đầu ra pooled của mô hình encoder giọng nói.
  • text_model_output (~modeling_outputs.BaseModelOutputWithPooling, tùy chọn) — Đầu ra đã được pool của last_hidden_state của Model mã hóa văn bản.
  • speech_model_output (~modeling_outputs.BaseModelOutputWithPooling, tùy chọn) — Đầu ra đã được pool của last_hidden_state của Model mã hóa giọng nói.
  • decoder_hidden_states (torch.FloatTensor, tùy chọn) — Trạng thái ẩn của mô hình decoder.
  • text_encoder_hidden_states (torch.FloatTensor, tùy chọn) — Trạng thái ẩn của mô hình mã hóa văn bản.
  • speech_encoder_hidden_states (torch.FloatTensor, tùy chọn) — Trạng thái ẩn của mô hình mã hóa giọng nói.

Ví dụ:

>>> import datasets
>>> from transformers import ClvpProcessor, ClvpModelForConditionalGeneration

>>> # Define the Text and Load the Audio (We are taking an audio example from HuggingFace Hub using `datasets` library)
>>> text = "This is an example text."

>>> ds = datasets.load_dataset("hf-internal-testing/librispeech_asr_dummy", "clean", split="validation")
>>> ds = ds.cast_column("audio", datasets.Audio(sampling_rate=22050))
>>> audio = ds.sort("id")["audio"][0]
>>> audio_sample, sr = audio["array"], audio["sampling_rate"]

>>> # Define processor and model
>>> processor = ClvpProcessor.from_pretrained("susnato/clvp_dev")
>>> model = ClvpModelForConditionalGeneration.from_pretrained("susnato/clvp_dev")

>>> # processor outputs and model outputs
>>> processor_output = processor(raw_speech=audio_sample, sampling_rate=sr, text=text, return_tensors="pt")
>>> outputs = model(
...     input_ids=processor_output["input_ids"],
...     input_features=processor_output["input_features"],
...     return_dict=True,
... )

generate

< >

( input_ids: typing.Optional[torch.LongTensor] = Noneinput_features: typing.Optional[torch.FloatTensor] = Noneattention_mask: typing.Optional[torch.LongTensor] = Nonegeneration_config: transformers.generation.configuration_utils.GenerationConfig | None = Nonepad_to_max_mel_tokens: int | None = Noneoutput_hidden_states: bool | None = None**kwargs ) → ClvpOutput or tuple

Tham số

  • input_ids (torch.FloatTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Các Token văn bản đầu vào. Được xử lý từ ClvpTokenizer.
  • attention_mask (torch.Tensor có shape (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện attention trên các chỉ số token văn bản đệm. Các giá trị mặt nạ được chọn trong [0, 1]:
    • 1 cho các token không bị che,
    • 0 cho các token bị che.

    Mặt nạ chú ý là gì?

  • generation_config (~generation.GenerationConfig, tùy chọn) — Cấu hình sinh được sử dụng làm tham số hóa cơ sở cho lệnh gọi sinh. **kwargs được truyền vào generate và khớp với các thuộc tính của generation_config sẽ ghi đè lên chúng. Nếu generation_config không được cung cấp, giá trị mặc định sẽ được sử dụng, với thứ tự ưu tiên nạp như sau: 1) từ tệp mô hình generation_config.json, nếu tệp này tồn tại; 2) từ cấu hình của mô hình. Vui lòng lưu ý rằng các tham số không được chỉ định sẽ kế thừa các giá trị mặc định của GenerationConfig, và tài liệu của lớp này nên được kiểm tra để tham số hóa quá trình sinh.
  • pad_to_max_mel_tokens (int, tùy chọn) — Đệm các speech_ids đã tạo ra đến giá trị được chỉ định. Điều này nhằm thực hiện cùng một logic từ kho lưu trữ chính thức, liên kết: https://github.com/neonbjb/tortoise-tts/blob/80f89987a5abda5e2b082618cd74f9c7411141dc/tortoise/api.py#L430 và để đảm bảo các logits giống hệt nhau. Điều này không ảnh hưởng đến chất lượng tạo ra nên vui lòng không cân nhắc sử dụng vì nó kém hiệu quả hơn.
  • output_hidden_states (bool, tùy chọn) — Có trả về các trạng thái ẩn (hidden states) của mô hình giải mã, mô hình mã hóa văn bản và mô hình mã hóa giọng nói hay không.

Trả về

ClvpOutput hoặc tuple

Một ClvpOutput (nếu return_dict_in_generate=True hoặc khi config.return_dict_in_generate=True) hoặc một tuple.

Phương thức Generate cho ClvpModelForConditionalGeneration, phương thức này gọi phương thức generate của ClvpForCausalLM và sau đó sử dụng các speech_ids đã tạo để xử lý text_embeds và speech_embeds bằng ClvpEncoder.

get_text_features

< >

( input_ids: typing.Optional[torch.LongTensor] = Nonetext_encoder_inputs_embeds: typing.Optional[torch.FloatTensor] = Noneattention_mask: typing.Optional[torch.LongTensor] = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → ClvpEncoderOutput or tuple(torch.FloatTensor)

Tham số

  • input_ids (torch.LongTensor có dạng (batch_size, sequence_length), tùy chọn) — Chỉ số của các token trong chuỗi đầu vào theo từ điển. Mặc định, padding sẽ bị bỏ qua.

    Các chỉ số có thể được lấy bằng cách sử dụng AutoTokenizer. Xem PreTrainedTokenizer.encode() và PreTrainedTokenizer.call() để biết thêm chi tiết.

    ID đầu vào là gì?

  • text_encoder_inputs_embeds (torch.FloatTensor, tùy chọn) — inputs_embeds cho mô hình text encoder được truyền thay cho input_ids.
  • attention_mask (torch.LongTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện attention trên các chỉ số token padding. Các giá trị mặt nạ được chọn trong [0, 1]:
    • 1 cho các token không bị che,
    • 0 cho các token bị che.

    Mặt nạ chú ý là gì?

Trả về

ClvpEncoderOutput hoặc tuple(torch.FloatTensor)

Một ClvpEncoderOutput hoặc một tuple của torch.FloatTensor (nếu return_dict=False được truyền hoặc khi config.return_dict=False) bao gồm các thành phần khác nhau tùy thuộc vào cấu hình (ClvpConfig) và đầu vào.

Phương pháp này có thể được sử dụng để trích xuất text_embeds từ một văn bản. Các vector nhúng văn bản được thu được bằng cách áp dụng lớp chiếu (projection layer) lên đầu ra đã được pool của mô hình mã hóa văn bản CLVP.

  • embeds (torch.FloatTensor có shape (batch_size, output_dim), optional, được trả về khi model được khởi tạo với with_projection=True) — Các embeddings thu được bằng cách áp dụng lớp projection lên pooler_output.

  • last_hidden_state (torch.FloatTensor có hình dạng (batch_size, sequence_length, hidden_size)) — Trạng thái ẩn của lớp cuối cùng của mô hình.

  • pooler_output (torch.FloatTensor có hình dạng (batch_size, hidden_size)) — Đầu ra đã được pool của last_hidden_state.

  • hidden_states (tuple[torch.FloatTensor], tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Bộ tuple các torch.FloatTensor (một cho đầu ra của embeddings, nếu mô hình có lớp embedding, + một cho đầu ra của mỗi lớp) có hình dạng (batch_size, sequence_length, hidden_size).

    Trạng thái ẩn của mô hình tại đầu ra của mỗi lớp cùng với các đầu ra embedding ban đầu tùy chọn.

  • attentions (tuple[torch.FloatTensor], tuỳ chọn, được trả về khi output_attentions=True được truyền vào hoặc khi config.output_attentions=True) — Bộ tuple của torch.FloatTensor (một cho mỗi lớp) có hình dạng (batch_size, num_heads, sequence_length, sequence_length).

    Trọng số chú ý sau softmax của attention, được sử dụng để tính trung bình có trọng số trong các đầu self-attention.

Ví dụ:

>>> from transformers import ClvpProcessor, ClvpModelForConditionalGeneration

>>> # Define the Text
>>> text = "This is an example text."

>>> # Define processor and model
>>> processor = ClvpProcessor.from_pretrained("susnato/clvp_dev")
>>> model = ClvpModelForConditionalGeneration.from_pretrained("susnato/clvp_dev")

>>> # Generate processor output and text embeds
>>> processor_output = processor(text=text, return_tensors="pt")
>>> text_embeds = model.get_text_features(input_ids=processor_output["input_ids"])

get_speech_features

< >

( speech_ids: typing.Optional[torch.LongTensor] = Noneinput_ids: typing.Optional[torch.LongTensor] = Noneinput_features: typing.Optional[torch.FloatTensor] = Noneconditioning_encoder_inputs_embeds: typing.Optional[torch.FloatTensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonegeneration_config: transformers.generation.configuration_utils.GenerationConfig | None = None**kwargs ) → torch.FloatTensor of shape (batch_size, output_dim)

Tham số

  • speech_ids (torch.LongTensor có shape (batch_size, num_speech_ids), tùy chọn) — Speech Tokens. Padding sẽ bị bỏ qua mặc định nếu bạn cung cấp. Nếu speech_ids được cung cấp thì input_ids và input_features sẽ tự động bị bỏ qua.
  • input_ids (torch.LongTensor có shape (batch_size, sequence_length), tùy chọn) — Tokens của văn bản đầu vào. Được xử lý từ ClvpTokenizer. Nếu speech_ids không được cung cấp, thì input_ids và input_features sẽ được sử dụng.
  • conditioning_encoder_inputs_embeds (torch.FloatTensor, tùy chọn) — inputs_embeds cho ClvpConditioningEncoder. Có thể được sử dụng thay cho input_ids.
  • attention_mask (torch.LongTensor có shape (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện attention trên các chỉ số token thoại đệm. Các giá trị mặt nạ được chọn trong [0, 1]:
    • 1 cho các token không bị che,
    • 0 cho các token bị che.

    Mặt nạ chú ý là gì?

  • generation_config (GenerationConfig, tùy chọn) — cấu hình sinh để kiểm soát việc sinh speech_ids nếu chúng không được cung cấp.

Trả về

torch.FloatTensor có hình dạng (batch_size, output_dim)

Các embedding giọng nói thu được bằng cách áp dụng lớp chiếu lên đầu ra đã được pool của Mô hình Giọng nói CLVP.

Phương pháp này có thể được sử dụng để trích xuất speech_embeds. Các speech embeddings được thu được bằng cách áp dụng mô hình speech lên speech_ids. Nếu speech_ids không có nhưng cả input_ids và input_features đều được cung cấp thì mô hình decoder sẽ được sử dụng để trước tiên tạo ra speech_ids và sau đó áp dụng mô hình speech.

Ví dụ:

>>> import datasets
>>> from transformers import ClvpProcessor, ClvpModelForConditionalGeneration

>>> # Define the Text and Load the Audio (We are taking an audio example from HuggingFace Hub using `datasets` library)
>>> text = "This is an example text."
>>> ds = datasets.load_dataset("hf-internal-testing/librispeech_asr_dummy", "clean", split="validation")
>>> ds = ds.cast_column("audio", datasets.Audio(sampling_rate=22050))
>>> audio = ds.sort("id")["audio"][0]
>>> audio_sample, sr = audio["array"], audio["sampling_rate"]

>>> # Define processor and model
>>> processor = ClvpProcessor.from_pretrained("susnato/clvp_dev")
>>> model = ClvpModelForConditionalGeneration.from_pretrained("susnato/clvp_dev")

>>> # Generate processor output and model output
>>> processor_output = processor(raw_speech=audio_sample, sampling_rate=sr, text=text, return_tensors="pt")
>>> speech_embeds = model.get_speech_features(
...     input_ids=processor_output["input_ids"], input_features=processor_output["input_features"]
... )

ClvpForCausalLM

lớp transformers.ClvpForCausalLM

< >

( config: ClvpDecoderConfig )

Tham số

  • config (ClvpDecoderConfig) — Lớp cấu hình mô hình chứa tất cả các tham số của mô hình. Khởi tạo bằng tệp cấu hình không tải trọng số liên quan đến mô hình, chỉ tải cấu hình. Xem phương thức from_pretrained() để tải trọng số mô hình.

Mô hình giải mã CLVP có đầu mô hình hóa ngôn ngữ ở phía trên.

Mô hình này kế thừa từ PreTrainedModel. Xem tài liệu của lớp cha để biết các phương thức chung mà thư viện triển khai cho tất cả các mô hình của nó (chẳng hạn như tải xuống hoặc lưu trữ, thay đổi kích thước các nhúng đầu vào, cắt tỉa các đầu, v.v.)

Mô hình này cũng là một lớp con của torch.nn.Module trong PyTorch. Hãy sử dụng nó như một Module PyTorch thông thường và tham khảo tài liệu PyTorch cho mọi vấn đề liên quan đến cách sử dụng và hành vi chung.

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneattention_mask: typing.Optional[torch.FloatTensor] = Nonetoken_type_ids: typing.Optional[torch.LongTensor] = Noneposition_ids: typing.Optional[torch.LongTensor] = Noneinputs_embeds: typing.Optional[torch.FloatTensor] = Nonelabels: typing.Optional[torch.LongTensor] = Noneuse_cache: bool | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)

Tham số

  • input_ids (torch.LongTensor có dạng (batch_size, sequence_length), tùy chọn) — Chỉ số của các token trong chuỗi đầu vào theo từ điển. Mặc định, padding sẽ bị bỏ qua.

    Các chỉ số có thể được lấy bằng cách sử dụng AutoTokenizer. Xem PreTrainedTokenizer.encode() và PreTrainedTokenizer.call() để biết thêm chi tiết.

    ID đầu vào là gì?

  • past_key_values (~cache_utils.Cache, tuỳ chọn) — Các hidden-state đã tính trước (key và value trong các khối self-attention và cross-attention) có thể được sử dụng để tăng tốc giải mã tuần tự. Điều này thường bao gồm past_key_values được trả về bởi mô hình ở một giai đoạn giải mã trước đó, khi use_cache=True hoặc config.use_cache=True.

    Chỉ cho phép Cache instance làm đầu vào, xem hướng dẫn kv cache của chúng tôi. Nếu không truyền past_key_values, DynamicCache sẽ được khởi tạo theo mặc định.

    Mô hình sẽ xuất ra cùng định dạng cache được đưa vào làm đầu vào.

    Nếu past_key_values được sử dụng, người dùng được kỳ vọng chỉ nhập input_ids chưa được xử lý (những phần chưa có trạng thái key value quá khứ được cung cấp cho mô hình này) có hình dạng (batch_size, unprocessed_length) thay vì toàn bộ input_ids có hình dạng (batch_size, sequence_length).

  • attention_mask (torch.FloatTensor có shape (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện attention trên các chỉ số token padding. Các giá trị mặt nạ được chọn trong [0, 1]:
    • 1 cho các token không bị che,
    • 0 cho các token bị che.

    Mặt nạ chú ý là gì?

  • token_type_ids (torch.LongTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Chỉ số token phân đoạn để chỉ định phần đầu và phần thứ hai của đầu vào. Các chỉ số được chọn trong [0, 1]:
    • 0 tương ứng với một token sentence A,
    • 1 tương ứng với một token sentence B.

    ID loại token là gì?

  • position_ids (torch.LongTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Chỉ số vị trí của các token trong mỗi chuỗi đầu vào trong các position embeddings. Được chọn trong khoảng [0, config.n_positions - 1].

    ID vị trí là gì?

  • inputs_embeds (torch.FloatTensor có hình dạng (batch_size, sequence_length, hidden_size), tùy chọn) — Tùy chọn, thay vì truyền input_ids, bạn có thể chọn truyền trực tiếp một biểu diễn nhúng. Điều này hữu ích nếu bạn muốn kiểm soát nhiều hơn cách chuyển đổi các chỉ số input_ids thành các vector liên quan so với ma trận tra cứu nhúng nội bộ của mô hình.
  • labels (torch.LongTensor có shape (batch_size, sequence_length), tùy chọn) — Nhãn cho mô hình hóa ngôn ngữ. Lưu ý rằng các nhãn được dịch chuyển bên trong mô hình, tức là bạn có thể đặt labels = input_ids Các chỉ số được chọn trong [-100, 0, ..., config.vocab_size] Tất cả các nhãn được đặt thành -100 sẽ bị bỏ qua (che), loss chỉ được tính cho các nhãn trong [0, ..., config.vocab_size]
  • use_cache (bool, tùy chọn) — Nếu đặt thành True, các trạng thái key value của past_key_values sẽ được trả về và có thể được sử dụng để tăng tốc quá trình giải mã (xem past_key_values).

Trả về

CausalLMOutputWithCrossAttentions hoặc tuple(torch.FloatTensor)

Một CausalLMOutputWithCrossAttentions hoặc một tuple của torch.FloatTensor (nếu return_dict=False được truyền hoặc khi config.return_dict=False) bao gồm các thành phần khác nhau tùy thuộc vào cấu hình (ClvpConfig) và đầu vào.

Phương thức forward của ClvpForCausalLM ghi đè lên phương thức đặc biệt __call__.

Mặc dù công thức cho bước truyền tiến cần được định nghĩa bên trong hàm này, người dùng nên gọi instance của Module sau đó thay vì gọi hàm này, vì instance Module sẽ đảm nhận việc thực hiện các bước tiền xử lý và hậu xử lý, trong khi hàm này sẽ lặng lẽ bỏ qua chúng.

  • loss (torch.FloatTensor có shape (1,), optional, được trả về khi labels được cung cấp) — Loss của language modeling (cho next-token prediction).

  • logits (torch.FloatTensor có hình dạng (batch_size, sequence_length, config.vocab_size)) — Điểm dự đoán của đầu mô hình hóa ngôn ngữ (điểm cho mỗi token từ vựng trước SoftMax).

  • hidden_states (tuple(torch.FloatTensor), tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Bộ tuple của torch.FloatTensor (một cho đầu ra của các embedding, nếu mô hình có lớp embedding, + một cho đầu ra của mỗi lớp) có hình dạng (batch_size, sequence_length, hidden_size).

    Trạng thái ẩn của mô hình tại đầu ra của mỗi lớp cùng với các đầu ra embedding ban đầu tùy chọn.

  • attentions (tuple(torch.FloatTensor), tuỳ chọn, được trả về khi output_attentions=True được truyền vào hoặc khi config.output_attentions=True) — Bộ tuple của torch.FloatTensor (một cho mỗi lớp) có hình dạng (batch_size, num_heads, sequence_length, sequence_length).

    Trọng số chú ý sau softmax của attention, được sử dụng để tính trung bình có trọng số trong các đầu self-attention.

  • cross_attentions (tuple(torch.FloatTensor), tùy chọn, được trả về khi output_attentions=True được truyền vào hoặc khi config.output_attentions=True) — Tuple của torch.FloatTensor (một cho mỗi lớp) có hình dạng (batch_size, num_heads, sequence_length, sequence_length).

    Trọng số của cross attention sau softmax của attention, được sử dụng để tính trung bình có trọng số trong các đầu cross-attention.

  • past_key_values (Cache, tùy chọn, được trả về khi use_cache=True được truyền vào hoặc khi config.use_cache=True) — Đây là một instance của Cache. Để biết thêm chi tiết, hãy xem hướng dẫn về kv cache của chúng tôi.

    Chứa các hidden-states đã được tính trước (key và values trong các khối attention) có thể được sử dụng (xem đầu vào past_key_values) để tăng tốc độ giải mã tuần tự.

ClvpModel

lớp transformers.ClvpModel

< >

( config: ClvpDecoderConfig )

Tham số

  • config (ClvpDecoderConfig) — Lớp cấu hình mô hình chứa tất cả các tham số của mô hình. Khởi tạo bằng tệp cấu hình không tải trọng số liên quan đến mô hình, chỉ tải cấu hình. Xem phương thức from_pretrained() để tải trọng số mô hình.

Mô hình Clvp cơ bản, xuất ra các hidden-state thô mà không có bất kỳ head cụ thể nào ở phía trên.

Mô hình này kế thừa từ PreTrainedModel. Xem tài liệu của lớp cha để biết các phương thức chung mà thư viện triển khai cho tất cả các mô hình của nó (chẳng hạn như tải xuống hoặc lưu trữ, thay đổi kích thước các nhúng đầu vào, cắt tỉa các đầu, v.v.)

Mô hình này cũng là một lớp con của torch.nn.Module trong PyTorch. Hãy sử dụng nó như một Module PyTorch thông thường và tham khảo tài liệu PyTorch cho mọi vấn đề liên quan đến cách sử dụng và hành vi chung.

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.FloatTensor] = Nonetoken_type_ids: typing.Optional[torch.LongTensor] = Noneposition_ids: typing.Optional[torch.LongTensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.FloatTensor] = Noneuse_cache: bool | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → BaseModelOutputWithPastAndCrossAttentions or tuple(torch.FloatTensor)

Tham số

  • input_ids (torch.LongTensor có dạng (batch_size, sequence_length), tùy chọn) — Chỉ số của các token trong chuỗi đầu vào theo từ điển. Mặc định, padding sẽ bị bỏ qua.

    Các chỉ số có thể được lấy bằng cách sử dụng AutoTokenizer. Xem PreTrainedTokenizer.encode() và PreTrainedTokenizer.call() để biết thêm chi tiết.

    ID đầu vào là gì?

  • attention_mask (torch.FloatTensor có shape (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện attention trên các chỉ số token padding. Các giá trị mặt nạ được chọn trong [0, 1]:
    • 1 cho các token không bị che,
    • 0 cho các token bị che.

    Mặt nạ chú ý là gì?

  • token_type_ids (torch.LongTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Chỉ số token phân đoạn để chỉ định phần đầu và phần thứ hai của đầu vào. Các chỉ số được chọn trong [0, 1]:
    • 0 tương ứng với một token sentence A,
    • 1 tương ứng với một token sentence B.

    ID loại token là gì?

  • position_ids (torch.LongTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Chỉ số vị trí của các token trong mỗi chuỗi đầu vào trong các position embeddings. Được chọn trong khoảng [0, config.n_positions - 1].

    ID vị trí là gì?

  • past_key_values (~cache_utils.Cache, tuỳ chọn) — Các hidden-state đã tính trước (key và value trong các khối self-attention và cross-attention) có thể được sử dụng để tăng tốc giải mã tuần tự. Điều này thường bao gồm past_key_values được trả về bởi mô hình ở một giai đoạn giải mã trước đó, khi use_cache=True hoặc config.use_cache=True.

    Chỉ cho phép Cache instance làm đầu vào, xem hướng dẫn kv cache của chúng tôi. Nếu không truyền past_key_values, DynamicCache sẽ được khởi tạo theo mặc định.

    Mô hình sẽ xuất ra cùng định dạng cache được đưa vào làm đầu vào.

    Nếu past_key_values được sử dụng, người dùng được kỳ vọng chỉ nhập input_ids chưa được xử lý (những phần chưa có trạng thái key value quá khứ được cung cấp cho mô hình này) có hình dạng (batch_size, unprocessed_length) thay vì toàn bộ input_ids có hình dạng (batch_size, sequence_length).

  • inputs_embeds (torch.FloatTensor có hình dạng (batch_size, sequence_length, hidden_size), tùy chọn) — Tùy chọn, thay vì truyền input_ids, bạn có thể chọn truyền trực tiếp một biểu diễn nhúng. Điều này hữu ích nếu bạn muốn kiểm soát nhiều hơn cách chuyển đổi các chỉ số input_ids thành các vector liên quan so với ma trận tra cứu nhúng nội bộ của mô hình.
  • use_cache (bool, tùy chọn) — Nếu đặt thành True, các trạng thái key value của past_key_values sẽ được trả về và có thể được sử dụng để tăng tốc quá trình giải mã (xem past_key_values).

Trả về

BaseModelOutputWithPastAndCrossAttentions hoặc tuple(torch.FloatTensor)

Một BaseModelOutputWithPastAndCrossAttentions hoặc một tuple của torch.FloatTensor (nếu return_dict=False được truyền hoặc khi config.return_dict=False) bao gồm các thành phần khác nhau tùy thuộc vào cấu hình (ClvpConfig) và đầu vào.

Phương thức forward của ClvpModel ghi đè lên phương thức đặc biệt __call__.

Mặc dù công thức cho bước truyền tiến cần được định nghĩa bên trong hàm này, người dùng nên gọi instance của Module sau đó thay vì gọi hàm này, vì instance Module sẽ đảm nhận việc thực hiện các bước tiền xử lý và hậu xử lý, trong khi hàm này sẽ lặng lẽ bỏ qua chúng.

  • last_hidden_state (torch.FloatTensor có hình dạng (batch_size, sequence_length, hidden_size)) — Chuỗi các hidden-state tại đầu ra của lớp cuối cùng của mô hình.

    Nếu past_key_values được sử dụng, chỉ có hidden-state cuối cùng của các chuỗi có shape (batch_size, 1, hidden_size) được xuất ra.

  • past_key_values (Cache, tùy chọn, được trả về khi use_cache=True được truyền vào hoặc khi config.use_cache=True) — Đây là một instance của Cache. Để biết thêm chi tiết, hãy xem hướng dẫn về kv cache của chúng tôi.

    Chứa các hidden-states đã được tính trước (key và values trong các khối self-attention và tùy chọn nếu config.is_encoder_decoder=True trong các khối cross-attention) có thể được sử dụng (xem đầu vào past_key_values) để tăng tốc độ giải mã tuần tự.

  • hidden_states (tuple(torch.FloatTensor), tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Bộ tuple của torch.FloatTensor (một cho đầu ra của các embedding, nếu mô hình có lớp embedding, + một cho đầu ra của mỗi lớp) có hình dạng (batch_size, sequence_length, hidden_size).

    Trạng thái ẩn của mô hình tại đầu ra của mỗi lớp cùng với các đầu ra embedding ban đầu tùy chọn.

  • attentions (tuple(torch.FloatTensor), tuỳ chọn, được trả về khi output_attentions=True được truyền vào hoặc khi config.output_attentions=True) — Bộ tuple của torch.FloatTensor (một cho mỗi lớp) có hình dạng (batch_size, num_heads, sequence_length, sequence_length).

    Trọng số chú ý sau softmax của attention, được sử dụng để tính trung bình có trọng số trong các đầu self-attention.

  • cross_attentions (tuple(torch.FloatTensor), tùy chọn, được trả về khi output_attentions=True và config.add_cross_attention=True được truyền vào hoặc khi config.output_attentions=True) — Bộ tuple của torch.FloatTensor (một cho mỗi lớp) có hình dạng (batch_size, num_heads, sequence_length, sequence_length).

    Trọng số chú ý của lớp cross-attention của bộ giải mã, sau softmax chú ý, được sử dụng để tính trung bình có trọng số trong các đầu chú ý chéo.

ClvpEncoder

lớp transformers.ClvpEncoder

< >

( config: ClvpEncoderConfig )

Tham số

  • config — ClvpConfig

Bộ mã hóa Transformer gồm config.num_hidden_layers lớp self attention. Mỗi lớp là một ClvpEncoderLayer.

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = Noneinputs_embeds: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.LongTensor] = Noneposition_ids: typing.Optional[torch.LongTensor] = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → ClvpEncoderOutput or tuple(torch.FloatTensor)

Tham số

  • input_ids (torch.LongTensor có dạng (batch_size, sequence_length), tùy chọn) — Chỉ số của các token trong chuỗi đầu vào theo từ điển. Mặc định, padding sẽ bị bỏ qua.

    Các chỉ số có thể được lấy bằng cách sử dụng AutoTokenizer. Xem PreTrainedTokenizer.encode() và PreTrainedTokenizer.call() để biết thêm chi tiết.

    ID đầu vào là gì?

  • inputs_embeds (torch.LongTensor có hình dạng (batch_size, sequence_length, hidden_size), tùy chọn) — Tùy chọn, thay vì truyền input_ids, bạn có thể chọn truyền trực tiếp một biểu diễn đã nhúng. Điều này hữu ích nếu bạn muốn kiểm soát nhiều hơn cách chuyển đổi các chỉ số input_ids thành các vector tương ứng so với ma trận tra cứu nhúng nội bộ của mô hình.
  • attention_mask (torch.LongTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện attention trên các chỉ số token padding. Các giá trị mặt nạ được chọn trong [0, 1]:
    • 1 cho các token không bị che,
    • 0 cho các token bị che.

    Mặt nạ chú ý là gì?

  • position_ids (torch.LongTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Chỉ số vị trí của các token trong mỗi chuỗi đầu vào trong các position embeddings. Được chọn trong khoảng [0, config.n_positions - 1].

    ID vị trí là gì?

Trả về

ClvpEncoderOutput hoặc tuple(torch.FloatTensor)

Một ClvpEncoderOutput hoặc một tuple của torch.FloatTensor (nếu return_dict=False được truyền hoặc khi config.return_dict=False) bao gồm các thành phần khác nhau tùy thuộc vào cấu hình (ClvpConfig) và đầu vào.

Phương thức forward của ClvpEncoder ghi đè lên phương thức đặc biệt __call__.

Mặc dù công thức cho bước truyền tiến cần được định nghĩa bên trong hàm này, người dùng nên gọi instance của Module sau đó thay vì gọi hàm này, vì instance Module sẽ đảm nhận việc thực hiện các bước tiền xử lý và hậu xử lý, trong khi hàm này sẽ lặng lẽ bỏ qua chúng.

  • embeds (torch.FloatTensor có shape (batch_size, output_dim), optional, được trả về khi model được khởi tạo với with_projection=True) — Các embeddings thu được bằng cách áp dụng lớp projection lên pooler_output.

  • last_hidden_state (torch.FloatTensor có hình dạng (batch_size, sequence_length, hidden_size)) — Trạng thái ẩn của lớp cuối cùng của mô hình.

  • pooler_output (torch.FloatTensor có hình dạng (batch_size, hidden_size)) — Đầu ra đã được pool của last_hidden_state.

  • hidden_states (tuple[torch.FloatTensor], tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Bộ tuple các torch.FloatTensor (một cho đầu ra của embeddings, nếu mô hình có lớp embedding, + một cho đầu ra của mỗi lớp) có hình dạng (batch_size, sequence_length, hidden_size).

    Trạng thái ẩn của mô hình tại đầu ra của mỗi lớp cùng với các đầu ra embedding ban đầu tùy chọn.

  • attentions (tuple[torch.FloatTensor], tuỳ chọn, được trả về khi output_attentions=True được truyền vào hoặc khi config.output_attentions=True) — Bộ tuple của torch.FloatTensor (một cho mỗi lớp) có hình dạng (batch_size, num_heads, sequence_length, sequence_length).

    Trọng số chú ý sau softmax của attention, được sử dụng để tính trung bình có trọng số trong các đầu self-attention.

ClvpDecoder

lớp transformers.ClvpDecoder

< >

( config: ClvpDecoderConfig )

Bộ giải mã Transformer gồm config.num_hidden_layers lớp. Mỗi lớp là một ClvpDecoderLayer

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.FloatTensor] = Nonetoken_type_ids: typing.Optional[torch.LongTensor] = Noneposition_ids: typing.Optional[torch.LongTensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.FloatTensor] = Noneuse_cache: bool | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → BaseModelOutputWithPastAndCrossAttentions or tuple(torch.FloatTensor)

Tham số

  • input_ids (torch.LongTensor có dạng (batch_size, sequence_length), tùy chọn) — Chỉ số của các token trong chuỗi đầu vào theo từ điển. Mặc định, padding sẽ bị bỏ qua.

    Các chỉ số có thể được lấy bằng cách sử dụng AutoTokenizer. Xem PreTrainedTokenizer.encode() và PreTrainedTokenizer.call() để biết thêm chi tiết.

    ID đầu vào là gì?

  • attention_mask (torch.FloatTensor có shape (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện attention trên các chỉ số token padding. Các giá trị mặt nạ được chọn trong [0, 1]:
    • 1 cho các token không bị che,
    • 0 cho các token bị che.

    Mặt nạ chú ý là gì?

  • token_type_ids (torch.LongTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Chỉ số token phân đoạn để chỉ định phần đầu và phần thứ hai của đầu vào. Các chỉ số được chọn trong [0, 1]:
    • 0 tương ứng với một token sentence A,
    • 1 tương ứng với một token sentence B.

    ID loại token là gì?

  • position_ids (torch.LongTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Chỉ số vị trí của các token trong mỗi chuỗi đầu vào trong các position embeddings. Được chọn trong khoảng [0, config.n_positions - 1].

    ID vị trí là gì?

  • past_key_values (~cache_utils.Cache, tuỳ chọn) — Các hidden-state đã tính trước (key và value trong các khối self-attention và cross-attention) có thể được sử dụng để tăng tốc giải mã tuần tự. Điều này thường bao gồm past_key_values được trả về bởi mô hình ở một giai đoạn giải mã trước đó, khi use_cache=True hoặc config.use_cache=True.

    Chỉ cho phép Cache instance làm đầu vào, xem hướng dẫn kv cache của chúng tôi. Nếu không truyền past_key_values, DynamicCache sẽ được khởi tạo theo mặc định.

    Mô hình sẽ xuất ra cùng định dạng cache được đưa vào làm đầu vào.

    Nếu past_key_values được sử dụng, người dùng được kỳ vọng chỉ nhập input_ids chưa được xử lý (những phần chưa có trạng thái key value quá khứ được cung cấp cho mô hình này) có hình dạng (batch_size, unprocessed_length) thay vì toàn bộ input_ids có hình dạng (batch_size, sequence_length).

  • inputs_embeds (torch.FloatTensor có hình dạng (batch_size, sequence_length, hidden_size), tùy chọn) — Tùy chọn, thay vì truyền input_ids, bạn có thể chọn truyền trực tiếp một biểu diễn nhúng. Điều này hữu ích nếu bạn muốn kiểm soát nhiều hơn cách chuyển đổi các chỉ số input_ids thành các vector liên quan so với ma trận tra cứu nhúng nội bộ của mô hình.
  • use_cache (bool, tùy chọn) — Nếu đặt thành True, các trạng thái key value của past_key_values sẽ được trả về và có thể được sử dụng để tăng tốc quá trình giải mã (xem past_key_values).

Trả về

BaseModelOutputWithPastAndCrossAttentions hoặc tuple(torch.FloatTensor)

Một BaseModelOutputWithPastAndCrossAttentions hoặc một tuple của torch.FloatTensor (nếu return_dict=False được truyền hoặc khi config.return_dict=False) bao gồm các thành phần khác nhau tùy thuộc vào cấu hình (ClvpConfig) và đầu vào.

Phương thức forward của ClvpDecoder ghi đè lên phương thức đặc biệt __call__.

Mặc dù công thức cho bước truyền tiến cần được định nghĩa bên trong hàm này, người dùng nên gọi instance của Module sau đó thay vì gọi hàm này, vì instance Module sẽ đảm nhận việc thực hiện các bước tiền xử lý và hậu xử lý, trong khi hàm này sẽ lặng lẽ bỏ qua chúng.

  • last_hidden_state (torch.FloatTensor có hình dạng (batch_size, sequence_length, hidden_size)) — Chuỗi các hidden-state tại đầu ra của lớp cuối cùng của mô hình.

    Nếu past_key_values được sử dụng, chỉ có hidden-state cuối cùng của các chuỗi có shape (batch_size, 1, hidden_size) được xuất ra.

  • past_key_values (Cache, tùy chọn, được trả về khi use_cache=True được truyền vào hoặc khi config.use_cache=True) — Đây là một instance của Cache. Để biết thêm chi tiết, hãy xem hướng dẫn về kv cache của chúng tôi.

    Chứa các hidden-states đã được tính trước (key và values trong các khối self-attention và tùy chọn nếu config.is_encoder_decoder=True trong các khối cross-attention) có thể được sử dụng (xem đầu vào past_key_values) để tăng tốc độ giải mã tuần tự.

  • hidden_states (tuple(torch.FloatTensor), tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Bộ tuple của torch.FloatTensor (một cho đầu ra của các embedding, nếu mô hình có lớp embedding, + một cho đầu ra của mỗi lớp) có hình dạng (batch_size, sequence_length, hidden_size).

    Trạng thái ẩn của mô hình tại đầu ra của mỗi lớp cùng với các đầu ra embedding ban đầu tùy chọn.

  • attentions (tuple(torch.FloatTensor), tuỳ chọn, được trả về khi output_attentions=True được truyền vào hoặc khi config.output_attentions=True) — Bộ tuple của torch.FloatTensor (một cho mỗi lớp) có hình dạng (batch_size, num_heads, sequence_length, sequence_length).

    Trọng số chú ý sau softmax của attention, được sử dụng để tính trung bình có trọng số trong các đầu self-attention.

  • cross_attentions (tuple(torch.FloatTensor), tùy chọn, được trả về khi output_attentions=True và config.add_cross_attention=True được truyền vào hoặc khi config.output_attentions=True) — Bộ tuple của torch.FloatTensor (một cho mỗi lớp) có hình dạng (batch_size, num_heads, sequence_length, sequence_length).

    Trọng số chú ý của lớp cross-attention của bộ giải mã, sau softmax chú ý, được sử dụng để tính trung bình có trọng số trong các đầu chú ý chéo.

Update on GitHub