Transformers documentation

XLM

Transformers

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).

Join the Hugging Face community

and get access to the augmented documentation experience

Collaborate on models, datasets and Spaces

Faster examples with accelerated inference

Switch between documentation themes

to get started

이 모델은 2019-01-22에 HF papers에 게시되었으며, 2020-11-16에 Hugging Face Transformers에 기여되었습니다.

XLM

XLM은 두 가지 접근 방식을 통해 언어 간 사전 학습을 수행합니다. 하나는 단일 언어에 대한 비지도 학습이고, 다른 하나는 언어 간 언어 모델링 목적을 사용하여 두 개 이상의 언어에 대한 지도 학습입니다. XLM 모델은 인과 언어 모델링, 마스킹된 언어 모델링, 번역 언어 모델링(여러 언어 입력으로 확장된 BERT의 마스킹된 언어 모델링 목적)를 지원합니다.

모든 원본 XLM 체크포인트는 Facebook AI community 조직에서 찾을 수 있습니다.

XLM 모델에 대한 더 많은 예제, 즉 분류, 번역, 질의응답과 같은 다양한 언어 간 작업에 XLM을 적용하는 방법을 확인하려면 오른쪽 사이드바의 XLM 모델을 클릭하세요.

아래 예제는 Pipeline, AutoModel 및 명령줄을 사용하여 <mask> 토큰을 예측하는 방법을 보여줍니다.

Pipeline

AutoModel

XLMConfig

클래스 transformers.XLMConfig

< source >

( 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 = 30145emb_dim: int = 2048n_layers: int = 12n_heads: int = 16dropout: float | int = 0.1attention_dropout: float | int = 0.1gelu_activation: bool = Truesinusoidal_embeddings: bool = Falsecausal: bool = Falseasm: bool = Falsen_langs: int = 1use_lang_emb: bool = Truemax_position_embeddings: int = 512embed_init_std: float = 0.02209708691207961layer_norm_eps: float = 1e-12init_std: float = 0.02unk_index: int = 3mask_index: int = 5is_encoder: bool = Truesummary_type: str = 'first'summary_use_proj: bool = Truesummary_activation: str | None = Nonesummary_proj_to_labels: bool = Truesummary_first_dropout: float | int = 0.1start_n_top: int = 5end_n_top: int = 5mask_token_id: int | None = 0lang_id: int = 0pad_token_id: int | None = 2bos_token_id: int | None = 0eos_token_id: int | list[int] | None = 1tie_word_embeddings: bool = True )

매개변수

vocab_size (int, 선택 사항, 기본값 30145) — 모델의 어휘 크기입니다. input_ids로 표현할 수 있는 서로 다른 토큰의 수를 정의합니다.
emb_dim (int, 선택 사항, 기본값 2048) — 임베딩 및 숨겨진 상태의 차원.
n_layers (int, 선택 사항, 기본값 12) — Transformer decoder의 숨겨진 레이어 수입니다.
n_heads (int, 선택 사항, 기본값 16) — Transformer decoder의 각 attention layer에 사용할 attention head의 수입니다.
dropout (Union[float, int], 선택 사항, 기본값 0.1) — 모든 dropout 레이어에 적용할 비율입니다.
attention_dropout (Union[float, int], 선택 사항, 기본값 0.1) — Attention 확률에 적용할 dropout 비율입니다.
gelu_activation (bool, 선택 사항, 기본값 True) — 활성화 함수로 relu 대신 gelu를 사용할지 여부입니다.
sinusoidal_embeddings (bool, 선택 사항, 기본값 False) — 절대 위치 임베딩 대신 사인oidal 위치 임베딩을 사용할지 여부.
causal (bool, 선택 사항, 기본값 False) — 모델이 인과적(causal) 방식으로 동작할지 여부입니다. 인과적 모델은 양방향 컨텍스트 대신 왼쪽 컨텍스트에만 주의를 기울이도록 삼각형 attention mask를 사용합니다.
asm (bool, 선택 사항, 기본값 False) — 예측 계층에 선형 계층 대신 적응형 로그 소프트맥스 투영 계층을 사용할지 여부.
n_langs (int, 선택 사항, 기본값 1) — 모델이 처리하는 언어의 수입니다. 단일 언어 모델의 경우 1로 설정합니다.
use_lang_emb (bool, 선택 사항, 기본값 True) — 언어 임베딩을 사용할지 여부입니다. 일부 모델은 추가적인 언어 임베딩을 사용하며, 사용 방법은 다국어 모델 페이지를 참고하세요.
max_position_embeddings (int, 선택 사항, 기본값 512) — 이 모델이 사용될 수 있는 최대 시퀀스 길이입니다.
embed_init_std (float, 선택 사항, 기본값 2048^-0.5) — 임베딩 행렬을 초기화하는 truncated_normal_initializer의 표준 편차입니다.
layer_norm_eps (float, 선택 사항, 기본값 1e-12) — 레이어 정규화 레이어에서 사용되는 epsilon 값입니다.
init_std (float, 선택 사항, 기본값 0.02) — 모든 가중치 행렬을 초기화하는 truncated_normal_initializer의 표준 편차입니다.
unk_index (int, 선택 사항, 기본값 3) — 어휘에서 unknown 토큰의 인덱스입니다.
mask_index (int, 선택 사항, 기본값 5) — 어휘에서 마스킹 토큰의 인덱스입니다.
is_encoder (bool, 선택 사항, 기본값 True) — 초기화할 모델이 Vaswani et al.에서 제시한 transformer encoder인지 decoder인지 여부를 지정합니다.
summary_type (string, 선택 사항, 기본값은 “first”입니다) — 시퀀스 요약 시 사용되는 인자입니다. 시퀀스 분류 및 다중 선택 모델에서 사용됩니다. 다음 옵션 중 하나여야 합니다:
- "last": 마지막 토큰의 hidden state를 가져옵니다(XLNet과 유사).
- "first": 첫 번째 토큰의 hidden state를 사용합니다(BERT와 동일).
- "mean": 모든 토큰의 hidden states 평균을 취합니다.
- "cls_index": 분류 토큰 위치(Tensor)를 지정합니다(GPT/GPT-2와 유사).
- "attn": 현재 구현되지 않았으며, multi-head attention을 사용합니다.
summary_use_proj (bool, 선택 사항, 기본값 True) — 시퀀스 요약 수행 시 사용되는 인자입니다. 시퀀스 분류 및 다중 선택 모델에서 사용됩니다. 벡터 추출 후 투영(projection)을 추가할지 여부를 지정합니다.
summary_activation (str, 선택 사항) — 시퀀스 요약 시 사용되는 인자입니다. 시퀀스 분류 및 다중 선택 모델에서 사용됩니다. 출력에 tanh 활성화 함수를 적용하려면 "tanh"를 전달하세요. 다른 값은 활성화 함수를 적용하지 않습니다.
summary_proj_to_labels (bool, 선택, 기본값 True) — 시퀀스 분류 및 다중 선택 모델에서 사용됩니다. 투출 출력이 config.num_labels개 클래스인지, config.hidden_size개 클래스인지 여부를 결정합니다.
summary_first_dropout (float, 선택 사항, 기본값 0.1) — 시퀀스 분류 및 다중 선택 모델에서 사용됩니다. 투영 및 활성화 이후에 사용할 드롭아웃 비율입니다.
start_n_top (int, 선택 사항, 기본값 5) — SQuAD 평가 스크립트에서 사용됩니다.
end_n_top (int, 선택 사항, 기본값 5) — SQuAD 평가 스크립트에서 사용됩니다.
mask_token_id (int, 선택 사항, 기본값 0) — MLM 컨텍스트에서 텍스트를 생성할 때 마스킹된 토큰을 식별하는 모델 비종속적 매개변수입니다.
lang_id (int, 선택 사항, 기본값 1) — 모델이 사용하는 언어의 ID입니다. 이 매개변수는 특정 언어로 텍스트를 생성할 때 사용됩니다.
pad_token_id (int, 선택 사항, 기본값 2) — 어휘에서 패딩에 사용되는 토큰 ID입니다.
bos_token_id (int, 선택 사항, 기본값 0) — 어휘에서 스트림 시작에 사용되는 토큰 id입니다.
eos_token_id (Union[int, list[int]], 선택 사항, 기본값 1) — 어휘에서 스트림 종료에 사용되는 토큰 id입니다.
tie_word_embeddings (bool, 선택, 기본값 True) — 모델의 tied_weights_keys 매핑에 따라 가중치 임베딩을 묶을지 여부.

이것은 XLMModel의 설정을 저장하기 위한 설정 클래스입니다. 지정된 인수를 기반으로 Xlm 모델을 인스턴스화하여 모델 아키텍처를 정의하는 데 사용됩니다. 기본값으로 설정을 인스턴스화하면 FacebookAI/xlm-mlm-en-2048와 유사한 설정이 생성됩니다.

Configuration 객체는 PreTrainedConfig를 상속하며 모델 출력을 제어하는 데 사용할 수 있습니다. 자세한 내용은 PreTrainedConfig의 문서를 참고하세요.

예:

>>> from transformers import XLMConfig, XLMModel

>>> # Initializing a XLM configuration
>>> configuration = XLMConfig()

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

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

XLMTokenizer

클래스 transformers.XLMTokenizer

< source >

( vocab_filemerges_fileunk_token = '<unk>'bos_token = '<s>'sep_token = '</s>'pad_token = '<pad>'cls_token = '</s>'mask_token = '<special1>'additional_special_tokens = ['<special0>', '<special1>', '<special2>', '<special3>', '<special4>', '<special5>', '<special6>', '<special7>', '<special8>', '<special9>']lang2id = Noneid2lang = Nonedo_lowercase_and_remove_accent = True**kwargs )

매개변수

vocab_file (str) — 어휘 파일.
merges_file (str) — Merges 파일.
unk_token (str, 선택 사항, 기본값 "<unk>") — 미지의 토큰입니다. 어휘에 없는 토큰은 ID로 변환할 수 없으므로, 대신 이 토큰으로 설정됩니다.
bos_token (str, 선택 사항, 기본값은 "<s>") — 사전 학습 시 사용된 시퀀스 시작 토큰입니다. 시퀀스 분류기 토큰으로 사용할 수 있습니다.

특수 토큰을 사용하여 시퀀스를 구성할 때, 시퀀스의 시작에 사용되는 토큰은 이 토큰이 아닙니다. 사용되는 토큰은 cls_token입니다.
sep_token (str, 선택, 기본값 "</s>") — 여러 시퀀스로 시퀀스를 구성할 때 사용되는 구분 토큰입니다. 예를 들어 시퀀스 분류의 두 시퀀스나 질의응답의 텍스트와 질문 등에 사용됩니다. 특수 토큰으로 구성된 시퀀스의 마지막 토큰으로도 사용됩니다.
pad_token (str, 선택 사항, 기본값 "<pad>") — 패딩에 사용되는 토큰입니다. 예를 들어, 길이가 다른 시퀀스를 배치(batching)할 때 사용됩니다.
cls_token (str, 선택 사항, 기본값 "</s>") — 시퀀스 분류(토큰별 분류가 아닌 전체 시퀀스 분류)를 수행할 때 사용되는 분류기 토큰입니다. 특수 토큰을 사용하여 시퀀스를 구성할 경우 시퀀스의 첫 번째 토큰입니다.
mask_token (str, 선택 사항, 기본값 "<special1>") — 값을 마스킹하는 데 사용되는 토큰입니다. 이는 해당 모델을 masked language modeling으로 학습할 때 사용되는 토큰이며, 모델이 예측을 시도하는 대상이 되는 토큰입니다.
additional_special_tokens (List[str], 선택 사항, 기본값 ['<special0>', '<special1>', '<special2>', '<special3>', '<special4>', '<special5>', '<special6>', '<special7>', '<special8>', '<special9>']) — 추가 특수 토큰 목록입니다.
lang2id (Dict[str, int], 선택) — 언어 문자열 식별자를 해당 ID로 매핑하는 사전입니다.
id2lang (Dict[int, str], 선택 사항) — 언어 ID를 문자열 식별자로 매핑하는 사전입니다.
do_lowercase_and_remove_accent (bool, 선택 사항, 기본값 True) — 토큰화 시 소문자로 변환하고 악센트를 제거할지 여부입니다.

XLM 토크나이저를 구성합니다. Byte-Pair Encoding에 기반합니다. 토크나이징 과정은 다음과 같습니다:

대부분의 지원 언어에 대한 Moses 전처리 및 토큰화.
Chinese (Jieba), Japanese (KyTea), Thai (PyThaiNLP)에 대한 언어별 토큰화.
입력 텍스트를 모두 소문자로 변환하고 정규화합니다(선택 사항).
인수 special_tokens와 함수 set_special_tokens를 사용하면 어휘에 추가 기호(예: ”classify”)를 추가할 수 있습니다.
lang2id 속성은 제공된 경우 모델이 지원하는 언어를 해당 ID에 매핑합니다(사전 학습된 어휘의 경우 자동으로 설정됨).
id2lang 속성이 제공되면 역 매핑을 수행합니다(사전 학습된 어휘의 경우 자동으로 설정됨).

이 토크나이저는 대부분의 주요 메서드를 포함하는 PreTrainedTokenizer를 상속합니다. 해당 메서드에 대한 자세한 내용은 이 상위 클래스를 참고하세요.

build_inputs_with_special_tokens

< source >

( token_ids_0: listtoken_ids_1: list[int] | None = None ) → List[int]

매개변수

token_ids_0 (List[int]) — 특별 토큰이 추가될 ID 목록입니다.
token_ids_1 (List[int], 선택 사항) — 시퀀스 쌍을 위한 선택적 두 번째 ID 목록입니다.

반환값

List[int]

적절한 특수 토큰이 포함된 입력 ID 목록

시퀀스 분류 작업을 위해 시퀀스 하나 또는 시퀀스 쌍을 연결하고 특수 토큰을 추가하여 모델 입력을 구성합니다. XLM 시퀀스는 다음과 같은 형식을 가집니다:

단일 시퀀스: <s> X </s>
시퀀스 쌍: <s> A </s> B </s>

get_special_tokens_mask

< source >

( token_ids_0: listtoken_ids_1: list[int] | None = Nonealready_has_special_tokens: bool = False ) → List[int]

매개변수

token_ids_0 (List[int]) — ID 목록.
token_ids_1 (List[int], 선택 사항) — 시퀀스 쌍을 위한 선택적 두 번째 ID 목록입니다.
already_has_special_tokens (bool, 선택, 기본값 False) — 토큰 목록이 이미 모델의 특수 토큰으로 포맷되어 있는지 여부입니다.

반환값

List[int]

[0, 1] 범위의 정수 목록: 특수 토큰은 1, 시퀀스 토큰은 0.

특수 토큰이 추가되지 않은 토큰 목록에서 시퀀스 ID를 가져옵니다. 이 메서드는 토크나이저의 prepare_for_model 메서드를 사용하여 특수 토큰을 추가할 때 호출됩니다.

create_token_type_ids_from_sequences

< source >

( token_ids_0: listtoken_ids_1: list[int] | None = None ) → list[int]

매개변수

token_ids_0 (list[int]) — ID 목록.
token_ids_1 (list[int], 선택 사항) — 시퀀스 쌍을 위한 선택적 두 번째 ID 목록입니다.

반환값

list[int]

구성된 패턴에 따른 토큰 유형 ID입니다.

시퀀스-페어 분류 작업에 사용될 마스크를 전달된 두 시퀀스에서 생성합니다.

이 메서드는 토크나이저의 구성 속성을 기반으로 토큰 유형 ID를 동적으로 생성합니다:

token_type_ids_pattern: 사용할 패턴(“all_zeros” 또는 “bert_style”)
token_type_ids_include_special_tokens: 길이 계산에 특수 토큰을 포함할지 여부

예:

# All zeros pattern (default, used by RoBERTa, BART, etc.)
tokenizer.token_type_ids_pattern = "all_zeros"
# Returns: [0, 0, 0, ...] for both sequences

# BERT-style pattern (first sequence gets 0s, second gets 1s)
tokenizer.token_type_ids_pattern = "bert_style"
# Returns: [0, 0, 0, ..., 1, 1, 1, ...] for sequence pairs

save_vocabulary

< source >

( save_directory: strfilename_prefix: str | None = None )

XLM 전용 출력

class transformers.models.xlm.modeling_xlm.XLMForQuestionAnsweringOutput

< source >

( 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] = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )

매개변수

loss (torch.Tensor, shape (1,), 선택 사항, start_positions와 end_positions가 모두 제공된 경우 반환됨) — 시작 토큰, 종료 토큰(제공된 경우 is_impossible 포함) 분류 손실의 합으로 계산된 분류 손실.
start_top_log_probs (torch.Tensor, shape (batch_size, config.start_n_top), 선택 사항, start_positions 또는 end_positions이 제공되지 않은 경우 반환됨) — beam-search에서 상위 config.start_n_top 개 시작 토큰 가능성에 대한 로그 확률입니다.
start_top_index (torch.LongTensor, shape (batch_size, config.start_n_top), 선택 사항, start_positions 또는 end_positions가 제공되지 않은 경우 반환됨) — beam-search에서 상위 config.start_n_top 개 시작 토큰 가능성에 대한 인덱스입니다.
end_top_log_probs (torch.Tensor, shape (batch_size, config.start_n_top * config.end_n_top), 선택 사항, start_positions 또는 end_positions이 제공되지 않은 경우 반환됨) — (beam-search) 상위 config.start_n_top * config.end_n_top 개 end token 가능성에 대한 로그 확률
end_top_index (torch.LongTensor, shape (batch_size, config.start_n_top * config.end_n_top), 선택 사항, start_positions 또는 end_positions가 제공되지 않은 경우 반환됨) — 상위 config.start_n_top * config.end_n_top 개 end token 가능성에 대한 인덱스(beam-search).
cls_logits (torch.Tensor, shape (batch_size,), 선택 사항, start_positions 또는 end_positions이 제공되지 않은 경우 반환됨) — 답변의 is_impossible 라벨에 대한 로그 확률입니다.
hidden_states (tuple[torch.Tensor, ...], 선택 사항, 다음 조건에서 반환됩니다: output_hidden_states=True 이 전달되거나 config.output_hidden_states=True) — 다음 형태의 튜플: torch.Tensor (임베딩이 있는 경우 임베딩 레이어의 출력 1개 + 각 레이어의 출력 1개)로, 형태는 (batch_size, sequence_length, hidden_size).
각 레이어의 출력에서 모델의 Hidden-states와 선택적 초기 임베딩 출력을 포함합니다.
attentions (tuple[torch.Tensor, ...], 선택 사항, 다음 조건에서 반환됩니다: output_attentions=True 이 전달되거나 config.output_attentions=True) — 다음의 튜플입니다: torch.Tensor (각 레이어당 하나씩, 모양이 (batch_size, num_heads, sequence_length, sequence_length).
self-attention 헤드에서 가중 평균을 계산하는 데 사용되는 attention softmax 이후의 attention 가중치.

XLMSQuADHead를 사용하는 질의응답 모델의 출력에 대한 기본 클래스입니다.

XLMModel

class transformers.XLMModel

< source >

( config: XLMConfig )

매개변수

config (XLMConfig) — 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하는 것은 모델과 관련된 가중치를 로드하지 않으며, 구성 정보만 로드합니다. 모델 가중치를 로드하려면 from_pretrained() 메서드를 확인하세요.

특정 헤드가 위에 없는 상태에서 원시 hidden-states를 출력하는 기본 Xlm 모델입니다.

이 모델은 PreTrainedModel에서 상속됩니다. 라이브러리가 모든 모델에 대해 구현하는 일반적 메서드(다운로드 또는 저장, 입력 임베딩 크기 조정, 헤드 프루닝 등)에 대한 세부 사항은 상위 클래스 문서를 확인하세요.

이 모델은 또한 PyTorch torch.nn.Module의 하위 클래스입니다. 일반적인 PyTorch Module처럼 사용하며, 일반적인 사용법 및 동작과 관련된 모든 사항은 PyTorch 문서를 참조하세요.

forward

< source >

매개변수

input_ids (torch.Tensor 의 shape (batch_size, sequence_length), , 선택 사항) — 어휘(input vocabulary)에서 입력 시퀀스 토큰의 인덱스입니다. 기본적으로 패딩은 무시됩니다.
AutoTokenizer를 사용하여 인덱스를 얻을 수 있습니다. 자세한 내용은 PreTrainedTokenizer.encode() 및 PreTrainedTokenizer.call()를 참조하세요.

입력 ID란 무엇인가요?
attention_mask (torch.Tensor 형상이 (batch_size, sequence_length), 선택 사항) — 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 방지하는 마스크. [0, 1]에서 선택된 마스크 값: 마스크되지 않은 토큰은 1, 마스크된 토큰은 0. attention mask란 무엇인가요? [0, 1]:
- 마스크되지 않은 토큰에 대해 1
- 마스크된 토큰에 대해 0
어텐션 마스크란 무엇인가요?
langs (torch.LongTensor 형상이 (batch_size, sequence_length), 선택 사항) — 입력에서 각 토큰의 언어를 나타내는 데 사용되는 병렬 토큰 시퀀스입니다. 인덱스는 모델 설정에서 제공되는 두 가지 변환 매핑을 사용하여 언어 이름에서 얻을 수 있는 언어 ID입니다(다국어 모델에만 제공됨). 보다 구체적으로, 언어 이름에서 언어 ID로 매핑하는 것은 model.config.lang2id ((문자열에서 int로 변환하는 딕셔너리)이고, 언어 ID에서 언어 이름으로 매핑하는 것은 model.config.id2lang ((int에서 문자열로 변환하는 딕셔너리)입니다.
다국어 문서에 자세히 설명된 사용 예시를 참조하세요.
token_type_ids (torch.Tensor 형상 (batch_size, sequence_length), 선택 사항) — 입력의 첫 번째 및 두 번째 부분을 나타내는 세그먼트 토큰 인덱스. 인덱스는 [0, 1]:
- 0은 sentence A 토큰에 해당합니다.
- 1은 sentence B 토큰에 해당합니다.
토큰 타입 ID란 무엇인가요?
position_ids (torch.Tensor 의 shape (batch_size, sequence_length), , 선택 사항) — 입력 시퀀스 토큰의 위치 임베딩에서 각 토큰의 위치 인덱스. 범위는 [0, config.n_positions - 1].
포지션 ID란 무엇인가요?
lengths (torch.LongTensor, shape (batch_size,), 선택 사항) — 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 사용할 수 있는 각 문장의 길이입니다. 동일한 결과를 얻기 위해 attention_mask를 사용할 수도 있으며(위 참조), 호환성을 위해 여기에 유지되었습니다. [0, ..., input_ids.size(-1)]에서 선택된 인덱스입니다.
cache (dict[str, torch.Tensor], 선택 사항) — 사전 계산된 KV 상태를 포함하는 EncoderDecoderCache의 인스턴스입니다. 순차 디코딩을 가속하는 데 사용할 수 있습니다.
inputs_embeds (torch.Tensor, shape (batch_size, sequence_length, hidden_size), 선택) — input_ids를 전달하는 대신 임베딩 표현을 직접 전달할 수 있습니다. 이는 모델 내부의 임베딩 조회 행렬보다 input_ids 인덱스를 관련 벡터로 변환하는 방식에 대해 더 세밀한 제어가 필요한 경우에 유용합니다.
output_attentions (bool, 선택 사항) — 모든 attention 레이어의 attentions 텐서를 반환할지 여부. 자세한 내용은 반환 텐서 섹션의 attentions 항목을 참조하세요.
output_hidden_states (bool, 선택 사항) — 모든 레이어의 hidden states를 반환할지 여부입니다. 자세한 내용은 반환되는 텐서 중 hidden_states 항목을 참고하세요.
return_dict (bool, 선택) — 일반 튜플 대신 ModelOutput를 반환할지 여부.

반환값

BaseModelOutput 또는 tuple(torch.Tensor)

torch.Tensor의 튜플 또는 BaseModelOutput (return_dict=False가 전달되었거나 config.return_dict=False인 경우)로, 구성(XLMConfig)과 입력에 따라 다양한 요소를 포함합니다.

XLMModel의 forward 메서드는 __call__ 특수 메서드를 오버라이드합니다.

이 함수 내에서 forward pass의 레시피를 정의해야 하지만, 이후에는 이 함수 대신 Module 인스턴스를 호출해야 합니다. 전자는 전처리 및 후처리 단계를 실행하는 것을 처리하는 반면, 후자는 이를 조용히 무시하기 때문입니다.

last_hidden_state (torch.Tensor, shape (batch_size, sequence_length, hidden_size)) — 모델의 마지막 레이어 출력에서 생성된 hidden-state 시퀀스입니다.
hidden_states (tuple(torch.Tensor), 선택 사항, output_hidden_states=True가 전달되거나 config.output_hidden_states=True인 경우 반환됨) — torch.Tensor의 튜플(모델에 임베딩 레이어가 있는 경우 임베딩 출력 1개 + 각 레이어의 출력 1개)로, 모양은 (batch_size, sequence_length, hidden_size)입니다.

각 레이어의 출력에서 모델의 Hidden-states와 선택적 초기 임베딩 출력을 포함합니다.
attentions (tuple(torch.Tensor), 선택 사항, output_attentions=True가 전달되었거나 config.output_attentions=True인 경우 반환됨) — 각 레이어마다 하나씩 포함된 torch.Tensor의 튜플로, 모양은 (batch_size, num_heads, sequence_length, sequence_length)입니다.

self-attention 헤드에서 가중 평균을 계산하는 데 사용되는 attention softmax 이후의 attention 가중치.

XLMWithLMHeadModel

클래스 transformers.XLMWithLMHeadModel

< source >

( config: XLMConfig )

매개변수

config (XLMConfig) — 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하는 것은 모델과 관련된 가중치를 로드하지 않으며, 구성 정보만 로드합니다. 모델 가중치를 로드하려면 from_pretrained() 메서드를 확인하세요.

입력 임베딩과 가중치가 공유되는 선형 레이어로 구성된 언어 모델링 헤드가 위에 있는 XLM 모델 트랜스포머입니다.

forward

< source >

( input_ids: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonelangs: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneposition_ids: typing.Optional[torch.Tensor] = Nonelengths: typing.Optional[torch.Tensor] = Nonecache: dict[str, torch.Tensor] | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = Nonelogits_to_keep: typing.Union[int, torch.Tensor] = 0**kwargs ) → MaskedLMOutput or tuple(torch.Tensor)

매개변수

input_ids (torch.Tensor 의 shape (batch_size, sequence_length), , 선택 사항) — 어휘(input vocabulary)에서 입력 시퀀스 토큰의 인덱스입니다. 기본적으로 패딩은 무시됩니다.
AutoTokenizer를 사용하여 인덱스를 얻을 수 있습니다. 자세한 내용은 PreTrainedTokenizer.encode() 및 PreTrainedTokenizer.call()를 참조하세요.

입력 ID란 무엇인가요?
attention_mask (torch.Tensor 형상이 (batch_size, sequence_length), 선택 사항) — 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 방지하는 마스크. [0, 1]에서 선택된 마스크 값: 마스크되지 않은 토큰은 1, 마스크된 토큰은 0. attention mask란 무엇인가요? [0, 1]:
- 마스크되지 않은 토큰에 대해 1
- 마스크된 토큰에 대해 0
어텐션 마스크란 무엇인가요?
langs (torch.LongTensor 형상이 (batch_size, sequence_length), 선택 사항) — 입력에서 각 토큰의 언어를 나타내는 데 사용되는 병렬 토큰 시퀀스입니다. 인덱스는 모델 설정에서 제공되는 두 가지 변환 매핑을 사용하여 언어 이름에서 얻을 수 있는 언어 ID입니다(다국어 모델에만 제공됨). 보다 구체적으로, 언어 이름에서 언어 ID로 매핑하는 것은 model.config.lang2id ((문자열에서 int로 변환하는 딕셔너리)이고, 언어 ID에서 언어 이름으로 매핑하는 것은 model.config.id2lang ((int에서 문자열로 변환하는 딕셔너리)입니다.
다국어 문서에 자세히 설명된 사용 예시를 참조하세요.
token_type_ids (torch.Tensor 형상 (batch_size, sequence_length), 선택 사항) — 입력의 첫 번째 및 두 번째 부분을 나타내는 세그먼트 토큰 인덱스. 인덱스는 [0, 1]:
- 0은 sentence A 토큰에 해당합니다.
- 1은 sentence B 토큰에 해당합니다.
토큰 타입 ID란 무엇인가요?
position_ids (torch.Tensor 의 shape (batch_size, sequence_length), , 선택 사항) — 입력 시퀀스 토큰의 위치 임베딩에서 각 토큰의 위치 인덱스. 범위는 [0, config.n_positions - 1].
포지션 ID란 무엇인가요?
lengths (torch.LongTensor, shape (batch_size,), 선택 사항) — 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 사용할 수 있는 각 문장의 길이입니다. 동일한 결과를 얻기 위해 attention_mask를 사용할 수도 있으며(위 참조), 호환성을 위해 여기에 유지되었습니다. [0, ..., input_ids.size(-1)]에서 선택된 인덱스입니다.
cache (dict[str, torch.Tensor], 선택 사항) — 사전 계산된 KV 상태를 포함하는 EncoderDecoderCache의 인스턴스입니다. 순차 디코딩을 가속하는 데 사용할 수 있습니다.
inputs_embeds (torch.Tensor, shape (batch_size, sequence_length, hidden_size), 선택) — input_ids를 전달하는 대신 임베딩 표현을 직접 전달할 수 있습니다. 이는 모델 내부의 임베딩 조회 행렬보다 input_ids 인덱스를 관련 벡터로 변환하는 방식에 대해 더 세밀한 제어가 필요한 경우에 유용합니다.
labels (torch.LongTensor, shape (batch_size, sequence_length), 선택 사항) — 언어 모델링을 위한 라벨입니다. 모델 내부에서 라벨이 시프트(shift)됩니다. 즉, labels = input_ids를 설정할 수 있습니다. 인덱스는 [-100, 0, ..., config.vocab_size] 범위에서 선택됩니다. -100으로 설정된 모든 라벨은 무시(마스크)되며, 손실은 [0, ..., config.vocab_size] 범위의 라벨에 대해서만 계산됩니다.
output_attentions (bool, 선택 사항) — 모든 attention 레이어의 attentions 텐서를 반환할지 여부. 자세한 내용은 반환 텐서 섹션의 attentions 항목을 참조하세요.
output_hidden_states (bool, 선택 사항) — 모든 레이어의 hidden states를 반환할지 여부입니다. 자세한 내용은 반환되는 텐서 중 hidden_states 항목을 참고하세요.
return_dict (bool, 선택) — 일반 튜플 대신 ModelOutput를 반환할지 여부.
logits_to_keep (Union[int, torch.Tensor], 선택 사항, 기본값 0) — int인 경우, 마지막 logits_to_keep 토큰에 대한 logits를 계산합니다. 0인 경우, 모든 input_ids에 대한 logits를 계산합니다(특수한 경우). 생성에는 마지막 토큰의 logits만 필요하며, 해당 토큰에 대해서만 계산하면 메모리를 절약할 수 있습니다. 이는 긴 시퀀스나 큰 어휘 크기의 경우 상당한 이점을 제공합니다. torch.Tensor인 경우, 시퀀스 길이 차원에서 유지할 인덱스에 해당하는 1차원 텐서여야 합니다. 이는 패킹된 텐서 형식(배치와 시퀀스 길이를 단일 차원으로 사용하는 경우)을 사용할 때 유용합니다.

반환값

MaskedLMOutput 또는 tuple(torch.Tensor)

torch.Tensor의 튜플 또는 MaskedLMOutput (return_dict=False가 전달되었거나 config.return_dict=False인 경우). 구성(XLMConfig)과 입력에 따라 다양한 요소를 포함합니다.

XLMWithLMHeadModel의 forward 메서드는 __call__ 특수 메서드를 오버라이드합니다.

이 함수 내에서 forward pass의 레시피를 정의해야 하지만, 이후에는 이 함수 대신 Module 인스턴스를 호출해야 합니다. 전자는 전처리 및 후처리 단계를 실행하는 것을 처리하는 반면, 후자는 이를 조용히 무시하기 때문입니다.

loss (torch.Tensor, shape (1,), 선택 사항, labels이 제공될 때 반환됨) — Masked language modeling (MLM) loss.
logits (torch.Tensor, shape (batch_size, sequence_length, config.vocab_size)) — 언어 모델링 헤드에서 생성된 예측 점수(SoftMax 적용 전 각 어휘 토큰에 대한 점수).
hidden_states (tuple(torch.Tensor), 선택 사항, output_hidden_states=True가 전달되거나 config.output_hidden_states=True인 경우 반환됨) — torch.Tensor의 튜플(모델에 임베딩 레이어가 있는 경우 임베딩 출력 1개 + 각 레이어의 출력 1개)로, 모양은 (batch_size, sequence_length, hidden_size)입니다.

각 레이어의 출력에서 모델의 Hidden-states와 선택적 초기 임베딩 출력을 포함합니다.
attentions (tuple(torch.Tensor), 선택 사항, output_attentions=True가 전달되었거나 config.output_attentions=True인 경우 반환됨) — 각 레이어마다 하나씩 포함된 torch.Tensor의 튜플로, 모양은 (batch_size, num_heads, sequence_length, sequence_length)입니다.

self-attention 헤드에서 가중 평균을 계산하는 데 사용되는 attention softmax 이후의 attention 가중치.

예:

>>> import torch
>>> from transformers import AutoTokenizer, XLMWithLMHeadModel

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = XLMWithLMHeadModel.from_pretrained("FacebookAI/xlm-mlm-en-2048")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs, labels=inputs["input_ids"])
>>> loss = outputs.loss
>>> logits = outputs.logits

XLMForSequenceClassification

class transformers.XLMForSequenceClassification

< source >

( config: XLMConfig )

매개변수

config (XLMConfig) — 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하는 것은 모델과 관련된 가중치를 로드하지 않으며, 구성 정보만 로드합니다. 모델 가중치를 로드하려면 from_pretrained() 메서드를 확인하세요.

XLM 모델 위에 시퀀스 분류/회귀 헤드(풀링된 출력 위에 선형 레이어)를 추가한 모델. 예를 들어 GLUE 작업에 사용됩니다.

forward

< source >

( input_ids: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonelangs: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneposition_ids: typing.Optional[torch.Tensor] = Nonelengths: typing.Optional[torch.Tensor] = Nonecache: dict[str, torch.Tensor] | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → SequenceClassifierOutput or tuple(torch.Tensor)

매개변수

input_ids (torch.Tensor 의 shape (batch_size, sequence_length), , 선택 사항) — 어휘(input vocabulary)에서 입력 시퀀스 토큰의 인덱스입니다. 기본적으로 패딩은 무시됩니다.
AutoTokenizer를 사용하여 인덱스를 얻을 수 있습니다. 자세한 내용은 PreTrainedTokenizer.encode() 및 PreTrainedTokenizer.call()를 참조하세요.

입력 ID란 무엇인가요?
attention_mask (torch.Tensor 형상이 (batch_size, sequence_length), 선택 사항) — 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 방지하는 마스크. [0, 1]에서 선택된 마스크 값: 마스크되지 않은 토큰은 1, 마스크된 토큰은 0. attention mask란 무엇인가요? [0, 1]:
- 마스크되지 않은 토큰에 대해 1
- 마스크된 토큰에 대해 0
어텐션 마스크란 무엇인가요?
langs (torch.LongTensor 형상이 (batch_size, sequence_length), 선택 사항) — 입력에서 각 토큰의 언어를 나타내는 데 사용되는 병렬 토큰 시퀀스입니다. 인덱스는 모델 설정에서 제공되는 두 가지 변환 매핑을 사용하여 언어 이름에서 얻을 수 있는 언어 ID입니다(다국어 모델에만 제공됨). 보다 구체적으로, 언어 이름에서 언어 ID로 매핑하는 것은 model.config.lang2id ((문자열에서 int로 변환하는 딕셔너리)이고, 언어 ID에서 언어 이름으로 매핑하는 것은 model.config.id2lang ((int에서 문자열로 변환하는 딕셔너리)입니다.
다국어 문서에 자세히 설명된 사용 예시를 참조하세요.
token_type_ids (torch.Tensor 형상 (batch_size, sequence_length), 선택 사항) — 입력의 첫 번째 및 두 번째 부분을 나타내는 세그먼트 토큰 인덱스. 인덱스는 [0, 1]:
- 0은 sentence A 토큰에 해당합니다.
- 1은 sentence B 토큰에 해당합니다.
토큰 타입 ID란 무엇인가요?
position_ids (torch.Tensor 의 shape (batch_size, sequence_length), , 선택 사항) — 입력 시퀀스 토큰의 위치 임베딩에서 각 토큰의 위치 인덱스. 범위는 [0, config.n_positions - 1].
포지션 ID란 무엇인가요?
lengths (torch.LongTensor, shape (batch_size,), 선택 사항) — 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 사용할 수 있는 각 문장의 길이입니다. 동일한 결과를 얻기 위해 attention_mask를 사용할 수도 있으며(위 참조), 호환성을 위해 여기에 유지되었습니다. [0, ..., input_ids.size(-1)]에서 선택된 인덱스입니다.
cache (dict[str, torch.Tensor], 선택 사항) — 사전 계산된 KV 상태를 포함하는 EncoderDecoderCache의 인스턴스입니다. 순차 디코딩을 가속하는 데 사용할 수 있습니다.
inputs_embeds (torch.Tensor, shape (batch_size, sequence_length, hidden_size), 선택) — input_ids를 전달하는 대신 임베딩 표현을 직접 전달할 수 있습니다. 이는 모델 내부의 임베딩 조회 행렬보다 input_ids 인덱스를 관련 벡터로 변환하는 방식에 대해 더 세밀한 제어가 필요한 경우에 유용합니다.
labels (torch.LongTensor, shape (batch_size,), 선택 사항) — 시퀀스 분류/회귀 손실을 계산하는 데 사용되는 라벨입니다. 인덱스는 [0, ..., config.num_labels - 1] 범위에 있어야 합니다. config.num_labels == 1인 경우 회귀 손실(Mean-Square loss)이 계산되고, config.num_labels > 1인 경우 분류 손실(Cross-Entropy)이 계산됩니다.
output_attentions (bool, 선택 사항) — 모든 attention 레이어의 attentions 텐서를 반환할지 여부. 자세한 내용은 반환 텐서 섹션의 attentions 항목을 참조하세요.
output_hidden_states (bool, 선택 사항) — 모든 레이어의 hidden states를 반환할지 여부입니다. 자세한 내용은 반환되는 텐서 중 hidden_states 항목을 참고하세요.
return_dict (bool, 선택) — 일반 튜플 대신 ModelOutput를 반환할지 여부.

반환값

SequenceClassifierOutput 또는 tuple(torch.Tensor)

torch.Tensor의 튜플 또는 SequenceClassifierOutput입니다. return_dict=False가 전달되거나 config.return_dict=False인 경우에도 동일합니다. 구성(XLMConfig)과 입력에 따라 다양한 요소를 포함합니다.

XLMForSequenceClassification의 forward 메서드는 __call__ 특수 메서드를 오버라이드합니다.

이 함수 내에서 forward pass의 레시피를 정의해야 하지만, 이후에는 이 함수 대신 Module 인스턴스를 호출해야 합니다. 전자는 전처리 및 후처리 단계를 실행하는 것을 처리하는 반면, 후자는 이를 조용히 무시하기 때문입니다.

loss (torch.Tensor, shape (1,), 선택 사항, labels이 제공될 때 반환됨) — 분류 (또는 config.num_labels==1인 경우 회귀) 손실.
logits (torch.Tensor, shape (batch_size, config.num_labels)) — SoftMax 적용 전 분류(또는 config.num_labels==1인 경우 회귀) 점수.
hidden_states (tuple(torch.Tensor), 선택 사항, output_hidden_states=True가 전달되거나 config.output_hidden_states=True인 경우 반환됨) — torch.Tensor의 튜플(모델에 임베딩 레이어가 있는 경우 임베딩 출력 1개 + 각 레이어의 출력 1개)로, 모양은 (batch_size, sequence_length, hidden_size)입니다.

각 레이어의 출력에서 모델의 Hidden-states와 선택적 초기 임베딩 출력을 포함합니다.
attentions (tuple(torch.Tensor), 선택 사항, output_attentions=True가 전달되었거나 config.output_attentions=True인 경우 반환됨) — 각 레이어마다 하나씩 포함된 torch.Tensor의 튜플로, 모양은 (batch_size, num_heads, sequence_length, sequence_length)입니다.

self-attention 헤드에서 가중 평균을 계산하는 데 사용되는 attention softmax 이후의 attention 가중치.

단일 레이블 분류의 예시:

>>> import torch
>>> from transformers import AutoTokenizer, XLMForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = XLMForSequenceClassification.from_pretrained("FacebookAI/xlm-mlm-en-2048")

>>> 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 = XLMForSequenceClassification.from_pretrained("FacebookAI/xlm-mlm-en-2048", num_labels=num_labels)

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

다중 레이블 분류의 예시:

>>> import torch
>>> from transformers import AutoTokenizer, XLMForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = XLMForSequenceClassification.from_pretrained("FacebookAI/xlm-mlm-en-2048", 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 = XLMForSequenceClassification.from_pretrained(
...     "FacebookAI/xlm-mlm-en-2048", 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

XLMForMultipleChoice

class transformers.XLMForMultipleChoice

< source >

( config: XLMConfig*inputs**kwargs )

매개변수

config (XLMConfig) — 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하는 것은 모델과 관련된 가중치를 로드하지 않으며, 구성 정보만 로드합니다. 모델 가중치를 로드하려면 from_pretrained() 메서드를 확인하세요.

pool output 위에 linear layer와 softmax를 적용한 multiple choice classification head가 있는 Xlm Model입니다. 예를 들어 RocStories/SWAG 작업에 사용됩니다.

forward

< source >

( input_ids: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonelangs: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneposition_ids: typing.Optional[torch.Tensor] = Nonelengths: typing.Optional[torch.Tensor] = Nonecache: dict[str, torch.Tensor] | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → MultipleChoiceModelOutput or tuple(torch.Tensor)

매개변수

input_ids (torch.LongTensor 형태 (batch_size, num_choices, sequence_length)) — 어휘 사전에서 입력 시퀀스 토큰의 인덱스. AutoTokenizer를 사용하여 인덱스를 얻을 수 있습니다. 자세한 내용은 PreTrainedTokenizer.encode() 및 PreTrainedTokenizer.call()을 참조하세요. input ID란 무엇인가요?
AutoTokenizer를 사용하여 인덱스를 얻을 수 있습니다. 자세한 내용은 PreTrainedTokenizer.encode() 및 PreTrainedTokenizer.call()를 참조하세요.

입력 ID란 무엇인가요?
attention_mask (torch.Tensor 형상이 (batch_size, sequence_length), 선택 사항) — 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 방지하는 마스크. [0, 1]에서 선택된 마스크 값: 마스크되지 않은 토큰은 1, 마스크된 토큰은 0. attention mask란 무엇인가요? [0, 1]:
- 마스크되지 않은 토큰에 대해 1
- 마스크된 토큰에 대해 0
어텐션 마스크란 무엇인가요?
langs (torch.LongTensor 형상이 (batch_size, num_choices, sequence_length), 선택 사항) — 입력에서 각 토큰의 언어를 나타내는 데 사용되는 병렬 토큰 시퀀스입니다. 인덱스는 모델 구성에서 제공되는 두 가지 변환 매핑을 사용하여 언어 이름에서 얻을 수 있는 언어 ID입니다(다국어 모델에만 제공됨). 보다 구체적으로, 언어 이름에서 언어 ID로 매핑하는 것은 model.config.lang2id ((문자열에서 int로 변환하는 딕셔너리)이고, 언어 ID에서 언어 이름으로 매핑하는 것은 model.config.id2lang ((int에서 문자열로 변환하는 딕셔너리)입니다.
다국어 문서에 자세히 설명된 사용 예시를 참조하세요.
token_type_ids (torch.LongTensor 다음 형태의 (batch_size, num_choices, sequence_length), 선택 사항) — 입력의 첫 번째 및 두 번째 부분을 나타내는 세그먼트 토큰 인덱스. 인덱스는 [0, 1]:
- 0은 sentence A 토큰에 해당합니다.
- 1은 sentence B 토큰에 해당합니다.
토큰 타입 ID란 무엇인가요?
position_ids (torch.LongTensor 다음 형태의 (batch_size, num_choices, sequence_length), 선택 사항) — 입력 시퀀스 토큰의 위치 인덱스입니다. 다음 범위에서 선택됩니다 [0, config.max_position_embeddings - 1].
포지션 ID란 무엇인가요?
lengths (torch.LongTensor, shape (batch_size,), 선택 사항) — 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 사용할 수 있는 각 문장의 길이입니다. 동일한 결과를 얻기 위해 attention_mask를 사용할 수도 있으며(위 참조), 호환성을 위해 여기에 유지되었습니다. [0, ..., input_ids.size(-1)]에서 선택된 인덱스입니다.
cache (dict[str, torch.Tensor], 선택 사항) — 사전 계산된 KV 상태를 포함하는 EncoderDecoderCache의 인스턴스입니다. 순차 디코딩을 가속하는 데 사용할 수 있습니다.
inputs_embeds (torch.Tensor, shape (batch_size, num_choices, sequence_length, hidden_size), 선택 사항) — input_ids를 전달하는 대신 임베딩 표현을 직접 전달할 수 있습니다. 이는 모델 내부의 임베딩 조회 행렬보다 input_ids 인덱스를 관련 벡터로 변환하는 방식에 대한 더 세밀한 제어가 필요한 경우 유용합니다.
labels (torch.LongTensor, shape (batch_size,), 선택 사항) — 다중 선택 분류 손실을 계산하는 데 사용되는 라벨입니다. 인덱스는 [0, ..., num_choices-1] 범위에 있어야 하며, num_choices는 입력 텐서의 두 번째 차원의 크기입니다. (위 input_ids 참조)
output_attentions (bool, 선택 사항) — 모든 attention 레이어의 attentions 텐서를 반환할지 여부. 자세한 내용은 반환 텐서 섹션의 attentions 항목을 참조하세요.
output_hidden_states (bool, 선택 사항) — 모든 레이어의 hidden states를 반환할지 여부입니다. 자세한 내용은 반환되는 텐서 중 hidden_states 항목을 참고하세요.
return_dict (bool, 선택) — 일반 튜플 대신 ModelOutput를 반환할지 여부.

반환값

MultipleChoiceModelOutput 또는 tuple(torch.Tensor)

torch.Tensor의 튜플 또는 MultipleChoiceModelOutput입니다. return_dict=False가 전달되었거나 config.return_dict=False인 경우, 구성(XLMConfig)과 입력에 따라 다양한 요소를 포함합니다.

XLMForMultipleChoice의 forward 메서드는 __call__ 특수 메서드를 오버라이드합니다.

이 함수 내에서 forward pass의 레시피를 정의해야 하지만, 이후에는 이 함수 대신 Module 인스턴스를 호출해야 합니다. 전자는 전처리 및 후처리 단계를 실행하는 것을 처리하는 반면, 후자는 이를 조용히 무시하기 때문입니다.

loss (torch.Tensor, shape (1,), optional, labels가 제공될 때 반환됨) — 분류 손실.
logits (torch.Tensor, shape (batch_size, num_choices)) — num_choices는 입력 텐서의 두 번째 차원입니다. (위 input_ids 참조).

SoftMax 적용 전 분류 점수.
hidden_states (tuple(torch.Tensor), 선택 사항, output_hidden_states=True가 전달되거나 config.output_hidden_states=True인 경우 반환됨) — torch.Tensor의 튜플(모델에 임베딩 레이어가 있는 경우 임베딩 출력 1개 + 각 레이어의 출력 1개)로, 모양은 (batch_size, sequence_length, hidden_size)입니다.

각 레이어의 출력에서 모델의 Hidden-states와 선택적 초기 임베딩 출력을 포함합니다.
attentions (tuple(torch.Tensor), 선택 사항, output_attentions=True가 전달되었거나 config.output_attentions=True인 경우 반환됨) — 각 레이어마다 하나씩 포함된 torch.Tensor의 튜플로, 모양은 (batch_size, num_heads, sequence_length, sequence_length)입니다.

self-attention 헤드에서 가중 평균을 계산하는 데 사용되는 attention softmax 이후의 attention 가중치.

예:

>>> from transformers import AutoTokenizer, XLMForMultipleChoice
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = XLMForMultipleChoice.from_pretrained("FacebookAI/xlm-mlm-en-2048")

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

XLMForTokenClassification

클래스 transformers.XLMForTokenClassification

< source >

( config: XLMConfig )

매개변수

config (XLMConfig) — 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하는 것은 모델과 관련된 가중치를 로드하지 않으며, 구성 정보만 로드합니다. 모델 가중치를 로드하려면 from_pretrained() 메서드를 확인하세요.

토큰 분류 헤드가 위에 있는 Xlm transformer(숨겨진 상태(hidden-states) 출력 위에 선형 레이어가 있는 구조)로, 예를 들어 개체명 인식(NER) 작업에 사용됩니다.

forward

< source >

( input_ids: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonelangs: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneposition_ids: typing.Optional[torch.Tensor] = Nonelengths: typing.Optional[torch.Tensor] = Nonecache: dict[str, torch.Tensor] | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → TokenClassifierOutput or tuple(torch.Tensor)

매개변수

input_ids (torch.Tensor 의 shape (batch_size, sequence_length), , 선택 사항) — 어휘(input vocabulary)에서 입력 시퀀스 토큰의 인덱스입니다. 기본적으로 패딩은 무시됩니다.
AutoTokenizer를 사용하여 인덱스를 얻을 수 있습니다. 자세한 내용은 PreTrainedTokenizer.encode() 및 PreTrainedTokenizer.call()를 참조하세요.

입력 ID란 무엇인가요?
attention_mask (torch.Tensor 형상이 (batch_size, sequence_length), 선택 사항) — 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 방지하는 마스크. [0, 1]에서 선택된 마스크 값: 마스크되지 않은 토큰은 1, 마스크된 토큰은 0. attention mask란 무엇인가요? [0, 1]:
- 마스크되지 않은 토큰에 대해 1
- 마스크된 토큰에 대해 0
어텐션 마스크란 무엇인가요?
langs (torch.LongTensor 형상이 (batch_size, sequence_length), 선택 사항) — 입력에서 각 토큰의 언어를 나타내는 데 사용되는 병렬 토큰 시퀀스입니다. 인덱스는 모델 설정에서 제공되는 두 가지 변환 매핑을 사용하여 언어 이름에서 얻을 수 있는 언어 ID입니다(다국어 모델에만 제공됨). 보다 구체적으로, 언어 이름에서 언어 ID로 매핑하는 것은 model.config.lang2id ((문자열에서 int로 변환하는 딕셔너리)이고, 언어 ID에서 언어 이름으로 매핑하는 것은 model.config.id2lang ((int에서 문자열로 변환하는 딕셔너리)입니다.
다국어 문서에 자세히 설명된 사용 예시를 참조하세요.
token_type_ids (torch.Tensor 형상 (batch_size, sequence_length), 선택 사항) — 입력의 첫 번째 및 두 번째 부분을 나타내는 세그먼트 토큰 인덱스. 인덱스는 [0, 1]:
- 0은 sentence A 토큰에 해당합니다.
- 1은 sentence B 토큰에 해당합니다.
토큰 타입 ID란 무엇인가요?
position_ids (torch.Tensor 의 shape (batch_size, sequence_length), , 선택 사항) — 입력 시퀀스 토큰의 위치 임베딩에서 각 토큰의 위치 인덱스. 범위는 [0, config.n_positions - 1].
포지션 ID란 무엇인가요?
lengths (torch.LongTensor, shape (batch_size,), 선택 사항) — 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 사용할 수 있는 각 문장의 길이입니다. 동일한 결과를 얻기 위해 attention_mask를 사용할 수도 있으며(위 참조), 호환성을 위해 여기에 유지되었습니다. [0, ..., input_ids.size(-1)]에서 선택된 인덱스입니다.
cache (dict[str, torch.Tensor], 선택 사항) — 사전 계산된 KV 상태를 포함하는 EncoderDecoderCache의 인스턴스입니다. 순차 디코딩을 가속하는 데 사용할 수 있습니다.
inputs_embeds (torch.Tensor, shape (batch_size, sequence_length, hidden_size), 선택) — input_ids를 전달하는 대신 임베딩 표현을 직접 전달할 수 있습니다. 이는 모델 내부의 임베딩 조회 행렬보다 input_ids 인덱스를 관련 벡터로 변환하는 방식에 대해 더 세밀한 제어가 필요한 경우에 유용합니다.
labels (torch.LongTensor, shape (batch_size, sequence_length), 선택 사항) — 토큰 분류 손실을 계산하는 데 사용되는 라벨입니다. 인덱스는 [0, ..., config.num_labels - 1] 범위에 있어야 합니다.
output_attentions (bool, 선택 사항) — 모든 attention 레이어의 attentions 텐서를 반환할지 여부. 자세한 내용은 반환 텐서 섹션의 attentions 항목을 참조하세요.
output_hidden_states (bool, 선택 사항) — 모든 레이어의 hidden states를 반환할지 여부입니다. 자세한 내용은 반환되는 텐서 중 hidden_states 항목을 참고하세요.
return_dict (bool, 선택) — 일반 튜플 대신 ModelOutput를 반환할지 여부.

반환값

TokenClassifierOutput 또는 tuple(torch.Tensor)

torch.Tensor의 튜플 또는 TokenClassifierOutput입니다. return_dict=False가 전달되거나 config.return_dict=False인 경우, 구성(XLMConfig)과 입력에 따라 다양한 요소로 구성됩니다.

XLMForTokenClassification의 forward 메서드는 __call__ 특수 메서드를 오버라이드합니다.

이 함수 내에서 forward pass의 레시피를 정의해야 하지만, 이후에는 이 함수 대신 Module 인스턴스를 호출해야 합니다. 전자는 전처리 및 후처리 단계를 실행하는 것을 처리하는 반면, 후자는 이를 조용히 무시하기 때문입니다.

loss (torch.Tensor, shape (1,), 선택 사항, labels이 제공될 때 반환됨) — 분류 손실.
logits (torch.Tensor, shape (batch_size, sequence_length, config.num_labels)) — SoftMax 적용 전 분류 점수.
hidden_states (tuple(torch.Tensor), 선택 사항, output_hidden_states=True가 전달되거나 config.output_hidden_states=True인 경우 반환됨) — torch.Tensor의 튜플(모델에 임베딩 레이어가 있는 경우 임베딩 출력 1개 + 각 레이어의 출력 1개)로, 모양은 (batch_size, sequence_length, hidden_size)입니다.

각 레이어의 출력에서 모델의 Hidden-states와 선택적 초기 임베딩 출력을 포함합니다.
attentions (tuple(torch.Tensor), 선택 사항, output_attentions=True가 전달되었거나 config.output_attentions=True인 경우 반환됨) — 각 레이어마다 하나씩 포함된 torch.Tensor의 튜플로, 모양은 (batch_size, num_heads, sequence_length, sequence_length)입니다.

self-attention 헤드에서 가중 평균을 계산하는 데 사용되는 attention softmax 이후의 attention 가중치.

예:

>>> from transformers import AutoTokenizer, XLMForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = XLMForTokenClassification.from_pretrained("FacebookAI/xlm-mlm-en-2048")

>>> 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)
...

XLMForQuestionAnsweringSimple

class transformers.XLMForQuestionAnsweringSimple

< source >

( config: XLMConfig )

매개변수

config (XLMConfig) — 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하는 것은 모델과 관련된 가중치를 로드하지 않으며, 구성 정보만 로드합니다. 모델 가중치를 로드하려면 from_pretrained() 메서드를 확인하세요.

SQuAD와 같은 추출형 질의응답 작업을 위해 상위부에 스팬 분류 헤드를 갖춘 XLM 모델(숨겨진 상태 출력 위에 선형 레이어를 적용하여 span start logits과 span end logits을 계산).

forward

< source >

( input_ids: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonelangs: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneposition_ids: typing.Optional[torch.Tensor] = Nonelengths: typing.Optional[torch.Tensor] = Nonecache: dict[str, torch.Tensor] | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonestart_positions: typing.Optional[torch.Tensor] = Noneend_positions: typing.Optional[torch.Tensor] = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → QuestionAnsweringModelOutput or tuple(torch.Tensor)

매개변수

input_ids (torch.Tensor 의 shape (batch_size, sequence_length), , 선택 사항) — 어휘(input vocabulary)에서 입력 시퀀스 토큰의 인덱스입니다. 기본적으로 패딩은 무시됩니다.
AutoTokenizer를 사용하여 인덱스를 얻을 수 있습니다. 자세한 내용은 PreTrainedTokenizer.encode() 및 PreTrainedTokenizer.call()를 참조하세요.

입력 ID란 무엇인가요?
attention_mask (torch.Tensor 형상이 (batch_size, sequence_length), 선택 사항) — 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 방지하는 마스크. [0, 1]에서 선택된 마스크 값: 마스크되지 않은 토큰은 1, 마스크된 토큰은 0. attention mask란 무엇인가요? [0, 1]:
- 마스크되지 않은 토큰에 대해 1
- 마스크된 토큰에 대해 0
어텐션 마스크란 무엇인가요?
langs (torch.LongTensor 형상이 (batch_size, sequence_length), 선택 사항) — 입력에서 각 토큰의 언어를 나타내는 데 사용되는 병렬 토큰 시퀀스입니다. 인덱스는 모델 설정에서 제공되는 두 가지 변환 매핑을 사용하여 언어 이름에서 얻을 수 있는 언어 ID입니다(다국어 모델에만 제공됨). 보다 구체적으로, 언어 이름에서 언어 ID로 매핑하는 것은 model.config.lang2id ((문자열에서 int로 변환하는 딕셔너리)이고, 언어 ID에서 언어 이름으로 매핑하는 것은 model.config.id2lang ((int에서 문자열로 변환하는 딕셔너리)입니다.
다국어 문서에 자세히 설명된 사용 예시를 참조하세요.
token_type_ids (torch.Tensor 형상 (batch_size, sequence_length), 선택 사항) — 입력의 첫 번째 및 두 번째 부분을 나타내는 세그먼트 토큰 인덱스. 인덱스는 [0, 1]:
- 0은 sentence A 토큰에 해당합니다.
- 1은 sentence B 토큰에 해당합니다.
토큰 타입 ID란 무엇인가요?
position_ids (torch.Tensor 의 shape (batch_size, sequence_length), , 선택 사항) — 입력 시퀀스 토큰의 위치 임베딩에서 각 토큰의 위치 인덱스. 범위는 [0, config.n_positions - 1].
포지션 ID란 무엇인가요?
lengths (torch.LongTensor, shape (batch_size,), 선택 사항) — 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 사용할 수 있는 각 문장의 길이입니다. 동일한 결과를 얻기 위해 attention_mask를 사용할 수도 있으며(위 참조), 호환성을 위해 여기에 유지되었습니다. [0, ..., input_ids.size(-1)]에서 선택된 인덱스입니다.
cache (dict[str, torch.Tensor], 선택 사항) — 사전 계산된 KV 상태를 포함하는 EncoderDecoderCache의 인스턴스입니다. 순차 디코딩을 가속하는 데 사용할 수 있습니다.
inputs_embeds (torch.Tensor, shape (batch_size, sequence_length, hidden_size), 선택) — input_ids를 전달하는 대신 임베딩 표현을 직접 전달할 수 있습니다. 이는 모델 내부의 임베딩 조회 행렬보다 input_ids 인덱스를 관련 벡터로 변환하는 방식에 대해 더 세밀한 제어가 필요한 경우에 유용합니다.
start_positions (torch.Tensor, shape (batch_size,), 선택 사항) — 토큰 분류 손실을 계산하기 위해 라벨이 지정된 스팬의 시작 위치(인덱스)에 대한 라벨입니다. 위치는 시퀀스 길이(sequence_length)로 클램프됩니다. 시퀀스 범위를 벗어난 위치는 손실 계산에 반영되지 않습니다.
end_positions (torch.Tensor, shape (batch_size,), 선택 사항) — 토큰 분류 손실을 계산하기 위해 라벨이 지정된 스팬의 끝 위치(인덱스)에 대한 라벨입니다. 위치는 시퀀스 길이(sequence_length)로 클램프됩니다. 시퀀스 범위를 벗어난 위치는 손실 계산에 반영되지 않습니다.
output_attentions (bool, 선택 사항) — 모든 attention 레이어의 attentions 텐서를 반환할지 여부. 자세한 내용은 반환 텐서 섹션의 attentions 항목을 참조하세요.
output_hidden_states (bool, 선택 사항) — 모든 레이어의 hidden states를 반환할지 여부입니다. 자세한 내용은 반환되는 텐서 중 hidden_states 항목을 참고하세요.
return_dict (bool, 선택) — 일반 튜플 대신 ModelOutput를 반환할지 여부.

반환값

QuestionAnsweringModelOutput 또는 tuple(torch.Tensor)

torch.Tensor의 튜플 또는 QuestionAnsweringModelOutput입니다. return_dict=False가 전달되거나 config.return_dict=False인 경우, 구성(XLMConfig)과 입력에 따라 다양한 요소로 구성됩니다.

XLMForQuestionAnsweringSimple의 forward 메서드는 __call__ 특수 메서드를 오버라이드합니다.

이 함수 내에서 forward pass의 레시피를 정의해야 하지만, 이후에는 이 함수 대신 Module 인스턴스를 호출해야 합니다. 전자는 전처리 및 후처리 단계를 실행하는 것을 처리하는 반면, 후자는 이를 조용히 무시하기 때문입니다.

loss (torch.Tensor, shape (1,), 선택 사항, labels이 제공될 때 반환됨) — 전체 span 추출 손실은 시작 및 끝 위치의 Cross-Entropy 합입니다.
start_logits (torch.Tensor, shape (batch_size, sequence_length)) — SoftMax 적용 전 스팬 시작 점수.
end_logits (torch.Tensor, shape (batch_size, sequence_length)) — SoftMax 적용 전 스팬 끝 점수.
hidden_states (tuple(torch.Tensor), 선택 사항, output_hidden_states=True가 전달되거나 config.output_hidden_states=True인 경우 반환됨) — torch.Tensor의 튜플(모델에 임베딩 레이어가 있는 경우 임베딩 출력 1개 + 각 레이어의 출력 1개)로, 모양은 (batch_size, sequence_length, hidden_size)입니다.

각 레이어의 출력에서 모델의 Hidden-states와 선택적 초기 임베딩 출력을 포함합니다.
attentions (tuple(torch.Tensor), 선택 사항, output_attentions=True가 전달되었거나 config.output_attentions=True인 경우 반환됨) — 각 레이어마다 하나씩 포함된 torch.Tensor의 튜플로, 모양은 (batch_size, num_heads, sequence_length, sequence_length)입니다.

self-attention 헤드에서 가중 평균을 계산하는 데 사용되는 attention softmax 이후의 attention 가중치.

예:

>>> from transformers import AutoTokenizer, XLMForQuestionAnsweringSimple
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = XLMForQuestionAnsweringSimple.from_pretrained("FacebookAI/xlm-mlm-en-2048")

>>> 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)
...

XLMForQuestionAnswering

class transformers.XLMForQuestionAnswering

< source >

( config: XLMConfig )

매개변수

config (XLMConfig) — 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하는 것은 모델과 관련된 가중치를 로드하지 않으며, 구성 정보만 로드합니다. 모델 가중치를 로드하려면 from_pretrained() 메서드를 확인하세요.

SQuAD와 같은 추출형 질의응답 작업을 위해 span classification head를 최상단에 배치한 Xlm transformer (hidden-states 출력 위에 linear layer를 올려 span start logits과 span end logits을 계산).

forward

< source >

( input_ids: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonelangs: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneposition_ids: typing.Optional[torch.Tensor] = Nonelengths: typing.Optional[torch.Tensor] = Nonecache: dict[str, torch.Tensor] | None = 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] = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → XLMForQuestionAnsweringOutput or tuple(torch.Tensor)

매개변수

input_ids (torch.Tensor 의 shape (batch_size, sequence_length), , 선택 사항) — 어휘(input vocabulary)에서 입력 시퀀스 토큰의 인덱스입니다. 기본적으로 패딩은 무시됩니다.
AutoTokenizer를 사용하여 인덱스를 얻을 수 있습니다. 자세한 내용은 PreTrainedTokenizer.encode() 및 PreTrainedTokenizer.call()를 참조하세요.

입력 ID란 무엇인가요?
attention_mask (torch.Tensor 형상이 (batch_size, sequence_length), 선택 사항) — 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 방지하는 마스크. [0, 1]에서 선택된 마스크 값: 마스크되지 않은 토큰은 1, 마스크된 토큰은 0. attention mask란 무엇인가요? [0, 1]:
- 마스크되지 않은 토큰에 대해 1
- 마스크된 토큰에 대해 0
어텐션 마스크란 무엇인가요?
langs (torch.LongTensor 형상이 (batch_size, sequence_length), 선택 사항) — 입력에서 각 토큰의 언어를 나타내는 데 사용되는 병렬 토큰 시퀀스입니다. 인덱스는 모델 설정에서 제공되는 두 가지 변환 매핑을 사용하여 언어 이름에서 얻을 수 있는 언어 ID입니다(다국어 모델에만 제공됨). 보다 구체적으로, 언어 이름에서 언어 ID로 매핑하는 것은 model.config.lang2id ((문자열에서 int로 변환하는 딕셔너리)이고, 언어 ID에서 언어 이름으로 매핑하는 것은 model.config.id2lang ((int에서 문자열로 변환하는 딕셔너리)입니다.
다국어 문서에 자세히 설명된 사용 예시를 참조하세요.
token_type_ids (torch.Tensor 형상 (batch_size, sequence_length), 선택 사항) — 입력의 첫 번째 및 두 번째 부분을 나타내는 세그먼트 토큰 인덱스. 인덱스는 [0, 1]:
- 0은 sentence A 토큰에 해당합니다.
- 1은 sentence B 토큰에 해당합니다.
토큰 타입 ID란 무엇인가요?
position_ids (torch.Tensor 의 shape (batch_size, sequence_length), , 선택 사항) — 입력 시퀀스 토큰의 위치 임베딩에서 각 토큰의 위치 인덱스. 범위는 [0, config.n_positions - 1].
포지션 ID란 무엇인가요?
lengths (torch.LongTensor, shape (batch_size,), 선택 사항) — 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 사용할 수 있는 각 문장의 길이입니다. 동일한 결과를 얻기 위해 attention_mask를 사용할 수도 있으며(위 참조), 호환성을 위해 여기에 유지되었습니다. [0, ..., input_ids.size(-1)]에서 선택된 인덱스입니다.
cache (dict[str, torch.Tensor], 선택 사항) — 사전 계산된 KV 상태를 포함하는 EncoderDecoderCache의 인스턴스입니다. 순차 디코딩을 가속하는 데 사용할 수 있습니다.
inputs_embeds (torch.Tensor, shape (batch_size, sequence_length, hidden_size), 선택) — input_ids를 전달하는 대신 임베딩 표현을 직접 전달할 수 있습니다. 이는 모델 내부의 임베딩 조회 행렬보다 input_ids 인덱스를 관련 벡터로 변환하는 방식에 대해 더 세밀한 제어가 필요한 경우에 유용합니다.
start_positions (torch.Tensor, shape (batch_size,), 선택 사항) — 토큰 분류 손실을 계산하기 위해 라벨이 지정된 스팬의 시작 위치(인덱스)에 대한 라벨입니다. 위치는 시퀀스 길이(sequence_length)로 클램프됩니다. 시퀀스 범위를 벗어난 위치는 손실 계산에 반영되지 않습니다.
end_positions (torch.Tensor, shape (batch_size,), 선택 사항) — 토큰 분류 손실을 계산하기 위해 라벨이 지정된 스팬의 끝 위치(인덱스)에 대한 라벨입니다. 위치는 시퀀스 길이(sequence_length)로 클램프됩니다. 시퀀스 범위를 벗어난 위치는 손실 계산에 반영되지 않습니다.
is_impossible (torch.LongTensor, shape (batch_size,), 선택 사항) — 질문에 답이 있는지 없는지를 나타내는 라벨 (SQuAD 2.0)
cls_index (torch.LongTensor, shape (batch_size,), 선택 사항) — 답변의 타당성을 계산하는 데 입력으로 사용할 분류 토큰의 위치(인덱스) 라벨.
p_mask (torch.Tensor, shape (batch_size, sequence_length), 선택 사항) — 답변에 포함될 수 없는 토큰의 선택적 마스크(예: [CLS], [PAD], …). 1.0은 해당 토큰이 마스크되어야 함을 의미하고, 0.0은 마스크되지 않음을 의미합니다.
output_attentions (bool, 선택 사항) — 모든 attention 레이어의 attentions 텐서를 반환할지 여부. 자세한 내용은 반환 텐서 섹션의 attentions 항목을 참조하세요.
output_hidden_states (bool, 선택 사항) — 모든 레이어의 hidden states를 반환할지 여부입니다. 자세한 내용은 반환되는 텐서 중 hidden_states 항목을 참고하세요.
return_dict (bool, 선택) — 일반 튜플 대신 ModelOutput를 반환할지 여부.

반환값

XLMForQuestionAnsweringOutput 또는 tuple(torch.Tensor)

torch.Tensor의 튜플 또는 XLMForQuestionAnsweringOutput입니다. return_dict=False가 전달되었거나 config.return_dict=False인 경우, 구성(XLMConfig)과 입력에 따라 다양한 요소를 포함합니다.

XLMForQuestionAnswering의 forward 메서드는 __call__ 특수 메서드를 오버라이드합니다.

이 함수 내에서 forward pass의 레시피를 정의해야 하지만, 이후에는 이 함수 대신 Module 인스턴스를 호출해야 합니다. 전자는 전처리 및 후처리 단계를 실행하는 것을 처리하는 반면, 후자는 이를 조용히 무시하기 때문입니다.

loss (torch.Tensor, shape (1,), 선택 사항, start_positions와 end_positions가 모두 제공된 경우 반환됨) — 시작 토큰, 종료 토큰(제공된 경우 is_impossible 포함) 분류 손실의 합으로 계산된 분류 손실
start_top_log_probs (torch.Tensor, shape (batch_size, config.start_n_top), 선택 사항, start_positions 또는 end_positions이 제공되지 않은 경우 반환됨) — beam-search에서 config.start_n_top개의 시작 토큰 가능성에 대한 로그 확률.
start_top_index (torch.LongTensor, shape (batch_size, config.start_n_top), 선택 사항, start_positions 또는 end_positions이 제공되지 않은 경우 반환됨) — beam-search에서 상위 config.start_n_top 개 시작 토큰 가능성에 대한 인덱스.
end_top_log_probs (torch.Tensor, shape (batch_size, config.start_n_top * config.end_n_top), 선택 사항, start_positions 또는 end_positions가 제공되지 않은 경우 반환됨) — (beam-search) 상위 config.start_n_top * config.end_n_top 개 end token 가능성에 대한 로그 확률
end_top_index (torch.LongTensor, shape (batch_size, config.start_n_top * config.end_n_top), 선택 사항, start_positions 또는 end_positions가 제공되지 않은 경우 반환됨) — 상위 config.start_n_top * config.end_n_top 개 end token 가능성에 대한 인덱스(beam-search).
cls_logits (torch.Tensor, shape (batch_size,), 선택 사항, start_positions 또는 end_positions이 제공되지 않은 경우 반환됨) — 답변의 is_impossible 라벨에 대한 로그 확률입니다.
hidden_states (tuple[torch.Tensor, ...], 선택 사항, output_hidden_states=True가 전달되거나 config.output_hidden_states=True인 경우 반환됨) — torch.Tensor의 튜플(모델에 임베딩 레이어가 있는 경우 임베딩의 출력에 대한 것 1개 + 각 레이어의 출력에 대한 것 1개)로, 모양은 (batch_size, sequence_length, hidden_size)입니다.

각 레이어의 출력에서 모델의 Hidden-states와 선택적 초기 임베딩 출력을 포함합니다.
attentions (tuple[torch.Tensor, ...], 선택 사항, output_attentions=True가 전달되었거나 config.output_attentions=True인 경우 반환됨) — 각 레이어마다 하나씩 포함된 torch.Tensor의 튜플로, 모양은 (batch_size, num_heads, sequence_length, sequence_length)입니다.

self-attention 헤드에서 가중 평균을 계산하는 데 사용되는 attention softmax 이후의 attention 가중치.

예:

>>> from transformers import AutoTokenizer, XLMForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = XLMForQuestionAnswering.from_pretrained("FacebookAI/xlm-mlm-en-2048")

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

←XGLM XLM-RoBERTa→