Hugging Face's logo

Transformers documentation

XLNet

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v5.22.2).
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 19-06-2019 và được đóng góp cho Hugging Face Transformers vào ngày 16-11-2020.

XLNet

Tổng quan

Mô hình XLNet được đề xuất trong XLNet: Generalized Autoregressive Pretraining for Language Understanding bởi Zhilin Yang, Zihang Dai, Yiming Yang, Jaime Carbonell, Ruslan Salakhutdinov, Quoc V. Le. XLnet là một phần mở rộng của mô hình Transformer-XL, được huấn luyện trước bằng phương pháp tự hồi quy để học ngữ cảnh hai chiều bằng cách tối đa hóa khả năng kỳ vọng trên tất cả các hoán vị của thứ tự phân tích chuỗi đầu vào.

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

Với khả năng mô hình hóa ngữ cảnh hai chiều, phương pháp tiền huấn luyện dựa trên tự mã hóa khử nhiễu như BERT đạt hiệu suất tốt hơn so với các phương pháp tiền huấn luyện dựa trên mô hình hóa ngôn ngữ tự hồi quy. Tuy nhiên, do phụ thuộc vào việc làm hỏng đầu vào bằng các mặt nạ, BERT bỏ qua sự phụ thuộc giữa các vị trí bị che và gặp phải sự khác biệt giữa tiền huấn luyện và tinh chỉnh. Trước những ưu và nhược điểm này, chúng tôi đề xuất XLNet, một phương pháp tiền huấn luyện tự hồi quy tổng quát hóa, (1) cho phép học ngữ cảnh hai chiều bằng cách tối đa hóa khả năng kỳ vọng trên tất cả các hoán vị của thứ tự phân tích và (2) khắc phục các hạn chế của BERT nhờ công thức tự hồi quy. Hơn nữa, XLNet tích hợp các ý tưởng từ Transformer-XL, mô hình tự hồi quy tiên tiến nhất, vào quá trình tiền huấn luyện. Về mặt thực nghiệm, trong các cài đặt thí nghiệm tương đương, XLNet vượt trội hơn BERT trên 20 tác vụ, thường với khoảng cách lớn, bao gồm trả lời câu hỏi, suy luận ngôn ngữ tự nhiên, phân tích cảm xúc và xếp hạng tài liệu.

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

Mẹo sử dụng

  • Mẫu chú ý cụ thể có thể được kiểm soát ở thời điểm huấn luyện và kiểm tra bằng cách sử dụng đầu vào perm_mask.
  • Do khó khăn trong việc huấn luyện một mô hình tự hồi quy hoàn toàn trên nhiều thứ tự phân tích khác nhau, XLNet được tiền huấn luyện bằng cách chỉ sử dụng một tập con các token đầu ra làm mục tiêu, được chọn thông qua đầu vào target_mapping.
  • Để sử dụng XLNet cho giải mã tuần tự (tức là không trong cài đặt hai chiều hoàn toàn), hãy sử dụng các đầu vào perm_mask và target_mapping để kiểm soát phạm vi chú ý và các đầu ra
  • XLNet là một trong số ít các mô hình không có giới hạn về độ dài chuỗi.
  • XLNet không phải là một mô hình tự hồi quy truyền thống mà sử dụng một chiến lược huấn luyện dựa trên đó. Nó hoán vị các token trong câu, sau đó cho phép mô hình sử dụng n token cuối cùng để dự đoán token n+1. Vì tất cả đều được thực hiện với một mask, câu thực tế được đưa vào mô hình theo đúng thứ tự, nhưng thay vì mask n token đầu tiên cho n+1, XLNet sử dụng một mask che đi các token trước đó trong một hoán vị nhất định của 1,…,độ dài chuỗi.
  • XLNet cũng sử dụng cùng cơ chế lặp lại như Transformer-XL để xây dựng các phụ thuộc dài hạn.

Tài nguyên

XLNetConfig

lớp transformers.XLNetConfig

< >

( 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 = 32000d_model: int = 1024n_layer: int = 24n_head: int = 16d_inner: int = 4096d_head: int | None = Noneff_activation: str = 'gelu'attn_type: str = 'bi'initializer_range: float = 0.02layer_norm_eps: float = 1e-12dropout: float | int = 0.1mem_len: int | None = 512reuse_len: int | None = Noneuse_mems_eval: bool = Trueuse_mems_train: bool = Falsebi_data: bool = Falseclamp_len: int = -1same_length: bool = Falsesummary_type: str = 'last'summary_use_proj: bool = Truesummary_activation: str = 'tanh'summary_last_dropout: float | int = 0.1start_n_top: int = 5end_n_top: int = 5pad_token_id: int | None = 5bos_token_id: int | None = 1eos_token_id: int | list[int] | None = 2tie_word_embeddings: bool = True )

Tham số

  • vocab_size (int, tùy chọn, mặc định là 32000) — 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.
  • d_model (int, tùy chọn, mặc định là 1024) — Kích thước của các lớp encoder và lớp pooler.
  • n_layer (int, tùy chọn, mặc định là 24) — Số lượng lớp ẩn trong bộ giải mã Transformer.
  • n_head (int, tùy chọn, mặc định là 16) — Số lượng đầu chú ý cho mỗi lớp chú ý trong bộ giải mã Transformer.
  • d_inner (int, tùy chọn, mặc định là 4096) — Kích thước của các biểu diễn MLP.
  • d_head (int, tùy chọn) — Kích thước chiều của đầu chú ý. Nếu là None, giá trị mặc định sẽ là hidden_size // num_attention_heads
  • ff_activation (str hoặc Callable, tùy chọn, mặc định là "gelu") — Hàm kích hoạt phi tuyến tính (hàm hoặc chuỗi). Nếu là chuỗi, "gelu", "relu", "silu" và "gelu_new" được hỗ trợ.
  • attn_type (str, tùy chọn, mặc định là "bi") — Loại attention được mô hình sử dụng. Đặt "bi" cho XLNet, "uni" cho Transformer-XL.
  • 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ố.
  • layer_norm_eps (float, tùy chọn, mặc định là 1e-12) — Giá trị epsilon được sử dụng bởi các lớp chuẩn hóa lớp (layer normalization).
  • 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.
  • mem_len (int hoặc None, tùy chọn) — Số lượng token cần lưu vào bộ nhớ đệm. Các cặp khóa/giá trị đã được tính toán trước trong một lần truyền tiến trước đó sẽ không được tính lại. Xem hướng dẫn nhanh để biết thêm thông tin.
  • reuse_len (int, tùy chọn) — Số lượng token trong batch hiện tại sẽ được lưu vào bộ nhớ đệm và tái sử dụng trong tương lai.
  • use_mems_eval (bool, tùy chọn, mặc định là True) — Xác định xem mô hình có nên sử dụng cơ chế bộ nhớ đệ quy ở chế độ đánh giá hay không.
  • use_mems_train (bool, tùy chọn, mặc định là False) — Xác định xem mô hình có nên sử dụng cơ chế bộ nhớ đệ quy ở chế độ huấn luyện hay không.
    Đối với tiền huấn luyện, khuyến nghị đặt `use_mems_train` thành `True`. Đối với tinh chỉnh, khuyến nghị đặt `use_mems_train` thành `False` như đã thảo luận [tại đây](https://github.com/zihangdai/xlnet/issues/41#issuecomment-505102587). Nếu `use_mems_train` được đặt thành `True`, cần đảm bảo rằng các lô huấn luyện được tiền xử lý chính xác, *ví dụ* `batch_1 = [[This line is], [This is the]]` và `batch_2 = [[ the first line], [ second line]]` và tất cả các lô đều có cùng kích thước.
  • bi_data (bool, tùy chọn, mặc định là False) — Có sử dụng đường ống đầu vào hai chiều hay không. Thường được đặt thành True trong quá trình pretraining và False trong quá trình finetuning.
  • clamp_len (int, tùy chọn, mặc định là -1) — Giới hạn tất cả các khoảng cách tương đối lớn hơn clamp_len. Đặt thuộc tính này thành -1 có nghĩa là không giới hạn.
  • same_length (bool, tùy chọn, mặc định là False) — Có sử dụng cùng một độ dài chú ý cho từng token hay không.
  • summary_type (str, tuỳ chọn, mặc định là “last”) — Lập luận được sử dụng khi thực hiện tóm tắt chuỗi. Được dùng trong các mô hình phân loại chuỗi và lựa chọn nhiều phương án. 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) — Tham số được sử dụng khi thực hiện tóm tắt chuỗi. Được dùng trong các mô hình phân loại chuỗi và lựa chọn nhiều phương án. Xác định 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) — Tham số được sử dụng khi thực hiện tóm tắt chuỗi. Được dùng trong các mô hình phân loại chuỗi và lựa chọn nhiều phương á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_last_dropout (float, tùy chọn, mặc định là 0.1) — Được sử dụng trong các mô hình phân loại chuỗi và lựa chọn nhiều phương án. Tỷ lệ dropout được sử dụng sau phép chiếu và hàm kích hoạt.
  • start_n_top (int, tùy chọn, mặc định là 5) — Được sử dụng trong script đánh giá SQuAD.
  • end_n_top (int, tùy chọn, mặc định là 5) — Được sử dụng trong script đánh giá SQuAD.
  • pad_token_id (int, tùy chọn, mặc định là 5) — Token id được sử dụng để đệm (padding) trong từ vựng.
  • bos_token_id (int, tùy chọn, mặc định là 1) — 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à 2) — Token id được sử dụng cho end-of-stream trong bảng từ vựng.
  • tie_word_embeddings (bool, tùy chọn, mặc định là True) — Có nên gắn kết các trọng số nhúng theo ánh xạ tied_weights_keys của 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 XLNetModel. Nó được sử dụng để khởi tạo một mô hình Xlnet 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 xlnet/xlnet-large-cased

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 XLNetConfig, XLNetModel

>>> # Initializing a XLNet configuration
>>> configuration = XLNetConfig()

>>> # Initializing a model (with random weights) from the configuration
>>> model = XLNetModel(configuration)

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

XLNetTokenizer

lớp transformers.XLNetTokenizer

< >

( vocab: str | list[tuple[str, float]] | None = Noneunk_id: int = 0do_lower_case = Falseremove_space = Truekeep_accents = Falsebos_token = '<s>'eos_token = '</s>'unk_token = '<unk>'sep_token = '<sep>'pad_token = '<pad>'cls_token = '<cls>'mask_token = '<mask>'_spm_precompiled_charsmap = Noneadditional_special_tokens = None**kwargs )

Tham số

  • vocab (list of tuples, tuỳ chọn) — Danh sách các tuple (token, score) cho mô hình Unigram. Nếu không được cung cấp, một danh sách rỗng sẽ được sử dụng.
  • unk_id (int, tùy chọn, mặc định là 0) — ID của token không xác định trong từ vựng.
  • do_lower_case (bool, tùy chọn, mặc định là False) — Có nên chuyển đầu vào sang chữ thường khi phân tách token hay không.
  • remove_space (bool, tùy chọn, mặc định là True) — Có nên loại bỏ khoảng trắng khi phân tách token (xóa các khoảng trắng thừa trước và sau chuỗi) hay không.
  • keep_accents (bool, tùy chọn, mặc định là False) — Có giữ dấu khi phân tách token hay không.
  • bos_token (str, tuỳ chọn, mặc định là "<s>") — Token bắt đầu chuỗi được sử dụng trong quá trình pretraining. Có thể được dùng làm token phân loại chuỗi. Khi xây dựng một chuỗi bằng các token đặc biệt, đây không phải là token được dùng cho phần bắt đầu của chuỗi. Token được dùng là cls_token.

    Khi xây dựng một chuỗi sử dụng các token đặc biệt, đây không phải là token được dùng cho phần đầu của chuỗi. Token được sử dụng là cls_token.

  • eos_token (str, tuỳ chọn, mặc định là "</s>") — Token kết thúc chuỗi. Khi xây dựng một chuỗi bằng các token đặc biệt, đây không phải là token được dùng cho kết thúc chuỗi. Token được dùng là sep_token.

    Khi xây dựng một chuỗi bằng các token đặc biệt, đây không phải là token được sử dụng cho kết thúc chuỗi. Token được sử dụng là sep_token.

  • 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ế.
  • sep_token (str, tùy chọn, mặc định là "<sep>") — Token phân cách, được sử dụng khi xây dựng một chuỗi từ nhiều chuỗi, ví dụ như hai chuỗi cho phân loại chuỗi hoặc một văn bản và một câu hỏi cho trả lời câu hỏi. Nó cũng được sử dụng làm token cuối cùng của một chuỗi được xây dựng với các token đặc biệt.
  • pad_token (str, tùy chọn, mặc định là "<pad>") — Token được sử dụng để đệm, chẳng hạn khi xử lý các lô (batch) gồm các chuỗi có độ dài khác nhau.
  • cls_token (str, tùy chọn, mặc định là "<cls>") — Token phân loại được sử dụng khi thực hiện phân loại chuỗi (phân loại toàn bộ chuỗi thay vì phân loại theo từng token). Đây là token đầu tiên của chuỗi khi được xây dựng với các token đặc biệt.
  • mask_token (str, tùy chọn, mặc định là "<mask>") — Token được sử dụng để che các giá trị. Đây là token được dùng khi huấn luyện mô hình này với mô hình hóa ngôn ngữ có che (masked language modeling). Đây là token mà mô hình sẽ cố gắng dự đoán.
  • additional_special_tokens (list[str], tùy chọn, mặc định là ["<eop>", "<eod>"]) — Các token đặc biệt bổ sung được sử dụng bởi tokenizer.

Xây dựng bộ phân từ XLNet (dựa trên thư viện tokenizers của HuggingFace). Dựa trên Unigram.

Tokenizer này kế thừa từ TokenizersBackend, 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 lớp cha này để biết thêm thông tin về các phương thức đó.

get_special_tokens_mask

< >

( token_ids_0: list[int]token_ids_1: list[int] | None = Nonealready_has_special_tokens: bool = False ) → A list of integers in the range [0, 1]

Tham số

  • token_ids_0 — Danh sách các ID của chuỗi (có thể đã được định dạng).
  • token_ids_1 — Không được sử dụng khi already_has_special_tokens=True. Trong trường hợp đó, giá trị phải là None.
  • already_has_special_tokens — Xác định xem chuỗi đã được định dạng với các token đặc biệt hay chưa.

Trả về

Một danh sách các số nguyên trong khoảng [0, 1]

1 cho token đặc biệt, 0 cho token chuỗi.

Lấy các id chuỗi từ một danh sách token không có token đặc biệt nào được thêm vào.

Đối với các tokenizer nhanh, các data collator gọi hàm này với already_has_special_tokens=True để xây dựng một mask trên một chuỗi đã được định dạng sẵn. Trong trường hợp đó, chúng ta tính mask bằng cách kiểm tra sự thuộc về trong all_special_ids.

save_vocabulary

< >

( save_directory: strfilename_prefix: str | None = None )

Đầu ra cụ thể của XLNet

lớp transformers.models.xlnet.modeling_xlnet.XLNetModelOutput

< >

( last_hidden_state: Tensormems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )

Tham số

  • last_hidden_state (torch.Tensor có dạng (batch_size, num_predict, hidden_size)) — Chuỗi hidden-state ở lớp cuối cùng của model.

    num_predict tương ứng với target_mapping.shape[1]. Nếu target_mapping là None, thì num_predict tương ứng với sequence_length.

  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-states đã được tính toán trước. Có thể được sử dụng (xem đầu vào mems) để tăng tốc độ giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho mô hình này không nên được truyền dưới dạng input_ids vì chúng đã được tính toán.
  • hidden_states (tuple[torch.Tensor, ...], tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Tuple của torch.Tensor (một cho đầu ra của embeddings, nếu model có lớp embedding, + một cho đầu ra của mỗi lớp) có shape (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.Tensor, ...], tuỳ 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.Tensor (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.

Loại đầu ra của XLNetModel.

lớp transformers.models.xlnet.modeling_xlnet.XLNetLMHeadModelOutput

< >

( loss: typing.Optional[torch.Tensor] = Nonelogits: typing.Optional[torch.Tensor] = Nonemems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )

Tham số

  • loss (torch.Tensor có hình dạng (1,), tùy chọn, được trả về khi labels được cung cấp) — Mất mô hình hóa ngôn ngữ (cho dự đoán token tiếp theo).
  • logits (torch.Tensor có hình dạng (batch_size, num_predict, config.vocab_size)) — Điểm dự đoán của đầu mô hình ngôn ngữ (điểm cho mỗi token trong bảng từ vựng trước SoftMax).

    num_predict tương ứng với target_mapping.shape[1]. Nếu target_mapping là None, thì num_predict tương ứng với sequence_length.

  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-states đã được tính toán trước. Có thể được sử dụng (xem đầu vào mems) để tăng tốc độ giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho mô hình này không nên được truyền dưới dạng input_ids vì chúng đã được tính toán.
  • hidden_states (tuple[torch.Tensor, ...], tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Tuple của torch.Tensor (một cho đầu ra của embeddings, nếu model có lớp embedding, + một cho đầu ra của mỗi lớp) có shape (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.Tensor, ...], tuỳ 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.Tensor (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.

Loại đầu ra của XLNetLMHeadModel.

lớp transformers.models.xlnet.modeling_xlnet.XLNetForSequenceClassificationOutput

< >

( loss: typing.Optional[torch.Tensor] = Nonelogits: typing.Optional[torch.Tensor] = Nonemems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )

Tham số

  • loss (torch.Tensor có hình dạng (1,), tùy chọn, được trả về khi label được cung cấp) — Mất phân loại (hoặc hồi quy nếu config.num_labels==1).
  • logits (torch.Tensor có hình dạng (batch_size, config.num_labels)) — Điểm phân loại (hoặc hồi quy nếu config.num_labels==1) (trước SoftMax).
  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-states đã được tính toán trước. Có thể được sử dụng (xem đầu vào mems) để tăng tốc độ giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho mô hình này không nên được truyền dưới dạng input_ids vì chúng đã được tính toán.
  • hidden_states (tuple[torch.Tensor, ...], tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Tuple của torch.Tensor (một cho đầu ra của embeddings, nếu model có lớp embedding, + một cho đầu ra của mỗi lớp) có shape (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.Tensor, ...], tuỳ 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.Tensor (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.

Loại đầu ra của XLNetForSequenceClassification.

lớp transformers.models.xlnet.modeling_xlnet.XLNetForMultipleChoiceOutput

< >

( loss: typing.Optional[torch.Tensor] = Nonelogits: typing.Optional[torch.Tensor] = Nonemems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )

Tham số

  • loss (torch.Tensor có hình dạng (1,), tùy chọn, được trả về khi labels được cung cấp) — Mất phân loại.
  • logits (torch.Tensor có hình dạng (batch_size, num_choices)) — là chiều thứ hai của các tensor đầu vào. (xem ở trên). Điểm phân loại (trước SoftMax).

    Điểm phân loại (trước SoftMax).

  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-states đã được tính toán trước. Có thể được sử dụng (xem đầu vào mems) để tăng tốc độ giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho mô hình này không nên được truyền dưới dạng input_ids vì chúng đã được tính toán.
  • hidden_states (tuple[torch.Tensor, ...], tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Tuple của torch.Tensor (một cho đầu ra của embeddings, nếu model có lớp embedding, + một cho đầu ra của mỗi lớp) có shape (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.Tensor, ...], tuỳ 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.Tensor (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.

Loại đầu ra của XLNetForMultipleChoice.

lớp transformers.models.xlnet.modeling_xlnet.XLNetForTokenClassificationOutput

< >

( loss: typing.Optional[torch.Tensor] = Nonelogits: typing.Optional[torch.Tensor] = Nonemems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )

Tham số

  • loss (torch.Tensor có hình dạng (1,), tùy chọn, được trả về khi labels được cung cấp) — Mất phân loại.
  • logits (torch.Tensor có hình dạng (batch_size, sequence_length, config.num_labels)) — Điểm phân loại (trước SoftMax).
  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-states đã được tính toán trước. Có thể được sử dụng (xem đầu vào mems) để tăng tốc độ giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho mô hình này không nên được truyền dưới dạng input_ids vì chúng đã được tính toán.
  • hidden_states (tuple[torch.Tensor, ...], tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Tuple của torch.Tensor (một cho đầu ra của embeddings, nếu model có lớp embedding, + một cho đầu ra của mỗi lớp) có shape (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.Tensor, ...], tuỳ 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.Tensor (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.

Loại đầu ra của XLNetForTokenClassificationOutput.

lớp transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringSimpleOutput

< >

( loss: typing.Optional[torch.Tensor] = Nonestart_logits: typing.Optional[torch.Tensor] = Noneend_logits: typing.Optional[torch.Tensor] = Nonemems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )

Tham số

  • loss (torch.Tensor có hình dạng (1,), tùy chọn, được trả về khi labels được cung cấp) — Tổng tổn thất trích xuất span là tổng của Cross-Entropy cho các vị trí bắt đầu và kết thúc.
  • start_logits (torch.Tensor có hình dạng (batch_size, sequence_length,)) — Điểm bắt đầu span (trước SoftMax).
  • end_logits (torch.Tensor có hình dạng (batch_size, sequence_length,)) — Điểm kết thúc span (trước SoftMax).
  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-states đã được tính toán trước. Có thể được sử dụng (xem đầu vào mems) để tăng tốc độ giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho mô hình này không nên được truyền dưới dạng input_ids vì chúng đã được tính toán.
  • hidden_states (tuple[torch.Tensor, ...], tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Tuple của torch.Tensor (một cho đầu ra của embeddings, nếu model có lớp embedding, + một cho đầu ra của mỗi lớp) có shape (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.Tensor, ...], tuỳ 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.Tensor (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.

Loại đầu ra của XLNetForQuestionAnsweringSimple.

lớp transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringOutput

< >

( loss: typing.Optional[torch.Tensor] = Nonestart_top_log_probs: typing.Optional[torch.Tensor] = Nonestart_top_index: typing.Optional[torch.LongTensor] = Noneend_top_log_probs: typing.Optional[torch.Tensor] = Noneend_top_index: typing.Optional[torch.LongTensor] = Nonecls_logits: typing.Optional[torch.Tensor] = Nonemems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )

Tham số

  • loss (torch.Tensor có hình dạng (1,), tùy chọn, được trả về nếu cả start_positions và end_positions đều được cung cấp) — Mất phân loại dưới dạng tổng của các mất phân loại cho token bắt đầu, token kết thúc (và is_impossible nếu được cung cấp).
  • start_top_log_probs (torch.Tensor có hình dạng (batch_size, config.start_n_top), tùy chọn, được trả về nếu start_positions hoặc end_positions không được cung cấp) — Xác suất log cho config.start_n_top khả năng token bắt đầu hàng đầu (beam-search).
  • start_top_index (torch.LongTensor có shape (batch_size, config.start_n_top), tùy chọn, được trả về nếu start_positions hoặc end_positions không được cung cấp) — Chỉ số cho config.start_n_top khả năng token bắt đầu hàng đầu (beam-search).
  • end_top_log_probs (torch.Tensor có hình dạng (batch_size, config.start_n_top * config.end_n_top), tùy chọn, được trả về nếu start_positions hoặc end_positions không được cung cấp) — Xác suất log cho config.start_n_top * config.end_n_top khả năng token kết thúc hàng đầu (beam-search).
  • end_top_index (torch.LongTensor có hình dạng (batch_size, config.start_n_top * config.end_n_top), tùy chọn, được trả về nếu start_positions hoặc end_positions không được cung cấp) — Chỉ số cho config.start_n_top * config.end_n_top khả năng token kết thúc hàng đầu (beam-search).
  • cls_logits (torch.Tensor có hình dạng (batch_size,), tùy chọn, được trả về nếu start_positions hoặc end_positions không được cung cấp) — Xác suất log cho nhãn is_impossible của các câu trả lời.
  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-states đã được tính toán trước. Có thể được sử dụng (xem đầu vào mems) để tăng tốc độ giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho mô hình này không nên được truyền dưới dạng input_ids vì chúng đã được tính toán.
  • hidden_states (tuple[torch.Tensor, ...], tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Tuple của torch.Tensor (một cho đầu ra của embeddings, nếu model có lớp embedding, + một cho đầu ra của mỗi lớp) có shape (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.Tensor, ...], tuỳ 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.Tensor (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.

Loại đầu ra của XLNetForQuestionAnswering.

XLNetModel

lớp transformers.XLNetModel

< >

( config: XLNetConfig )

Tham số

  • config (XLNetConfig) — 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 Xlnet cơ bản, xuất ra các hidden-states 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.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → XLNetModelOutput or tuple(torch.Tensor)

Tham số

  • input_ids (torch.Tensor 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.Tensor có hình dạng (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện chú ý trên các chỉ số token đệ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ì?

  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-state đã được tính trước (xem mems output bên dưới). Có thể được sử dụng để tăng tốc giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho model này không nên được truyền vào input_ids vì chúng đã được tính toán.

    use_mems phải được đặt thành True để sử dụng mems.

  • perm_mask (torch.Tensor có shape (batch_size, sequence_length, sequence_length), tùy chọn) — Mask để chỉ ra mẫu attention cho mỗi token đầu vào với các giá trị được chọn trong [0, 1]:
    • nếu perm_mask[k, i, j] = 0, i chú ý đến j trong batch k;
    • nếu perm_mask[k, i, j] = 1, i không chú ý đến j trong batch k.

    Nếu không được đặt, mỗi token sẽ chú ý đến tất cả các token khác (chú ý hai chiều đầy đủ). Chỉ được sử dụng trong quá trình tiền huấn luyện (để xác định thứ tự phân rã) hoặc cho giải mã tuần tự (sinh).

  • target_mapping (torch.Tensor có shape (batch_size, num_predict, sequence_length), tuỳ chọn) — Mặt nạ chỉ định các token đầu ra cần sử dụng. Nếu target_mapping[k, i, j] = 1, thì dự đoán thứ i trong batch k nằm trên token thứ j. Chỉ được sử dụng trong giai đoạn pretraining cho dự đoán một phần hoặc cho giải mã tuần tự (generation).
  • token_type_ids (torch.Tensor 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ì?

  • input_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 padding. Phần bù của attention_mask, tức là có giá trị 0 cho token thực và 1 cho padding, được giữ lại để tương thích với mã gốc. Giá trị mặt nạ được chọn trong [0, 1]: 1 cho các token bị che, 0 cho các token không bị che. Bạn chỉ có thể sử dụng một trong input_mask và attention_mask.

    Giá trị mask được chọn trong [0, 1]:

    • 1 cho các token bị che,
    • 0 cho các token không bị che.

    Bạn chỉ có thể sử dụng một trong input_mask và attention_mask.

  • inputs_embeds (torch.Tensor 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_mems (bool, tùy chọn) — Có sử dụng trạng thái bộ nhớ để tăng tốc giải mã tuần tự hay không. Nếu đặt thành True, mô hình sẽ sử dụng các trạng thái ẩn từ các lần truyền tiến trước đó để tính toán chú ý, điều này có thể cải thiện đáng kể hiệu suất cho các tác vụ giải mã tuần tự.
  • output_attentions (bool, tùy chọn) — Có trả về các tensor attentions của tất cả các lớp attention hay không. Xem attentions trong phần tensor được trả về để biết thêm chi tiết.
  • output_hidden_states (bool, tùy chọn) — Có trả về trạng thái ẩn (hidden states) của tất cả các lớp hay không. Xem hidden_states trong phần tensor trả về để biết thêm chi tiết.
  • return_dict (bool, tùy chọn) — Có nên trả về một ModelOutput thay vì một tuple thông thường hay không.

Trả về

XLNetModelOutput hoặc tuple(torch.Tensor)

Một XLNetModelOutput hoặc một tuple của torch.Tensor (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 (XLNetConfig) và đầu vào.

Phương thức forward của XLNetModel 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.Tensor có hình dạng (batch_size, num_predict, hidden_size)) — Chuỗi các hidden-state ở lớp cuối cùng của mô hình.

    num_predict tương ứng với target_mapping.shape[1]. Nếu target_mapping là None, thì num_predict tương ứng với sequence_length.

  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-states đã được tính toán trước. Có thể được sử dụng (xem đầu vào mems) để tăng tốc độ giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho mô hình này không nên được truyền dưới dạng input_ids vì chúng đã được tính toán.

  • hidden_states (tuple[torch.Tensor, ...], tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Tuple của torch.Tensor (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.Tensor, ...], tuỳ 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.Tensor (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.

XLNetLMHeadModel

lớp transformers.XLNetLMHeadModel

< >

( config: XLNetConfig )

Tham số

  • config (XLNetConfig) — 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.

XLNet Model với đầu mô hình hóa ngôn ngữ phía trên (tầng tuyến tính có trọng số được liên kết với các nhúng đầu vào).

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.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = Nonelogits_to_keep: typing.Union[int, torch.Tensor] = 0**kwargs ) → XLNetLMHeadModelOutput or tuple(torch.Tensor)

Tham số

  • input_ids (torch.Tensor 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.Tensor có hình dạng (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện chú ý trên các chỉ số token đệ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ì?

  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-state đã được tính trước (xem mems output bên dưới). Có thể được sử dụng để tăng tốc giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho model này không nên được truyền vào input_ids vì chúng đã được tính toán.

    use_mems phải được đặt thành True để sử dụng mems.

  • perm_mask (torch.Tensor có shape (batch_size, sequence_length, sequence_length), tùy chọn) — Mask để chỉ ra mẫu attention cho mỗi token đầu vào với các giá trị được chọn trong [0, 1]:
    • nếu perm_mask[k, i, j] = 0, i chú ý đến j trong batch k;
    • nếu perm_mask[k, i, j] = 1, i không chú ý đến j trong batch k.

    Nếu không được đặt, mỗi token sẽ chú ý đến tất cả các token khác (chú ý hai chiều đầy đủ). Chỉ được sử dụng trong quá trình tiền huấn luyện (để xác định thứ tự phân rã) hoặc cho giải mã tuần tự (sinh).

  • target_mapping (torch.Tensor có shape (batch_size, num_predict, sequence_length), tuỳ chọn) — Mặt nạ chỉ định các token đầu ra cần sử dụng. Nếu target_mapping[k, i, j] = 1, thì dự đoán thứ i trong batch k nằm trên token thứ j. Chỉ được sử dụng trong giai đoạn pretraining cho dự đoán một phần hoặc cho giải mã tuần tự (generation).
  • token_type_ids (torch.Tensor 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ì?

  • input_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 padding. Phần bù của attention_mask, tức là có giá trị 0 cho token thực và 1 cho padding, được giữ lại để tương thích với mã gốc. Giá trị mặt nạ được chọn trong [0, 1]: 1 cho các token bị che, 0 cho các token không bị che. Bạn chỉ có thể sử dụng một trong input_mask và attention_mask.

    Giá trị mask được chọn trong [0, 1]:

    • 1 cho các token bị che,
    • 0 cho các token không bị che.

    Bạn chỉ có thể sử dụng một trong input_mask và attention_mask.

  • inputs_embeds (torch.Tensor 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ó dạng (batch_size, num_predict), tùy chọn) — Nhãn cho mô hình hóa ngôn ngữ có che (masked language modeling). num_predict tương ứng với target_mapping.shape[1]. Nếu target_mapping là None, thì num_predict tương ứng với sequence_length.

    Các nhãn phải tương ứng với các từ đầu vào bị che cần được dự đoán và phụ thuộc vào target_mapping. Lưu ý rằng để thực hiện mô hình hóa ngôn ngữ tự hồi quy chuẩn, một token phải được thêm vào input_ids (xem hàm prepare_inputs_for_generation và các ví dụ bên dưới)

    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, loss chỉ được tính cho các nhãn trong [0, ..., config.vocab_size]

  • use_mems (bool, tùy chọn) — Có sử dụng trạng thái bộ nhớ để tăng tốc giải mã tuần tự hay không. Nếu đặt thành True, mô hình sẽ sử dụng các trạng thái ẩn từ các lần truyền tiến trước đó để tính toán chú ý, điều này có thể cải thiện đáng kể hiệu suất cho các tác vụ giải mã tuần tự.
  • output_attentions (bool, tùy chọn) — Có trả về các tensor attentions của tất cả các lớp attention hay không. Xem attentions trong phần tensor được trả về để biết thêm chi tiết.
  • output_hidden_states (bool, tùy chọn) — Có trả về trạng thái ẩn (hidden states) của tất cả các lớp hay không. Xem hidden_states trong phần tensor trả về để biết thêm chi tiết.
  • return_dict (bool, tùy chọn) — Có nên trả về một ModelOutput thay vì một tuple thông thường hay không.
  • logits_to_keep (Union[int, torch.Tensor], tùy chọn, mặc định là 0) — Nếu là int, tính logits cho logits_to_keep token cuối. Nếu là 0, tính logits cho tất cả input_ids (trường hợp đặc biệt). Chỉ cần logits của token cuối cho quá trình sinh, và việc chỉ tính cho token đó có thể tiết kiệm bộ nhớ, điều này trở nên khá đáng kể với các chuỗi dài hoặc kích thước từ vựng lớn. Nếu là torch.Tensor, phải là 1 chiều tương ứng với các chỉ số cần giữ trong chiều độ dài chuỗi. Điều này hữu ích khi sử dụng định dạng tensor đóng gói (một chiều duy nhất cho batch và độ dài chuỗi).

Trả về

XLNetLMHeadModelOutput hoặc tuple(torch.Tensor)

Một XLNetLMHeadModelOutput hoặc một tuple của torch.Tensor (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 (XLNetConfig) và đầu vào.

Phương thức forward của XLNetLMHeadModel 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.Tensor có hình dạng (1,), tùy chọn, được trả về khi labels được cung cấp) — Tổn mô hình hóa ngôn ngữ (cho dự đoán token tiếp theo).

  • logits (torch.Tensor có hình dạng (batch_size, num_predict, 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 trong từ vựng trước SoftMax).

    num_predict tương ứng với target_mapping.shape[1]. Nếu target_mapping là None, thì num_predict tương ứng với sequence_length.

  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-states đã được tính toán trước. Có thể được sử dụng (xem đầu vào mems) để tăng tốc độ giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho mô hình này không nên được truyền dưới dạng input_ids vì chúng đã được tính toán.

  • hidden_states (tuple[torch.Tensor, ...], tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Tuple của torch.Tensor (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.Tensor, ...], tuỳ 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.Tensor (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 AutoTokenizer, XLNetLMHeadModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-large-cased")
>>> model = XLNetLMHeadModel.from_pretrained("xlnet/xlnet-large-cased")

>>> # We show how to setup inputs to predict a next token using a bi-directional context.
>>> input_ids = torch.tensor(
...     tokenizer.encode("Hello, my dog is very <mask>", add_special_tokens=False)
... ).unsqueeze(
...     0
... )  # We will predict the masked token
>>> perm_mask = torch.zeros((1, input_ids.shape[1], input_ids.shape[1]), dtype=torch.float)
>>> perm_mask[:, :, -1] = 1.0  # Previous tokens don't see last token
>>> target_mapping = torch.zeros(
...     (1, 1, input_ids.shape[1]), dtype=torch.float
... )  # Shape [1, 1, seq_length] => let's predict one token
>>> target_mapping[
...     0, 0, -1
... ] = 1.0  # Our first (and only) prediction will be the last token of the sequence (the masked token)

>>> outputs = model(input_ids, perm_mask=perm_mask, target_mapping=target_mapping)
>>> next_token_logits = outputs[
...     0
... ]  # Output has shape [target_mapping.size(0), target_mapping.size(1), config.vocab_size]

>>> # The same way can the XLNetLMHeadModel be used to be trained by standard auto-regressive language modeling.
>>> input_ids = torch.tensor(
...     tokenizer.encode("Hello, my dog is very <mask>", add_special_tokens=False)
... ).unsqueeze(
...     0
... )  # We will predict the masked token
>>> labels = torch.tensor(tokenizer.encode("cute", add_special_tokens=False)).unsqueeze(0)
>>> assert labels.shape[0] == 1, "only one word will be predicted"
>>> perm_mask = torch.zeros((1, input_ids.shape[1], input_ids.shape[1]), dtype=torch.float)
>>> perm_mask[
...     :, :, -1
... ] = 1.0  # Previous tokens don't see last token as is done in standard auto-regressive lm training
>>> target_mapping = torch.zeros(
...     (1, 1, input_ids.shape[1]), dtype=torch.float
... )  # Shape [1, 1, seq_length] => let's predict one token
>>> target_mapping[
...     0, 0, -1
... ] = 1.0  # Our first (and only) prediction will be the last token of the sequence (the masked token)

>>> outputs = model(input_ids, perm_mask=perm_mask, target_mapping=target_mapping, labels=labels)
>>> loss = outputs.loss
>>> next_token_logits = (
...     outputs.logits
... )  # Logits have shape [target_mapping.size(0), target_mapping.size(1), config.vocab_size]

XLNetForSequenceClassification

lớp transformers.XLNetForSequenceClassification

< >

( config: XLNetConfig )

Tham số

  • config (XLNetConfig) — 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 XLNet với đầu phân loại/hồi quy chuỗi phía trên (một lớp tuyến tính phía trên đầu ra đã gộp) ví dụ cho các tác vụ GLUE.

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.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → XLNetForSequenceClassificationOutput or tuple(torch.Tensor)

Tham số

  • input_ids (torch.Tensor 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.Tensor có hình dạng (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện chú ý trên các chỉ số token đệ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ì?

  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-state đã được tính trước (xem mems output bên dưới). Có thể được sử dụng để tăng tốc giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho model này không nên được truyền vào input_ids vì chúng đã được tính toán.

    use_mems phải được đặt thành True để sử dụng mems.

  • perm_mask (torch.Tensor có shape (batch_size, sequence_length, sequence_length), tùy chọn) — Mask để chỉ ra mẫu attention cho mỗi token đầu vào với các giá trị được chọn trong [0, 1]:
    • nếu perm_mask[k, i, j] = 0, i chú ý đến j trong batch k;
    • nếu perm_mask[k, i, j] = 1, i không chú ý đến j trong batch k.

    Nếu không được đặt, mỗi token sẽ chú ý đến tất cả các token khác (chú ý hai chiều đầy đủ). Chỉ được sử dụng trong quá trình tiền huấn luyện (để xác định thứ tự phân rã) hoặc cho giải mã tuần tự (sinh).

  • target_mapping (torch.Tensor có shape (batch_size, num_predict, sequence_length), tuỳ chọn) — Mặt nạ chỉ định các token đầu ra cần sử dụng. Nếu target_mapping[k, i, j] = 1, thì dự đoán thứ i trong batch k nằm trên token thứ j. Chỉ được sử dụng trong giai đoạn pretraining cho dự đoán một phần hoặc cho giải mã tuần tự (generation).
  • token_type_ids (torch.Tensor 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ì?

  • input_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 padding. Phần bù của attention_mask, tức là có giá trị 0 cho token thực và 1 cho padding, được giữ lại để tương thích với mã gốc. Giá trị mặt nạ được chọn trong [0, 1]: 1 cho các token bị che, 0 cho các token không bị che. Bạn chỉ có thể sử dụng một trong input_mask và attention_mask.

    Giá trị mask được chọn trong [0, 1]:

    • 1 cho các token bị che,
    • 0 cho các token không bị che.

    Bạn chỉ có thể sử dụng một trong input_mask và attention_mask.

  • inputs_embeds (torch.Tensor 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,), tùy chọn) — Nhãn để tính loss cho phân loại/hồi quy chuỗi. Chỉ số phải nằm trong [0, ..., config.num_labels - 1]. Nếu config.num_labels == 1, loss hồi quy sẽ được tính (Mean-Square loss). Nếu config.num_labels > 1, loss phân loại sẽ được tính (Cross-Entropy).
  • use_mems (bool, tùy chọn) — Có sử dụng trạng thái bộ nhớ để tăng tốc giải mã tuần tự hay không. Nếu đặt thành True, mô hình sẽ sử dụng các trạng thái ẩn từ các lần truyền tiến trước đó để tính toán chú ý, điều này có thể cải thiện đáng kể hiệu suất cho các tác vụ giải mã tuần tự.
  • output_attentions (bool, tùy chọn) — Có trả về các tensor attentions của tất cả các lớp attention hay không. Xem attentions trong phần tensor được trả về để biết thêm chi tiết.
  • output_hidden_states (bool, tùy chọn) — Có trả về trạng thái ẩn (hidden states) của tất cả các lớp hay không. Xem hidden_states trong phần tensor trả về để biết thêm chi tiết.
  • return_dict (bool, tùy chọn) — Có nên trả về một ModelOutput thay vì một tuple thông thường hay không.

Trả về

XLNetForSequenceClassificationOutput hoặc tuple(torch.Tensor)

Một XLNetForSequenceClassificationOutput hoặc một tuple của torch.Tensor (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 (XLNetConfig) và đầu vào.

Phương thức forward của XLNetForSequenceClassification 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.Tensor có shape (1,), optional, được trả về khi label được cung cấp) — Loss phân loại (hoặc hồi quy nếu config.num_labels==1).

  • logits (torch.Tensor có hình dạng (batch_size, config.num_labels)) — Điểm phân loại (hoặc hồi quy nếu config.num_labels==1) (trước SoftMax).

  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-states đã được tính toán trước. Có thể được sử dụng (xem đầu vào mems) để tăng tốc độ giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho mô hình này không nên được truyền dưới dạng input_ids vì chúng đã được tính toán.

  • hidden_states (tuple[torch.Tensor, ...], tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Tuple của torch.Tensor (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.Tensor, ...], tuỳ 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.Tensor (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ụ về phân loại nhãn đơn:

>>> import torch
>>> from transformers import AutoTokenizer, XLNetForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-large-cased")
>>> model = XLNetForSequenceClassification.from_pretrained("xlnet/xlnet-large-cased")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...

>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = XLNetForSequenceClassification.from_pretrained("xlnet/xlnet-large-cased", num_labels=num_labels)

>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...

Ví dụ về phân loại đa nhãn:

>>> import torch
>>> from transformers import AutoTokenizer, XLNetForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-large-cased")
>>> model = XLNetForSequenceClassification.from_pretrained("xlnet/xlnet-large-cased", problem_type="multi_label_classification")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]

>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = XLNetForSequenceClassification.from_pretrained(
...     "xlnet/xlnet-large-cased", num_labels=num_labels, problem_type="multi_label_classification"
... )

>>> labels = torch.sum(
...     torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).loss

XLNetForMultipleChoice

lớp transformers.XLNetForMultipleChoice

< >

( config: XLNetConfig )

Tham số

  • config (XLNetConfig) — 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 Xlnet với một đầu phân loại lựa chọn nhiều phương án ở trên (một lớp tuyến tính trên đầu ra đã được pool và một softmax), ví dụ cho các tác vụ RocStories/SWAG.

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.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → XLNetForMultipleChoiceOutput or tuple(torch.Tensor)

Tham số

  • input_ids (torch.LongTensor có dạng (batch_size, num_choices, sequence_length)) — Chỉ số của các token trong chuỗi đầu vào theo từ vựng. Có thể lấy chỉ số bằng AutoTokenizer. Xem PreTrainedTokenizer.encode() và PreTrainedTokenizer.call() để biết thêm chi tiết. input IDs là gì?

    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ì?

  • token_type_ids (torch.LongTensor có hình dạng (batch_size, num_choices, 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ì?

  • input_mask (torch.Tensor có shape batch_size, num_choices, sequence_length, tùy chọn) — Mặt nạ để tránh thực hiện attention trên các chỉ số token padding. Phần bù của attention_mask, tức là có giá trị 0 cho token thực và 1 cho padding, được giữ lại để tương thích với mã gốc. Giá trị mặt nạ được chọn trong [0, 1]: 1 cho các token bị che, 0 cho các token không bị che. Bạn chỉ có thể sử dụng một trong input_mask và attention_mask.

    Giá trị mask được chọn trong [0, 1]:

    • 1 cho các token bị che,
    • 0 cho các token không bị che.

    Bạn chỉ có thể sử dụng một trong input_mask và attention_mask.

  • attention_mask (torch.Tensor có hình dạng (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện chú ý trên các chỉ số token đệ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ì?

  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-state đã được tính trước (xem mems output bên dưới). Có thể được sử dụng để tăng tốc giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho model này không nên được truyền vào input_ids vì chúng đã được tính toán.

    use_mems phải được đặt thành True để sử dụng mems.

  • perm_mask (torch.Tensor có shape (batch_size, sequence_length, sequence_length), tùy chọn) — Mask để chỉ ra mẫu attention cho mỗi token đầu vào với các giá trị được chọn trong [0, 1]:
    • nếu perm_mask[k, i, j] = 0, i chú ý đến j trong batch k;
    • nếu perm_mask[k, i, j] = 1, i không chú ý đến j trong batch k.

    Nếu không được đặt, mỗi token sẽ chú ý đến tất cả các token khác (chú ý hai chiều đầy đủ). Chỉ được sử dụng trong quá trình tiền huấn luyện (để xác định thứ tự phân rã) hoặc cho giải mã tuần tự (sinh).

  • target_mapping (torch.Tensor có shape (batch_size, num_predict, sequence_length), tuỳ chọn) — Mặt nạ chỉ định các token đầu ra cần sử dụng. Nếu target_mapping[k, i, j] = 1, thì dự đoán thứ i trong batch k nằm trên token thứ j. Chỉ được sử dụng trong giai đoạn pretraining cho dự đoán một phần hoặc cho giải mã tuần tự (generation).
  • inputs_embeds (torch.Tensor có hình dạng (batch_size, num_choices, 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,), tùy chọn) — Nhãn để tính toán loss phân loại lựa chọn nhiều. Chỉ số phải nằm trong `[0, …,
  • use_mems (bool, tùy chọn) — Có sử dụng trạng thái bộ nhớ để tăng tốc giải mã tuần tự hay không. Nếu đặt thành True, mô hình sẽ sử dụng các trạng thái ẩn từ các lần truyền tiến trước đó để tính toán chú ý, điều này có thể cải thiện đáng kể hiệu suất cho các tác vụ giải mã tuần tự.
  • output_attentions (bool, tùy chọn) — Có trả về các tensor attentions của tất cả các lớp attention hay không. Xem attentions trong phần tensor được trả về để biết thêm chi tiết.
  • output_hidden_states (bool, tùy chọn) — Có trả về trạng thái ẩn (hidden states) của tất cả các lớp hay không. Xem hidden_states trong phần tensor trả về để biết thêm chi tiết.
  • return_dict (bool, tùy chọn) — Có nên trả về một ModelOutput thay vì một tuple thông thường hay không.

Trả về

XLNetForMultipleChoiceOutput hoặc tuple(torch.Tensor)

Một XLNetForMultipleChoiceOutput hoặc một tuple của torch.Tensor (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 (XLNetConfig) và đầu vào.

Phương thức forward của XLNetForMultipleChoice 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.Tensor có hình dạng (1,), tùy chọn, được trả về khi labels được cung cấp) — Tổn phân loại.

  • logits (torch.Tensor có shape (batch_size, num_choices)) — num_choices là chiều thứ hai của các tensor đầu vào. (xem input_ids ở trên).

    Điểm phân loại (trước SoftMax).

  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-states đã được tính toán trước. Có thể được sử dụng (xem đầu vào mems) để tăng tốc độ giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho mô hình này không nên được truyền dưới dạng input_ids vì chúng đã được tính toán.

  • hidden_states (tuple[torch.Tensor, ...], tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Tuple của torch.Tensor (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.Tensor, ...], tuỳ 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.Tensor (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 AutoTokenizer, XLNetForMultipleChoice
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-large-cased")
>>> model = XLNetForMultipleChoice.from_pretrained("xlnet/xlnet-large-cased")

>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> labels = torch.tensor(0).unsqueeze(0)  # choice0 is correct (according to Wikipedia ;)), batch size 1

>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="pt", padding=True)
>>> outputs = model(**{k: v.unsqueeze(0) for k, v in encoding.items()}, labels=labels)  # batch size is 1

>>> # the linear classifier still needs to be trained
>>> loss = outputs.loss
>>> logits = outputs.logits

XLNetForTokenClassification

lớp transformers.XLNetForTokenClassification

< >

( config: XLNetConfig )

Tham số

  • config (XLNetConfig) — 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.

Transformer Xlnet với một đầu phân loại token phía trên (một lớp tuyến tính phía trên đầu ra hidden-states), ví dụ cho các tác vụ Nhận thực thể có tên (NER).

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.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → XLNetForTokenClassificationOutput or tuple(torch.Tensor)

Tham số

  • input_ids (torch.Tensor 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.Tensor có hình dạng (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện chú ý trên các chỉ số token đệ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ì?

  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-state đã được tính trước (xem mems output bên dưới). Có thể được sử dụng để tăng tốc giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho model này không nên được truyền vào input_ids vì chúng đã được tính toán.

    use_mems phải được đặt thành True để sử dụng mems.

  • perm_mask (torch.Tensor có shape (batch_size, sequence_length, sequence_length), tùy chọn) — Mask để chỉ ra mẫu attention cho mỗi token đầu vào với các giá trị được chọn trong [0, 1]:
    • nếu perm_mask[k, i, j] = 0, i chú ý đến j trong batch k;
    • nếu perm_mask[k, i, j] = 1, i không chú ý đến j trong batch k.

    Nếu không được đặt, mỗi token sẽ chú ý đến tất cả các token khác (chú ý hai chiều đầy đủ). Chỉ được sử dụng trong quá trình tiền huấn luyện (để xác định thứ tự phân rã) hoặc cho giải mã tuần tự (sinh).

  • target_mapping (torch.Tensor có shape (batch_size, num_predict, sequence_length), tuỳ chọn) — Mặt nạ chỉ định các token đầu ra cần sử dụng. Nếu target_mapping[k, i, j] = 1, thì dự đoán thứ i trong batch k nằm trên token thứ j. Chỉ được sử dụng trong giai đoạn pretraining cho dự đoán một phần hoặc cho giải mã tuần tự (generation).
  • token_type_ids (torch.Tensor 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ì?

  • input_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 padding. Phần bù của attention_mask, tức là có giá trị 0 cho token thực và 1 cho padding, được giữ lại để tương thích với mã gốc. Giá trị mặt nạ được chọn trong [0, 1]: 1 cho các token bị che, 0 cho các token không bị che. Bạn chỉ có thể sử dụng một trong input_mask và attention_mask.

    Giá trị mask được chọn trong [0, 1]:

    • 1 cho các token bị che,
    • 0 cho các token không bị che.

    Bạn chỉ có thể sử dụng một trong input_mask và attention_mask.

  • inputs_embeds (torch.Tensor 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ó hình dạng (batch_size,), tùy chọn) — Nhãn để tính toán tổn thất phân loại lựa chọn nhiều. Chỉ số phải nằm trong [0, ..., num_choices] trong đó num_choices là kích thước của chiều thứ hai của các tensor đầu vào. (xem input_ids ở trên)
  • use_mems (bool, tùy chọn) — Có sử dụng trạng thái bộ nhớ để tăng tốc giải mã tuần tự hay không. Nếu đặt thành True, mô hình sẽ sử dụng các trạng thái ẩn từ các lần truyền tiến trước đó để tính toán chú ý, điều này có thể cải thiện đáng kể hiệu suất cho các tác vụ giải mã tuần tự. Trạng thái bộ nhớ để tăng tốc giải mã tuần tự. Nếu đặt thành True, mô hình sẽ sử dụng các trạng thái ẩn từ các lần truyền tiến trước đó để tính toán chú ý, điều này có thể cải thiện đáng kể hiệu suất cho các tác vụ giải mã tuần tự.
  • output_attentions (bool, tùy chọn) — Có trả về các tensor attentions của tất cả các lớp attention hay không. Xem attentions trong phần tensor được trả về để biết thêm chi tiết.
  • output_hidden_states (bool, tùy chọn) — Có trả về trạng thái ẩn (hidden states) của tất cả các lớp hay không. Xem hidden_states trong phần tensor trả về để biết thêm chi tiết.
  • return_dict (bool, tùy chọn) — Có nên trả về một ModelOutput thay vì một tuple thông thường hay không.

Trả về

XLNetForTokenClassificationOutput hoặc tuple(torch.Tensor)

Một XLNetForTokenClassificationOutput hoặc một tuple của torch.Tensor (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 (XLNetConfig) và đầu vào.

Phương thức forward của XLNetForTokenClassification 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.Tensor có shape (1,), tuỳ chọn, được trả về khi labels được cung cấp) — Loss phân loại.

  • logits (torch.Tensor có hình dạng (batch_size, sequence_length, config.num_labels)) — Điểm phân loại (trước SoftMax).

  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-states đã được tính toán trước. Có thể được sử dụng (xem đầu vào mems) để tăng tốc độ giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho mô hình này không nên được truyền dưới dạng input_ids vì chúng đã được tính toán.

  • hidden_states (tuple[torch.Tensor, ...], tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Tuple của torch.Tensor (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.Tensor, ...], tuỳ 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.Tensor (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 AutoTokenizer, XLNetForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-large-cased")
>>> model = XLNetForTokenClassification.from_pretrained("xlnet/xlnet-large-cased")

>>> inputs = tokenizer(
...     "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_token_class_ids = logits.argmax(-1)

>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> predicted_tokens_classes
...

>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...

XLNetForQuestionAnsweringSimple

lớp transformers.XLNetForQuestionAnsweringSimple

< >

( config: XLNetConfig )

Tham số

  • config (XLNetConfig) — 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 XLNet với một đầu phân loại span phía trên cho các tác vụ trả lời câu hỏi trích xuất như SQuAD (một lớp tuyến tính phía trên đầu ra hidden-states để tính toán span start logits và span end logits).

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.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonestart_positions: typing.Optional[torch.Tensor] = Noneend_positions: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → XLNetForQuestionAnsweringSimpleOutput or tuple(torch.Tensor)

Tham số

  • input_ids (torch.Tensor 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.Tensor có hình dạng (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện chú ý trên các chỉ số token đệ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ì?

  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-state đã được tính trước (xem mems output bên dưới). Có thể được sử dụng để tăng tốc giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho model này không nên được truyền vào input_ids vì chúng đã được tính toán.

    use_mems phải được đặt thành True để sử dụng mems.

  • perm_mask (torch.Tensor có shape (batch_size, sequence_length, sequence_length), tùy chọn) — Mask để chỉ ra mẫu attention cho mỗi token đầu vào với các giá trị được chọn trong [0, 1]:
    • nếu perm_mask[k, i, j] = 0, i chú ý đến j trong batch k;
    • nếu perm_mask[k, i, j] = 1, i không chú ý đến j trong batch k.

    Nếu không được đặt, mỗi token sẽ chú ý đến tất cả các token khác (chú ý hai chiều đầy đủ). Chỉ được sử dụng trong quá trình tiền huấn luyện (để xác định thứ tự phân rã) hoặc cho giải mã tuần tự (sinh).

  • target_mapping (torch.Tensor có shape (batch_size, num_predict, sequence_length), tuỳ chọn) — Mặt nạ chỉ định các token đầu ra cần sử dụng. Nếu target_mapping[k, i, j] = 1, thì dự đoán thứ i trong batch k nằm trên token thứ j. Chỉ được sử dụng trong giai đoạn pretraining cho dự đoán một phần hoặc cho giải mã tuần tự (generation).
  • token_type_ids (torch.Tensor 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ì?

  • input_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 padding. Phần bù của attention_mask, tức là có giá trị 0 cho token thực và 1 cho padding, được giữ lại để tương thích với mã gốc. Giá trị mặt nạ được chọn trong [0, 1]: 1 cho các token bị che, 0 cho các token không bị che. Bạn chỉ có thể sử dụng một trong input_mask và attention_mask.

    Giá trị mask được chọn trong [0, 1]:

    • 1 cho các token bị che,
    • 0 cho các token không bị che.

    Bạn chỉ có thể sử dụng một trong input_mask và attention_mask.

  • inputs_embeds (torch.Tensor 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.
  • start_positions (torch.Tensor có hình dạng (batch_size,), tùy chọn) — Nhãn cho vị trí (chỉ số) bắt đầu của đoạn được gán nhãn để tính toán tổn thất phân loại token. Các vị trí được kẹp (clamp) theo độ dài của chuỗi (sequence_length). Các vị trí nằm ngoài chuỗi không được tính đến khi tính toán tổn thất.
  • end_positions (torch.Tensor có hình dạng (batch_size,), tùy chọn) — Nhãn cho vị trí (chỉ số) của điểm kết thúc của đoạn được gán nhãn để tính toán tổn thất phân loại token. Các vị trí được kẹp (clamp) theo độ dài của chuỗi (sequence_length). Các vị trí nằm ngoài chuỗi không được tính đến khi tính toán tổn thất.
  • use_mems (bool, tùy chọn) — Có sử dụng trạng thái bộ nhớ để tăng tốc giải mã tuần tự hay không. Nếu đặt thành True, mô hình sẽ sử dụng các trạng thái ẩn từ các lần truyền tiến trước đó để tính toán chú ý, điều này có thể cải thiện đáng kể hiệu suất cho các tác vụ giải mã tuần tự.
  • output_attentions (bool, tùy chọn) — Có trả về các tensor attentions của tất cả các lớp attention hay không. Xem attentions trong phần tensor được trả về để biết thêm chi tiết.
  • output_hidden_states (bool, tùy chọn) — Có trả về trạng thái ẩn (hidden states) của tất cả các lớp hay không. Xem hidden_states trong phần tensor trả về để biết thêm chi tiết.
  • return_dict (bool, tùy chọn) — Có nên trả về một ModelOutput thay vì một tuple thông thường hay không.

Trả về

XLNetForQuestionAnsweringSimpleOutput hoặc tuple(torch.Tensor)

Một XLNetForQuestionAnsweringSimpleOutput hoặc một tuple của torch.Tensor (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 (XLNetConfig) và đầu vào.

Phương thức forward của XLNetForQuestionAnsweringSimple 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.Tensor có shape (1,), tuỳ chọn, được trả về khi labels được cung cấp) — Tổng loss trích xuất span là tổng của Cross-Entropy cho các vị trí bắt đầu và kết thúc.

  • start_logits (torch.Tensor có hình dạng (batch_size, sequence_length,)) — Điểm số bắt đầu span (trước SoftMax).

  • end_logits (torch.Tensor có hình dạng (batch_size, sequence_length,)) — Điểm số kết thúc span (trước SoftMax).

  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-states đã được tính toán trước. Có thể được sử dụng (xem đầu vào mems) để tăng tốc độ giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho mô hình này không nên được truyền dưới dạng input_ids vì chúng đã được tính toán.

  • hidden_states (tuple[torch.Tensor, ...], tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Tuple của torch.Tensor (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.Tensor, ...], tuỳ 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.Tensor (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 AutoTokenizer, XLNetForQuestionAnsweringSimple
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-large-cased")
>>> model = XLNetForQuestionAnsweringSimple.from_pretrained("xlnet/xlnet-large-cased")

>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"

>>> inputs = tokenizer(question, text, return_tensors="pt")
>>> with torch.no_grad():
...     outputs = model(**inputs)

>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()

>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> tokenizer.decode(predict_answer_tokens, skip_special_tokens=True)
...

>>> # target is "nice puppet"
>>> target_start_index = torch.tensor([14])
>>> target_end_index = torch.tensor([15])

>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = outputs.loss
>>> round(loss.item(), 2)
...

XLNetForQuestionAnswering

lớp transformers.XLNetForQuestionAnswering

< >

( config: XLNetConfig )

Tham số

  • config (XLNetConfig) — 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.

Transformer Xlnet với một đầu phân loại span phía trên cho các tác vụ trả lời câu hỏi trích xuất như SQuAD (một lớp tuyến tính phía trên đầu ra hidden-states để tính toán span start logits và span end logits).

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.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonestart_positions: typing.Optional[torch.Tensor] = Noneend_positions: typing.Optional[torch.Tensor] = Noneis_impossible: typing.Optional[torch.Tensor] = Nonecls_index: typing.Optional[torch.Tensor] = Nonep_mask: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → XLNetForQuestionAnsweringOutput or tuple(torch.Tensor)

Tham số

  • input_ids (torch.Tensor 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.Tensor có hình dạng (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện chú ý trên các chỉ số token đệ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ì?

  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-state đã được tính trước (xem mems output bên dưới). Có thể được sử dụng để tăng tốc giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho model này không nên được truyền vào input_ids vì chúng đã được tính toán.

    use_mems phải được đặt thành True để sử dụng mems.

  • perm_mask (torch.Tensor có shape (batch_size, sequence_length, sequence_length), tùy chọn) — Mask để chỉ ra mẫu attention cho mỗi token đầu vào với các giá trị được chọn trong [0, 1]:
    • nếu perm_mask[k, i, j] = 0, i chú ý đến j trong batch k;
    • nếu perm_mask[k, i, j] = 1, i không chú ý đến j trong batch k.

    Nếu không được đặt, mỗi token sẽ chú ý đến tất cả các token khác (chú ý hai chiều đầy đủ). Chỉ được sử dụng trong quá trình tiền huấn luyện (để xác định thứ tự phân rã) hoặc cho giải mã tuần tự (sinh).

  • target_mapping (torch.Tensor có shape (batch_size, num_predict, sequence_length), tuỳ chọn) — Mặt nạ chỉ định các token đầu ra cần sử dụng. Nếu target_mapping[k, i, j] = 1, thì dự đoán thứ i trong batch k nằm trên token thứ j. Chỉ được sử dụng trong giai đoạn pretraining cho dự đoán một phần hoặc cho giải mã tuần tự (generation).
  • token_type_ids (torch.Tensor 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ì?

  • input_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 padding. Phần bù của attention_mask, tức là có giá trị 0 cho token thực và 1 cho padding, được giữ lại để tương thích với mã gốc. Giá trị mặt nạ được chọn trong [0, 1]: 1 cho các token bị che, 0 cho các token không bị che. Bạn chỉ có thể sử dụng một trong input_mask và attention_mask.

    Giá trị mask được chọn trong [0, 1]:

    • 1 cho các token bị che,
    • 0 cho các token không bị che.

    Bạn chỉ có thể sử dụng một trong input_mask và attention_mask.

  • inputs_embeds (torch.Tensor 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.
  • start_positions (torch.Tensor có hình dạng (batch_size,), tùy chọn) — Nhãn cho vị trí (chỉ số) bắt đầu của đoạn được gán nhãn để tính toán tổn thất phân loại token. Các vị trí được kẹp (clamp) theo độ dài của chuỗi (sequence_length). Các vị trí nằm ngoài chuỗi không được tính đến khi tính toán tổn thất.
  • end_positions (torch.Tensor có hình dạng (batch_size,), tùy chọn) — Nhãn cho vị trí (chỉ số) của điểm kết thúc của đoạn được gán nhãn để tính toán tổn thất phân loại token. Các vị trí được kẹp (clamp) theo độ dài của chuỗi (sequence_length). Các vị trí nằm ngoài chuỗi không được tính đến khi tính toán tổn thất.
  • is_impossible (torch.LongTensor có hình dạng (batch_size,), tùy chọn) — Nhãn cho biết một câu hỏi có câu trả lời hay không (SQuAD 2.0)
  • cls_index (torch.LongTensor có shape (batch_size,), tùy chọn) — Nhãn cho vị trí (chỉ số) của token phân loại được dùng làm đầu vào để tính độ hợp lý của câu trả lời.
  • p_mask (torch.Tensor có shape (batch_size, sequence_length), tùy chọn) — Mặt nạ tùy chọn cho các token không thể nằm trong câu trả lời (ví dụ: [CLS], [PAD], …). 1.0 có nghĩa là token nên bị che. 0.0 có nghĩa là token không bị che.
  • use_mems (bool, tùy chọn) — Có sử dụng trạng thái bộ nhớ để tăng tốc giải mã tuần tự hay không. Nếu đặt thành True, mô hình sẽ sử dụng các trạng thái ẩn từ các lần truyền tiến trước đó để tính toán chú ý, điều này có thể cải thiện đáng kể hiệu suất cho các tác vụ giải mã tuần tự.
  • output_attentions (bool, tùy chọn) — Có trả về các tensor attentions của tất cả các lớp attention hay không. Xem attentions trong phần tensor được trả về để biết thêm chi tiết.
  • output_hidden_states (bool, tùy chọn) — Có trả về trạng thái ẩn (hidden states) của tất cả các lớp hay không. Xem hidden_states trong phần tensor trả về để biết thêm chi tiết.
  • return_dict (bool, tùy chọn) — Có nên trả về một ModelOutput thay vì một tuple thông thường hay không.

Trả về

XLNetForQuestionAnsweringOutput hoặc tuple(torch.Tensor)

Một XLNetForQuestionAnsweringOutput hoặc một tuple của torch.Tensor (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 (XLNetConfig) và đầu vào.

Phương thức forward của XLNetForQuestionAnswering 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.Tensor có shape (1,), tùy chọn, được trả về nếu cả start_positions và end_positions đều được cung cấp) — Loss phân loại dưới dạng tổng của các loss phân loại cho token bắt đầu, token kết thúc (và is_impossible nếu được cung cấp).

  • start_top_log_probs (torch.Tensor có shape (batch_size, config.start_n_top), optional, được trả về nếu start_positions hoặc end_positions không được cung cấp) — Log probabilities cho config.start_n_top khả năng token bắt đầu hàng đầu (beam-search).

  • start_top_index (torch.LongTensor có shape (batch_size, config.start_n_top), tùy chọn, được trả về nếu start_positions hoặc end_positions không được cung cấp) — Chỉ số cho config.start_n_top khả năng token bắt đầu hàng đầu (beam-search).

  • end_top_log_probs (torch.Tensor có shape (batch_size, config.start_n_top * config.end_n_top), optional, được trả về nếu start_positions hoặc end_positions không được cung cấp) — Xác suất log cho config.start_n_top * config.end_n_top khả năng token kết thúc hàng đầu (beam-search).

  • end_top_index (torch.LongTensor có shape (batch_size, config.start_n_top * config.end_n_top), tùy chọn, được trả về nếu start_positions hoặc end_positions không được cung cấp) — Chỉ số cho config.start_n_top * config.end_n_top khả năng token kết thúc hàng đầu (beam-search).

  • cls_logits (torch.Tensor có hình dạng (batch_size,), tùy chọn, được trả về nếu start_positions hoặc end_positions không được cung cấp) — Xác suất log cho nhãn is_impossible của các câu trả lời.

  • mems (list[torch.Tensor] có độ dài config.n_layers) — Chứa các hidden-states đã được tính toán trước. Có thể được sử dụng (xem đầu vào mems) để tăng tốc độ giải mã tuần tự. Các token id mà quá khứ của chúng đã được cung cấp cho mô hình này không nên được truyền dưới dạng input_ids vì chúng đã được tính toán.

  • hidden_states (tuple[torch.Tensor, ...], tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Tuple của torch.Tensor (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.Tensor, ...], tuỳ 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.Tensor (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 AutoTokenizer, XLNetForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-base-cased")
>>> model = XLNetForQuestionAnswering.from_pretrained("xlnet/xlnet-base-cased")

>>> input_ids = torch.tensor(tokenizer.encode("Hello, my dog is cute", add_special_tokens=True)).unsqueeze(
...     0
... )  # Batch size 1
>>> start_positions = torch.tensor([1])
>>> end_positions = torch.tensor([3])
>>> outputs = model(input_ids, start_positions=start_positions, end_positions=end_positions)

>>> loss = outputs.loss
Update on GitHub

←XLM-V xLSTM→