Hugging Face's logo

Transformers documentation

DPR

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

and get access to the augmented documentation experience

to get started

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

DPR

SDPA

Tổng quan

Dense Passage Retrieval (DPR) là một bộ công cụ và mô hình cho nghiên cứu hỏi đáp (Q&A) mở theo lĩnh vực tiên tiến nhất. Nó được giới thiệu trong Dense Passage Retrieval for Open-Domain Question Answering bởi Vladimir Karpukhin, Barlas Oğuz, Sewon Min, Patrick Lewis, Ledell Wu, Sergey Edunov, Danqi Chen, Wen-tau Yih.

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

Trả lời câu hỏi mở (open-domain question answering) dựa vào việc truy xuất đoạn văn bản hiệu quả để chọn các ngữ cảnh ứng viên, trong đó các mô hình không gian vector thưa truyền thống, chẳng hạn như TF-IDF hoặc BM25, là phương pháp mặc định. Trong công trình này, chúng tôi cho thấy việc truy xuất có thể được triển khai thực tế chỉ bằng các biểu diễn đặc (dense), trong đó các embedding được học từ một số lượng nhỏ câu hỏi và đoạn văn bản bằng một khung dual-encoder đơn giản. Khi đánh giá trên một loạt các bộ dữ liệu QA mở, bộ truy xuất đặc của chúng tôi vượt trội so với hệ thống Lucene-BM25 mạnh, với mức cải thiện tuyệt đối từ 9% đến 19% về độ chính xác truy xuất top-20 đoạn văn bản, và giúp hệ thống QA end-to-end của chúng tôi thiết lập mức state-of-the-art mới trên nhiều benchmark QA mở.

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

Mẹo sử dụng

  • DPR bao gồm ba mô hình:

    • Bộ mã hóa câu hỏi: mã hóa các câu hỏi thành các vector
    • Bộ mã hóa ngữ cảnh: mã hóa các ngữ cảnh thành các vector
    • Reader: trích xuất câu trả lời cho các câu hỏi trong các ngữ cảnh đã truy xuất, kèm theo điểm số liên quan (cao nếu đoạn văn suy ra thực sự trả lời được câu hỏi).

DPRConfig

lớp transformers.DPRConfig

< >

( 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 = 30522hidden_size: int = 768num_hidden_layers: int = 12num_attention_heads: int = 12intermediate_size: int = 3072hidden_act: str = 'gelu'hidden_dropout_prob: float | int = 0.1attention_probs_dropout_prob: float | int = 0.1max_position_embeddings: int = 512type_vocab_size: int = 2initializer_range: float = 0.02layer_norm_eps: float = 1e-12pad_token_id: int | None = 0bos_token_id: int | None = Noneeos_token_id: int | list[int] | None = Noneprojection_dim: int = 0is_decoder: bool = Falseadd_cross_attention: bool = False )

Tham số

  • vocab_size (int, tuỳ chọn, mặc định là 30522) — Kích thước từ vựng của mô hình. Xác định số lượng token khác nhau có thể được biểu diễn bởi input_ids.
  • hidden_size (int, tùy chọn, mặc định là 768) — Kích thước của các biểu diễn ẩn.
  • num_hidden_layers (int, tùy chọn, mặc định là 12) — Số lượng lớp ẩn trong bộ giải mã Transformer.
  • num_attention_heads (int, tùy chọn, mặc định là 12) — Số lượng đầu attention cho mỗi lớp attention trong bộ giải mã Transformer.
  • intermediate_size (int, tùy chọn, mặc định là 3072) — Kích thước của các biểu diễn MLP.
  • hidden_act (str, tùy chọn, mặc định là gelu) — Hàm kích hoạt phi tuyến (hàm hoặc chuỗi) trong bộ giải mã. Ví dụ, "gelu", "relu", "silu", v.v.
  • hidden_dropout_prob (Union[float, int], tùy chọn, mặc định là 0.1) — Xác suất dropout cho tất cả các lớp fully connected trong embeddings, encoder và pooler.
  • attention_probs_dropout_prob (Union[float, int], tùy chọn, mặc định là 0.1) — Tỷ lệ dropout cho các xác suất chú ý.
  • max_position_embeddings (int, tùy chọn, mặc định là 512) — Chiều dài tối đa của chuỗi mà mô hình này có thể được sử dụng.
  • type_vocab_size (int, tùy chọn, mặc định là 2) — Kích thước từ vựng của token_type_ids.
  • 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).
  • pad_token_id (int, tùy chọn, mặc định là 0) — Token id được sử dụng để đệm (padding) trong từ vựng.
  • bos_token_id (int, tùy chọn) — 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) — Token id được sử dụng cho end-of-stream trong bảng từ vựng.
  • projection_dim (int, tùy chọn, mặc định là 0) — Số chiều của các lớp chiếu văn bản và thị giác.
  • is_decoder (bool, tùy chọn, mặc định là False) — Xác định xem mô hình có được sử dụng như một bộ giải mã hay không. Nếu False, mô hình sẽ được sử dụng như một bộ mã hóa.
  • add_cross_attention (bool, tùy chọn, mặc định là False) — Xác định xem có nên thêm các lớp cross-attention vào mô hình hay không.

Đây là lớp cấu hình để lưu trữ cấu hình của một DPRQuestionEncoder. Nó được sử dụng để khởi tạo một mô hình Dpr theo các đối số được chỉ định, xác định kiến trúc 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ủa facebook/dpr-ctx_encoder-single-nq-base

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 DPRConfig, DPRContextEncoder

>>> # Initializing a DPR facebook/dpr-ctx_encoder-single-nq-base style configuration
>>> configuration = DPRConfig()

>>> # Initializing a model (with random weights) from the facebook/dpr-ctx_encoder-single-nq-base style configuration
>>> model = DPRContextEncoder(configuration)

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

DPRContextEncoderTokenizer

lớp transformers.DPRContextEncoderTokenizer

< >

( *argsdo_lower_case = False**kwargs )

Xây dựng bộ mã hóa (tokenizer) DPRContextEncoder.

DPRContextEncoderTokenizer giống hệt với BertTokenizer và thực hiện tokenization từ đầu đến cuối: tách dấu câu và wordpiece.

Tham khảo siêu lớp BertTokenizer để xem các ví dụ sử dụng và tài liệu liên quan đến các tham số.

DPRContextEncoderTokenizerFast

lớp transformers.DPRContextEncoderTokenizerFast

< >

( vocab: str | dict[str, int] | None = Nonedo_lower_case: bool = Trueunk_token: str = '[UNK]'sep_token: str = '[SEP]'pad_token: str = '[PAD]'cls_token: str = '[CLS]'mask_token: str = '[MASK]'tokenize_chinese_chars: bool = Truestrip_accents: bool | None = None**kwargs )

Xây dựng bộ mã hóa (tokenizer) DPRContextEncoder “nhanh” (dựa trên thư viện tokenizers của HuggingFace).

DPRContextEncoderTokenizerFast giống hệt với BertTokenizer và thực hiện tokenization từ đầu đến cuối: tách dấu câu và wordpiece.

Tham khảo siêu lớp BertTokenizer để xem các ví dụ sử dụng và tài liệu liên quan đến các tham số.

DPRQuestionEncoderTokenizer

lớp transformers.DPRQuestionEncoderTokenizer

< >

( *argsdo_lower_case = False**kwargs )

Tạo một tokenizer DPRQuestionEncoder.

DPRQuestionEncoderTokenizer giống hệt với BertTokenizer và thực hiện tokenization từ đầu đến cuối: tách dấu câu và wordpiece.

Tham khảo siêu lớp BertTokenizer để xem các ví dụ sử dụng và tài liệu liên quan đến các tham số.

DPRQuestionEncoderTokenizerFast

lớp transformers.DPRQuestionEncoderTokenizerFast

< >

( vocab: str | dict[str, int] | None = Nonedo_lower_case: bool = Trueunk_token: str = '[UNK]'sep_token: str = '[SEP]'pad_token: str = '[PAD]'cls_token: str = '[CLS]'mask_token: str = '[MASK]'tokenize_chinese_chars: bool = Truestrip_accents: bool | None = None**kwargs )

Tạo bộ phân từ DPRQuestionEncoder “nhanh” (dựa trên thư viện tokenizers của HuggingFace).

DPRQuestionEncoderTokenizerFast giống hệt với BertTokenizer và thực hiện tokenization từ đầu đến cuối: tách dấu câu và wordpiece.

Tham khảo siêu lớp BertTokenizer để xem các ví dụ sử dụng và tài liệu liên quan đến các tham số.

DPRReaderTokenizer

lớp transformers.DPRReaderTokenizer

< >

( *argsdo_lower_case = False**kwargs ) → dict[str, list[list[int]]]

Tham số

  • questions (str hoặc list[str]) — Các câu hỏi cần được mã hóa. Bạn có thể chỉ định một câu hỏi cho nhiều đoạn văn. Trong trường hợp này, câu hỏi sẽ được nhân bản thành [questions] * n_passages. Ngược lại, bạn phải chỉ định số lượng câu hỏi tương ứng với số lượng trong titles hoặc texts.
  • titles (str hoặc list[str]) — Tiêu đề của các đoạn văn cần được mã hóa. Đây có thể là một chuỗi hoặc một danh sách các chuỗi nếu có nhiều đoạn văn.
  • texts (str hoặc list[str]) — Các đoạn văn bản cần được mã hóa. Đây có thể là một chuỗi hoặc một danh sách các chuỗi nếu có nhiều đoạn văn bản.
  • padding (bool, str hoặc PaddingStrategy, tùy chọn, mặc định là False) — Kích hoạt và kiểm soát padding. Chấp nhận các giá trị sau:
    • True hoặc 'longest': Lấp đầy (pad) đến độ dài của chuỗi dài nhất trong batch (hoặc không lấp đầy nếu chỉ có một chuỗi được cung cấp).
    • 'max_length': Đệm (pad) đến độ dài tối đa được chỉ định bằng tham số max_length hoặc đến độ dài đầu vào tối đa mà mô hình chấp nhận được nếu tham số đó không được cung cấp.
    • False hoặc 'do_not_pad' (mặc định): Không đệm (tức là có thể xuất ra một lô với các chuỗi có độ dài khác nhau).
  • truncation (bool, str hoặc TruncationStrategy, tùy chọn, mặc định là False) — Kích hoạt và kiểm soát việc cắt ngắn. Chấp nhận các giá trị sau:
    • True hoặc 'longest_first': Cắt ngắn xuống độ dài tối đa được chỉ định bằng tham số max_length hoặc xuống độ dài đầu vào tối đa chấp nhận được của mô hình nếu tham số đó không được cung cấp. Thao tác này sẽ cắt ngắn theo từng token, loại bỏ một token từ chuỗi dài nhất trong cặp nếu một cặp chuỗi (hoặc một lô các cặp) được cung cấp.
    • 'only_first': Cắt ngắn xuống độ dài tối đa được chỉ định bằng tham số max_length hoặc xuống độ dài đầu vào tối đa mà mô hình chấp nhận được nếu tham số đó không được cung cấp. Thao tác này chỉ cắt ngắn chuỗi đầu tiên của một cặp nếu một cặp chuỗi (hoặc một lô các cặp) được cung cấp.
    • 'only_second': Cắt ngắn xuống độ dài tối đa được chỉ định bằng tham số max_length hoặc xuống độ dài đầu vào tối đa mà mô hình chấp nhận được nếu tham số đó không được cung cấp. Thao tác này chỉ cắt ngắn chuỗi thứ hai của một cặp nếu một cặp chuỗi (hoặc một lô các cặp) được cung cấp.
    • False hoặc 'do_not_truncate' (mặc định): Không cắt bớt (tức là có thể xuất ra batch với độ dài chuỗi lớn hơn kích thước đầu vào tối đa cho phép của mô hình).
  • max_length (int, tuỳ chọn) — Kiểm soát độ dài tối đa được sử dụng bởi một trong các tham số cắt/giữ chỗ (truncation/padding).

    Nếu không được đặt hoặc được đặt thành None, tham số này sẽ sử dụng độ dài tối đa định trước của mô hình nếu một trong các tham số cắt/giữ chỗ yêu cầu độ dài tối đa. Nếu mô hình không có độ dài đầu vào tối đa cụ thể (như XLNet), việc cắt/giữ chỗ đến độ dài tối đa sẽ bị vô hiệu hóa.

  • return_tensors (str hoặc TensorType, tùy chọn) — Nếu được đặt, sẽ trả về tensor thay vì danh sách các số nguyên Python. Các giá trị chấp nhận được là:
    • 'pt': Trả về các đối tượng torch.Tensor của PyTorch.
    • 'np': Trả về các đối tượng Numpy np.ndarray.
  • return_attention_mask (bool, tuỳ chọn) — Có trả về attention mask hay không. Nếu không được đặt, sẽ trả về attention mask theo mặc định của tokenizer cụ thể, được xác định bởi thuộc tính return_outputs .

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

Trả về

dict[str, list[list[int]]]

Một từ điển có các khóa sau:

  • input_ids: Danh sách các id token để đưa vào mô hình.
  • attention_mask: Danh sách các chỉ số chỉ định những token nào nên được mô hình chú ý đến.

Xây dựng một tokenizer DPRReader.

DPRReaderTokenizer gần như giống hệt với BertTokenizer và thực hiện tokenization từ đầu đến cuối: tách dấu câu và wordpiece. Điểm khác biệt là nó có ba chuỗi đầu vào: question, titles và texts, được kết hợp lại để đưa vào mô hình DPRReader.

Tham khảo siêu lớp BertTokenizer để xem các ví dụ sử dụng và tài liệu liên quan đến các tham số.

Trả về một từ điển chứa các token id của các chuỗi đầu vào cùng các thông tin khác để truyền cho .decode_best_spans. Nó chuyển đổi các chuỗi của một câu hỏi và các đoạn văn khác nhau (tiêu đề và nội dung) thành một dãy ID (số nguyên), sử dụng tokenizer và bảng từ vựng. Kết quả input_ids là một ma trận có kích thước (n_passages, sequence_length)

với định dạng:

[CLS] <question token ids> [SEP] <titles ids> [SEP] <texts ids>

DPRReaderTokenizerFast

lớp transformers.DPRReaderTokenizerFast

< >

( vocab: str | dict[str, int] | None = Nonedo_lower_case: bool = Trueunk_token: str = '[UNK]'sep_token: str = '[SEP]'pad_token: str = '[PAD]'cls_token: str = '[CLS]'mask_token: str = '[MASK]'tokenize_chinese_chars: bool = Truestrip_accents: bool | None = None**kwargs ) → dict[str, list[list[int]]]

Tham số

  • questions (str hoặc list[str]) — Các câu hỏi cần được mã hóa. Bạn có thể chỉ định một câu hỏi cho nhiều đoạn văn. Trong trường hợp này, câu hỏi sẽ được nhân bản thành [questions] * n_passages. Ngược lại, bạn phải chỉ định số lượng câu hỏi tương ứng với số lượng trong titles hoặc texts.
  • titles (str hoặc list[str]) — Tiêu đề của các đoạn văn cần được mã hóa. Đây có thể là một chuỗi hoặc một danh sách các chuỗi nếu có nhiều đoạn văn.
  • texts (str hoặc list[str]) — Các đoạn văn bản cần được mã hóa. Đây có thể là một chuỗi hoặc một danh sách các chuỗi nếu có nhiều đoạn văn bản.
  • padding (bool, str hoặc PaddingStrategy, tùy chọn, mặc định là False) — Kích hoạt và kiểm soát padding. Chấp nhận các giá trị sau:
    • True hoặc 'longest': Lấp đầy (pad) đến độ dài của chuỗi dài nhất trong batch (hoặc không lấp đầy nếu chỉ có một chuỗi được cung cấp).
    • 'max_length': Đệm (pad) đến độ dài tối đa được chỉ định bằng tham số max_length hoặc đến độ dài đầu vào tối đa mà mô hình chấp nhận được nếu tham số đó không được cung cấp.
    • False hoặc 'do_not_pad' (mặc định): Không đệm (tức là có thể xuất ra một lô với các chuỗi có độ dài khác nhau).
  • truncation (bool, str hoặc TruncationStrategy, tùy chọn, mặc định là False) — Kích hoạt và kiểm soát việc cắt ngắn. Chấp nhận các giá trị sau:
    • True hoặc 'longest_first': Cắt ngắn xuống độ dài tối đa được chỉ định bằng tham số max_length hoặc xuống độ dài đầu vào tối đa chấp nhận được của mô hình nếu tham số đó không được cung cấp. Thao tác này sẽ cắt ngắn theo từng token, loại bỏ một token từ chuỗi dài nhất trong cặp nếu một cặp chuỗi (hoặc một lô các cặp) được cung cấp.
    • 'only_first': Cắt ngắn xuống độ dài tối đa được chỉ định bằng tham số max_length hoặc xuống độ dài đầu vào tối đa mà mô hình chấp nhận được nếu tham số đó không được cung cấp. Thao tác này chỉ cắt ngắn chuỗi đầu tiên của một cặp nếu một cặp chuỗi (hoặc một lô các cặp) được cung cấp.
    • 'only_second': Cắt ngắn xuống độ dài tối đa được chỉ định bằng tham số max_length hoặc xuống độ dài đầu vào tối đa mà mô hình chấp nhận được nếu tham số đó không được cung cấp. Thao tác này chỉ cắt ngắn chuỗi thứ hai của một cặp nếu một cặp chuỗi (hoặc một lô các cặp) được cung cấp.
    • False hoặc 'do_not_truncate' (mặc định): Không cắt bớt (tức là có thể xuất ra batch với độ dài chuỗi lớn hơn kích thước đầu vào tối đa cho phép của mô hình).
  • max_length (int, tuỳ chọn) — Kiểm soát độ dài tối đa được sử dụng bởi một trong các tham số cắt/giữ chỗ (truncation/padding).

    Nếu không được đặt hoặc được đặt thành None, tham số này sẽ sử dụng độ dài tối đa định trước của mô hình nếu một trong các tham số cắt/giữ chỗ yêu cầu độ dài tối đa. Nếu mô hình không có độ dài đầu vào tối đa cụ thể (như XLNet), việc cắt/giữ chỗ đến độ dài tối đa sẽ bị vô hiệu hóa.

  • return_tensors (str hoặc TensorType, tùy chọn) — Nếu được đặt, sẽ trả về tensor thay vì danh sách các số nguyên Python. Các giá trị chấp nhận được là:
    • 'pt': Trả về các đối tượng torch.Tensor của PyTorch.
    • 'np': Trả về các đối tượng Numpy np.ndarray.
  • return_attention_mask (bool, tuỳ chọn) — Có trả về attention mask hay không. Nếu không được đặt, sẽ trả về attention mask theo mặc định của tokenizer cụ thể, được xác định bởi thuộc tính return_outputs .

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

Trả về

dict[str, list[list[int]]]

Một từ điển có các khóa sau:

  • input_ids: Danh sách các id token để đưa vào mô hình.
  • attention_mask: Danh sách các chỉ số chỉ định những token nào nên được mô hình chú ý đến.

Tạo một tokenizer DPRReader “nhanh” (dựa trên thư viện tokenizers của HuggingFace).

DPRReaderTokenizerFast gần như giống hệt với BertTokenizer và thực hiện tokenization từ đầu đến cuối: tách dấu câu và wordpiece. Điểm khác biệt là nó có ba chuỗi đầu vào: question, titles và texts được kết hợp lại để đưa vào mô hình DPRReader.

Tham khảo siêu lớp BertTokenizer để xem các ví dụ sử dụng và tài liệu liên quan đến các tham số.

Trả về một từ điển chứa các token id của các chuỗi đầu vào cùng các thông tin khác để truyền cho .decode_best_spans. Nó chuyển đổi các chuỗi của một câu hỏi và các đoạn văn khác nhau (tiêu đề và nội dung) thành một dãy ID (số nguyên), sử dụng tokenizer và bảng từ vựng. Kết quả input_ids là một ma trận có kích thước (n_passages, sequence_length) với định dạng:

[CLS] <question token ids> [SEP] <titles ids> [SEP] <texts ids>

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

lớp transformers.models.dpr.modeling_dpr.DPRContextEncoderOutput

< >

( pooler_output: FloatTensorhidden_states: tuple[torch.FloatTensor, ...] | None = Noneattentions: tuple[torch.FloatTensor, ...] | None = None )

Tham số

  • pooler_output (torch.FloatTensor có shape (batch_size, embeddings_size)) — Bộ mã hóa DPR xuất ra pooler_output tương ứng với biểu diễn ngữ cảnh. Trạng thái ẩn của lớp cuối cùng của token đầu tiên trong chuỗi (token phân loại) được xử lý tiếp bởi một lớp Linear. Đầu ra này được dùng để nhúng ngữ cảnh cho các truy vấn láng giềng gần nhất với các embedding câu hỏi.
  • hidden_states (tuple[torch.FloatTensor, ...], tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Tuple của torch.FloatTensor (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.FloatTensor, ...], 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.FloatTensor (một cho mỗi lớp) có hình dạng (batch_size, num_heads, sequence_length, sequence_length).

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

Lớp cho đầu ra của DPRQuestionEncoder.

lớp transformers.models.dpr.modeling_dpr.DPRQuestionEncoderOutput

< >

( pooler_output: FloatTensorhidden_states: tuple[torch.FloatTensor, ...] | None = Noneattentions: tuple[torch.FloatTensor, ...] | None = None )

Tham số

  • pooler_output (torch.FloatTensor có shape (batch_size, embeddings_size)) — Bộ mã hóa DPR xuất ra pooler_output tương ứng với biểu diễn của câu hỏi. Trạng thái ẩn của lớp cuối cùng của token đầu tiên trong chuỗi (token phân loại) được xử lý tiếp bởi một lớp Linear. Đầu ra này được dùng để nhúng các câu hỏi cho các truy vấn láng giềng gần nhất với các embedding ngữ cảnh.
  • hidden_states (tuple[torch.FloatTensor, ...], tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Tuple của torch.FloatTensor (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.FloatTensor, ...], 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.FloatTensor (một cho mỗi lớp) có hình dạng (batch_size, num_heads, sequence_length, sequence_length).

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

Lớp cho đầu ra của DPRQuestionEncoder.

lớp transformers.DPRReaderOutput

< >

( start_logits: FloatTensorend_logits: typing.Optional[torch.FloatTensor] = Nonerelevance_logits: typing.Optional[torch.FloatTensor] = Nonehidden_states: tuple[torch.FloatTensor, ...] | None = Noneattentions: tuple[torch.FloatTensor, ...] | None = None )

Tham số

  • start_logits (torch.FloatTensor có hình dạng (n_passages, sequence_length)) — Logits của chỉ số bắt đầu của đoạn (span) cho mỗi passage.
  • end_logits (torch.FloatTensor có hình dạng (n_passages, sequence_length)) — Logits của chỉ số kết thúc của span cho mỗi passage.
  • relevance_logits (torch.FloatTensor có hình dạng (n_passages, )) — Đầu ra của bộ phân loại QA của DPRReader, tương ứng với điểm số của mỗi đoạn văn để trả lời câu hỏi, so với tất cả các đoạn văn khác.
  • hidden_states (tuple[torch.FloatTensor, ...], tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Tuple của torch.FloatTensor (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.FloatTensor, ...], 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.FloatTensor (một cho mỗi lớp) có hình dạng (batch_size, num_heads, sequence_length, sequence_length).

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

Lớp cho đầu ra của DPRQuestionEncoder.

DPRContextEncoder

lớp transformers.DPRContextEncoder

< >

( config: DPRConfig )

Tham số

  • config (DPRConfig) — 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 sẽ 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 DPRContextEncoder cơ bản, xuất ra các đầu ra pooler dưới dạng các biểu diễn ngữ cảnh.

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] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → DPRContextEncoderOutput or tuple(torch.FloatTensor)

Tham số

  • input_ids (torch.LongTensor có hình dạng (batch_size, sequence_length)) — Chỉ số của các token trong chuỗi đầu vào theo từ vựng. Để khớp với quá trình tiền huấn luyện, chuỗi đầu vào của DPR nên được định dạng bằng các token [CLS] và [SEP] như sau:

    (a) Đối với các cặp chuỗi (ví dụ: một cặp tiêu đề + nội dung):

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

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

  • 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.
  • 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ề

DPRContextEncoderOutput hoặc tuple(torch.FloatTensor)

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

Phương thức forward của DPRContextEncoder ghi đè 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.

  • pooler_output (torch.FloatTensor có shape (batch_size, embeddings_size)) — Bộ mã hóa DPR xuất ra pooler_output tương ứng với biểu diễn ngữ cảnh. Trạng thái ẩn của lớp cuối cùng của token đầu tiên trong chuỗi (token phân loại) được xử lý tiếp bởi một lớp Linear. Đầu ra này được dùng để nhúng ngữ cảnh cho các truy vấn láng giềng gần nhất với các embedding câu hỏi.

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

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

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

    Trọng số 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.

tokens:         [CLS] is this jack ##son ##ville ? [SEP] no it is not . [SEP]
token_type_ids:   0   0  0    0    0     0       0   0   1  1  1  1   1   1

(b) Đối với các chuỗi đơn (ví dụ như một câu hỏi):

tokens:         [CLS] the dog is hairy . [SEP]
token_type_ids:   0   0   0   0  0     0   0

DPR là một mô hình có nhúng vị trí tuyệt đối nên thường được khuyến nghị đệm đầu vào bên phải thay vì bên trái.

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

Ví dụ:

>>> from transformers import DPRContextEncoder, DPRContextEncoderTokenizer

>>> tokenizer = DPRContextEncoderTokenizer.from_pretrained("facebook/dpr-ctx_encoder-single-nq-base")
>>> model = DPRContextEncoder.from_pretrained("facebook/dpr-ctx_encoder-single-nq-base")
>>> input_ids = tokenizer("Hello, is my dog cute ?", return_tensors="pt")["input_ids"]
>>> embeddings = model(input_ids).pooler_output

DPRQuestionEncoder

lớp transformers.DPRQuestionEncoder

< >

( config: DPRConfig )

Tham số

  • config (DPRConfig) — 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 sẽ 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 DPRQuestionEncoder cơ bản, xuất ra các đầu ra pooler dưới dạng biểu diễn câu hỏi.

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

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

forward

< >

( input_ids: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → DPRQuestionEncoderOutput or tuple(torch.FloatTensor)

Tham số

  • input_ids (torch.LongTensor có hình dạng (batch_size, sequence_length)) — Chỉ số của các token trong chuỗi đầu vào theo từ vựng. Để khớp với quá trình tiền huấn luyện, chuỗi đầu vào của DPR nên được định dạng bằng các token [CLS] và [SEP] như sau:

    (a) Đối với các cặp chuỗi (ví dụ: một cặp tiêu đề + nội dung):

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

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

  • 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.
  • 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ề

DPRQuestionEncoderOutput hoặc tuple(torch.FloatTensor)

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

Phương thức forward của DPRQuestionEncoder 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.

  • pooler_output (torch.FloatTensor có shape (batch_size, embeddings_size)) — Bộ mã hóa DPR xuất ra pooler_output tương ứng với biểu diễn của câu hỏi. Trạng thái ẩn của lớp cuối cùng của token đầu tiên trong chuỗi (token phân loại) được xử lý tiếp bởi một lớp Linear. Đầu ra này được dùng để nhúng các câu hỏi cho các truy vấn láng giềng gần nhất với các embedding ngữ cảnh.

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

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

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

    Trọng số 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.

tokens:         [CLS] is this jack ##son ##ville ? [SEP] no it is not . [SEP]
token_type_ids:   0   0  0    0    0     0       0   0   1  1  1  1   1   1

(b) Đối với các chuỗi đơn (ví dụ như một câu hỏi):

tokens:         [CLS] the dog is hairy . [SEP]
token_type_ids:   0   0   0   0  0     0   0

DPR là một mô hình có nhúng vị trí tuyệt đối nên thường được khuyến nghị đệm đầu vào bên phải thay vì bên trái.

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

Ví dụ:

>>> from transformers import DPRQuestionEncoder, DPRQuestionEncoderTokenizer

>>> tokenizer = DPRQuestionEncoderTokenizer.from_pretrained("facebook/dpr-question_encoder-single-nq-base")
>>> model = DPRQuestionEncoder.from_pretrained("facebook/dpr-question_encoder-single-nq-base")
>>> input_ids = tokenizer("Hello, is my dog cute ?", return_tensors="pt")["input_ids"]
>>> embeddings = model(input_ids).pooler_output

DPRReader

lớp transformers.DPRReader

< >

( config: DPRConfig )

Tham số

  • config (DPRConfig) — 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 sẽ 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 DPRReader cơ bản, xuất ra các dự đoán span.

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] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → DPRReaderOutput or tuple(torch.FloatTensor)

Tham số

  • input_ids (tuple[torch.LongTensor] có hình dạng (n_passages, sequence_length)) — Chỉ số của các token trong chuỗi đầu vào theo từ điển. Nó phải là một bộ ba chuỗi gồm 1) câu hỏi, 2) tiêu đề các đoạn văn và 3) nội dung các đoạn văn. Để khớp với quá trình tiền huấn luyện, DPR input_ids chuỗi nên được định dạng bằng [CLS] và [SEP] theo cấu trúc:

    [CLS] <question token ids> [SEP] <titles ids> [SEP] <texts ids>

    DPR là một mô hình có nhúng vị trí tuyệt đối nên thường được khuyến nghị đệm đầu vào bên phải thay vì bên trái.

    Các chỉ số có thể được lấy bằng cách sử dụng DPRReaderTokenizer. Xem tài liệu của lớp này để 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ì?

  • inputs_embeds (torch.FloatTensor có hình dạng (n_passages, 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.
  • 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ề

DPRReaderOutput hoặc tuple(torch.FloatTensor)

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

Phương thức forward của DPRReader 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.

  • start_logits (torch.FloatTensor có hình dạng (n_passages, sequence_length)) — Logits của chỉ số bắt đầu của span cho mỗi passage.

  • end_logits (torch.FloatTensor có hình dạng (n_passages, sequence_length)) — Logits của chỉ số kết thúc của span cho mỗi passage.

  • relevance_logits (torch.FloatTensor có shape (n_passages, )) — Đầu ra của bộ phân loại QA của DPRReader, tương ứng với điểm số của mỗi passage để trả lời câu hỏi, so với tất cả các passage khác.

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

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

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

    Trọng số 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 DPRReader, DPRReaderTokenizer

>>> tokenizer = DPRReaderTokenizer.from_pretrained("facebook/dpr-reader-single-nq-base")
>>> model = DPRReader.from_pretrained("facebook/dpr-reader-single-nq-base")
>>> encoded_inputs = tokenizer(
...     questions=["What is love ?"],
...     titles=["Haddaway"],
...     texts=["'What Is Love' is a song recorded by the artist Haddaway"],
...     return_tensors="pt",
... )
>>> outputs = model(**encoded_inputs)
>>> start_logits = outputs.start_logits
>>> end_logits = outputs.end_logits
>>> relevance_logits = outputs.relevance_logits
Update on GitHub

←dots1 ELECTRA→