Transformers documentation
RWKV
이 모델은 2023-05-09에 Hugging Face Transformers에 기여되었습니다.
RWKV
개요
RWKV 모델(4버전)은 이 저장소에서 제안되었습니다.
전통적인 Transformer attention을 선형으로 조정하는 방식을 제안합니다. 이렇게 하면 모델을 recurrent network로 사용할 수 있습니다. timestamp 0과 timestamp 1의 입력을 함께 전달하는 것은, timestamp 0의 입력을 전달한 후 timestamp 0의 상태와 함께 timestamp 1의 입력을 전달하는 것과 동일합니다(아래 예시 참조).
이 방식은 일반적인 Transformer보다 효율적일 수 있으며, 문장의 길이에 관계없이 처리할 수 있습니다(모델이 학습 시 고정된 컨텍스트 길이를 사용하는 경우에도 마찬가지입니다).
이 모델은 sgugger에 의해 기여되었습니다. 원본 코드는 여기에서 찾을 수 있습니다.
사용 예시
import torch
from transformers import AutoTokenizer, RwkvModel
model = RwkvModel.from_pretrained("sgugger/rwkv-430M-pile", device_map="auto")
tokenizer = AutoTokenizer.from_pretrained("sgugger/rwkv-430M-pile")
inputs = tokenizer("This is an example.", return_tensors="pt").to(model.device)
# Feed everything to the model
outputs = model(inputs["input_ids"])
output_whole = outputs.last_hidden_state
outputs = model(inputs["input_ids"][:, :2])
output_one = outputs.last_hidden_state
# Using the state computed on the first inputs, we will get the same output
outputs = model(inputs["input_ids"][:, 2:], state=outputs.state)
output_two = outputs.last_hidden_state
torch.allclose(torch.cat([output_one, output_two], dim=1), output_whole, atol=1e-5)'\n\n'가 감지되면 모델이 생성을 중단하도록 하려면, 다음 중단 기준을 사용하는 것을 권장합니다:
from transformers import StoppingCriteria
class RwkvStoppingCriteria(StoppingCriteria):
def __init__(self, eos_sequence = [187,187], eos_token_id = 537):
self.eos_sequence = eos_sequence
self.eos_token_id = eos_token_id
def __call__(self, input_ids: torch.LongTensor, scores: torch.Tensor, **kwargs) -> bool:
last_2_ids = input_ids[:,-2:].tolist()
return self.eos_sequence in last_2_ids
output = model.generate(inputs["input_ids"], max_new_tokens=64, stopping_criteria = [RwkvStoppingCriteria()])The input is a single word "Notes". 참고
- 배치 생성에는 왼쪽 패딩을 사용합니다. 패딩 방향을 참조하세요.
RwkvConfig
클래스 transformers.RwkvConfig
< 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 = 50277context_length: int = 1024hidden_size: int = 4096num_hidden_layers: int = 32attention_hidden_size: int | None = Noneintermediate_size: int | None = Nonelayer_norm_epsilon: float = 1e-05bos_token_id: int | None = 0eos_token_id: int | list[int] | None = 0rescale_every: int = 6tie_word_embeddings: bool = Falseuse_cache: bool = True )
매개변수
- vocab_size (
int, 선택 사항, 기본값50277) — 모델의 어휘 크기입니다.input_ids로 표현할 수 있는 서로 다른 토큰의 수를 정의합니다. - context_length (
int, 선택 사항, 기본값 1024) — 이 모델을 단일 forward에서 사용할 수 있는 최대 시퀀스 길이입니다(RNN 모드로 사용하면 임의의 시퀀스 길이를 사용할 수 있습니다). - hidden_size (
int, 선택 사항, 기본값4096) — 숨겨진 표현의 차원입니다. - num_hidden_layers (
int, 선택 사항, 기본값32) — Transformer decoder의 숨겨진 레이어 수. - attention_hidden_size (
int, 선택 사항) — Attention hidden states의 차원입니다. 설정되지 않은 경우 기본값으로hidden_size를 사용합니다. - intermediate_size (
int, 선택 사항) — MLP 표현의 차원. - layer_norm_epsilon (
float, 선택 사항, 기본값1e-05) — 레이어 정규화 레이어에서 사용되는 epsilon 값입니다. - bos_token_id (
int, 선택 사항, 기본값0) — 어휘에서 스트림 시작에 사용되는 토큰 id입니다. - eos_token_id (
Union[int, list[int]], 선택 사항, 기본값0) — 어휘에서 스트림 종료에 사용되는 토큰 id입니다. - rescale_every (
int, 선택 사항, 기본값 6) — 추론 시,rescale_every개 층마다 hidden states(및 해당 출력 레이어의 가중치)를 2로 나눕니다. 0 또는 음수로 설정하면 rescale을 수행하지 않습니다. - tie_word_embeddings (
bool, 선택, 기본값False) — 모델의tied_weights_keys매핑에 따라 가중치 임베딩을 묶을지 여부. - use_cache (
bool, 선택 사항, 기본값True) — 모델이 마지막 key/values attention을 반환할지 여부입니다(모든 모델에서 사용되지 않음).config.is_decoder=True인 경우 또는 모델이 decoder-only 생성 모델인 경우에만 관련이 있습니다.
이것은 RwkvModel의 설정을 저장하기 위한 설정 클래스입니다. 지정된 인자에 따라 Rwkv 모델을 인스턴스화하고 모델 아키텍처를 정의하는 데 사용됩니다. 기본값으로 설정을 인스턴스화하면 RWKV/rwkv-4-169m-pile의 설정과 유사한 설정이 생성됩니다.
Configuration 객체는 PreTrainedConfig를 상속하며 모델 출력을 제어하는 데 사용할 수 있습니다. 자세한 내용은 PreTrainedConfig의 문서를 참고하세요.
예:
>>> from transformers import RwkvConfig, RwkvModel
>>> # Initializing a Rwkv configuration
>>> configuration = RwkvConfig()
>>> # Initializing a model (with random weights) from the configuration
>>> model = RwkvModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configRwkvModel
class transformers.RwkvModel
< source >( config: RwkvConfig )
매개변수
- config (RwkvConfig) — 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하면 모델에 연결된 가중치는 로드되지 않으며 구성만 로드됩니다. 모델 가중치를 로드하려면 from_pretrained() 메서드를 확인하세요.
특정 헤드가 위에 없는 상태의 Rwkv 모델로, 원시 hidden-states를 출력합니다.
이 모델은 PreTrainedModel에서 상속됩니다. 라이브러리가 모든 모델에 대해 구현하는 일반적 메서드(다운로드 또는 저장, 입력 임베딩 크기 조정, 헤드 프루닝 등)에 대한 세부 사항은 상위 클래스 문서를 확인하세요.
이 모델은 또한 PyTorch torch.nn.Module의 하위 클래스입니다. 일반적인 PyTorch Module처럼 사용하며, 일반적인 사용법 및 동작과 관련된 모든 사항은 PyTorch 문서를 참조하세요.
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.LongTensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonestate: list[torch.Tensor] | None = Noneuse_cache: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → RwkvOutput or tuple(torch.Tensor)
매개변수
- input_ids (
torch.LongTensor의 형태인(batch_size, input_ids_length)) —input_ids_length=sequence_length인 경우past_key_values이None인 경우past_key_values.get_seq_length()(sequence_length입력 past key value states의 sequence_length). 어휘 사전에서 입력 시퀀스 토큰의 인덱스입니다.past_key_values를 사용하는 경우, 과거가 계산되지 않은input_ids만input_ids로 전달해야 합니다.AutoTokenizer를 사용하여 인덱스를 얻을 수 있습니다. 자세한 내용은 PreTrainedTokenizer.encode() 및 PreTrainedTokenizer.call()를 참조하세요.
- attention_mask (
torch.LongTensor형상이(batch_size, sequence_length), 선택 사항) — 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 하는 마스크. [0, 1]에서 선택된 마스크 값: 마스크되지 않은 토큰은 1, 마스크된 토큰은 0. attention mask란 무엇인가요?[0, 1]:- 마스크되지 않은 토큰에 대해 1
- 마스크된 토큰에 대해 0
- inputs_embeds (
torch.Tensor, shape(batch_size, sequence_length, hidden_size), 선택) —input_ids를 전달하는 대신 임베딩 표현을 직접 전달할 수 있습니다. 이는 모델 내부의 임베딩 조회 행렬보다input_ids인덱스를 관련 벡터로 변환하는 방식에 대해 더 세밀한 제어가 필요한 경우에 유용합니다. - state (
tupleof fivetorch.Tensorof shape(batch_size, hidden_size, num_hidden_layers), 선택 사항) — 인수로 전달되면, 모델은 모든 블록에서 이전 상태를 사용합니다(이는 모델이state_input_ids + input_ids를 컨텍스트로 추가한 것처럼input_ids에 대한 출력을 생성합니다). - use_cache (
bool, 선택 사항) —True로 설정하면 마지막 상태가 반환되며, 이를 사용하여 다음 logits를 빠르게 생성할 수 있습니다. - output_attentions (
bool, 선택 사항) — 모든 attention 레이어의 attentions 텐서를 반환할지 여부. 자세한 내용은 반환 텐서 섹션의attentions항목을 참조하세요. - output_hidden_states (
bool, 선택 사항) — 모든 레이어의 hidden states를 반환할지 여부입니다. 자세한 내용은 반환되는 텐서 중hidden_states항목을 참고하세요. - return_dict (
bool, 선택) — 일반 튜플 대신 ModelOutput를 반환할지 여부.
반환값
RwkvOutput 또는 tuple(torch.Tensor)
RwkvOutput 또는 torch.Tensor의 튜플(return_dict=False가 전달되었거나 config.return_dict=False인 경우)로, 구성(RwkvConfig)과 입력에 따라 다양한 요소를 포함합니다.
RwkvModel의 forward 메서드는 __call__ 특수 메서드를 오버라이드합니다.
이 함수 내에서 forward pass의 레시피를 정의해야 하지만, 이후에는 이 함수 대신
Module인스턴스를 호출해야 합니다. 전자는 전처리 및 후처리 단계를 실행하는 것을 처리하는 반면, 후자는 이를 조용히 무시하기 때문입니다.
last_hidden_state (
torch.Tensor, shape(batch_size, sequence_length, hidden_size), 선택 사항) — 모델의 마지막 레이어 출력에서 생성된 hidden-state 시퀀스입니다.state (
list, 다섯 개의torch.Tensor, shape(batch_size, hidden_size, num_hidden_layers)) — 마지막 시간 단계에서의 모델 상태. 이전input_ids를 제공하지 않고도 다음input_ids와 함께 forward 메서드에서 사용할 수 있습니다.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 가중치.
RwkvLMHeadModel
클래스 transformers.RwkvForCausalLM
< source >( config: RwkvConfig )
매개변수
- config (RwkvConfig) — 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하면 모델에 연결된 가중치는 로드되지 않으며 구성만 로드됩니다. 모델 가중치를 로드하려면 from_pretrained() 메서드를 확인하세요.
입력 임베딩과 가중치가 공유되는 선형 레이어로 구성된 언어 모델링 헤드가 위에 있는 RWKV Model 트랜스포머입니다.
이 모델은 PreTrainedModel에서 상속됩니다. 라이브러리가 모든 모델에 대해 구현하는 일반적 메서드(다운로드 또는 저장, 입력 임베딩 크기 조정, 헤드 프루닝 등)에 대한 세부 사항은 상위 클래스 문서를 확인하세요.
이 모델은 또한 PyTorch torch.nn.Module의 하위 클래스입니다. 일반적인 PyTorch Module처럼 사용하며, 일반적인 사용법 및 동작과 관련된 모든 사항은 PyTorch 문서를 참조하세요.
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.LongTensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonestate: list[torch.Tensor] | None = Nonelabels: typing.Optional[torch.LongTensor] = Noneuse_cache: 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 ) → RwkvCausalLMOutput or tuple(torch.Tensor)
매개변수
- input_ids (
torch.LongTensor의 형태인(batch_size, input_ids_length)) —input_ids_length=sequence_length인 경우past_key_values이None인 경우past_key_values.get_seq_length()(sequence_length입력 past key value states의 sequence_length). 어휘 사전에서 입력 시퀀스 토큰의 인덱스입니다.past_key_values를 사용하는 경우, 과거가 계산되지 않은input_ids만input_ids로 전달해야 합니다.AutoTokenizer를 사용하여 인덱스를 얻을 수 있습니다. 자세한 내용은 PreTrainedTokenizer.encode() 및 PreTrainedTokenizer.call()를 참조하세요.
- attention_mask (
torch.LongTensor형상이(batch_size, sequence_length), 선택 사항) — 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 하는 마스크. [0, 1]에서 선택된 마스크 값: 마스크되지 않은 토큰은 1, 마스크된 토큰은 0. attention mask란 무엇인가요?[0, 1]:- 마스크되지 않은 토큰에 대해 1
- 마스크된 토큰에 대해 0
- inputs_embeds (
torch.Tensor, shape(batch_size, sequence_length, hidden_size), 선택) —input_ids를 전달하는 대신 임베딩 표현을 직접 전달할 수 있습니다. 이는 모델 내부의 임베딩 조회 행렬보다input_ids인덱스를 관련 벡터로 변환하는 방식에 대해 더 세밀한 제어가 필요한 경우에 유용합니다. - state (
tupleof fivetorch.Tensorof shape(batch_size, hidden_size, num_hidden_layers), 선택) — 전달된 경우, 모델은 모든 블록에서 이전 상태를 사용하여input_ids에 대한 출력을 생성합니다. 이는 모델이state_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]범위의 라벨에 대해서만 계산됩니다. - use_cache (
bool, 선택 사항) —True로 설정하면 마지막 상태가 반환되며, 이를 사용하여 다음 logits를 빠르게 생성할 수 있습니다. - 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차원 텐서여야 합니다. 이는 패킹된 텐서 형식(배치와 시퀀스 길이를 단일 차원으로 사용하는 경우)을 사용할 때 유용합니다.
반환값
RwkvCausalLMOutput 또는 tuple(torch.Tensor)
RwkvCausalLMOutput 또는 torch.Tensor의 튜플(return_dict=False가 전달되었거나 config.return_dict=False인 경우)로, 구성(RwkvConfig)과 입력에 따라 다양한 요소를 포함합니다.
RwkvForCausalLM의 forward 메서드는 __call__ 특수 메서드를 오버라이드합니다.
이 함수 내에서 forward pass의 레시피를 정의해야 하지만, 이후에는 이 함수 대신
Module인스턴스를 호출해야 합니다. 전자는 전처리 및 후처리 단계를 실행하는 것을 처리하는 반면, 후자는 이를 조용히 무시하기 때문입니다.
loss (
torch.Tensor, shape(1,), 선택 사항,labels이 제공될 때 반환됨) — 언어 모델링 손실(다음 토큰 예측용).logits (
torch.Tensor, shape(batch_size, sequence_length, config.vocab_size)) — 언어 모델링 헤드에서 생성된 예측 점수(SoftMax 적용 전 각 어휘 토큰에 대한 점수).state (shape가
(batch_size, hidden_size, num_hidden_layers)인torch.Tensor5개로 구성된list) — 마지막 시간 단계에서의 모델 상태. 이전input_ids를 제공하지 않고 다음input_ids와 함께 forward 메서드에서 사용할 수 있습니다.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 가중치.
Rwkv 어텐션과 재귀 공식
전통적인 오토레그레시브 Transformer에서는 attention을 다음과 같이 표현합니다.
여기서 $Q$는 이고 는 각각 seq_len x hidden_size 크기의 행렬로, query, key, value라고 불립니다(실제로는 batch 차원과 attention head 차원이 포함된 더 큰 행렬이지만, 행렬 곱이 수행되는 마지막 두 차원만 관심 대상이므로 단순화를 위해 이 두 차원만 고려합니다). 곱 의 크기는 seq_len x seq_len 이고, 이를 과 행렬 곱하여 출력 을 얻을 수 있으며, 이 출력은 다른 행렬들과 동일한 크기를 가집니다.
softmax를 해당 값으로 대체하면 다음과 같습니다:
참고로 에서 $j > i$에 해당하는 항목은 마스킹됩니다(합산이 j에서 중단됨). 이는 attention이 미래 토큰을 참조할 수 없고(과거 토큰만 참조 가능) 과거 토큰만 참조할 수 있기 때문입니다.
비교하자면, RWKV의 attention은 다음과 같이 주어집니다.
여기서 은 저자가 receptance라고 부르는 새로운 행렬이고, 그리고 은 여전히 key와 value입니다(여기서 $\sigma$는 sigmoid 함수입니다). 은 토큰의 위치를 나타내는 새로운 벡터이며, 다음으로 주어집니다
코드에서 및 으로 호출되는 학습 가능한 파라미터 time_first 및 time_decay 에 해당합니다. 분자와 분모 모두 재귀적으로 표현할 수 있습니다. 각각 및 으로 명명하면 다음과 같습니다:
즉 (라고 numerator_state 하는
그리고
즉 (라고 denominator_state 코드에서
실제로 사용되는 재귀 공식은 수치적 안정성을 위해 큰 숫자의 지수를 계산하지 않으므로 약간 더 복잡합니다. 일반적으로 softmax는 그대로 계산하지 않고, 최대 항의 지수를 분자와 분모에서 각각 나누어 계산합니다:
with 모든 $x_{j}$의 최대값입니다. 따라서 분자 상태($\hat{N}$)와 분모 상태($\hat{D}$)를 저장하는 것 외에도 지수 함수에서 만난 모든 항의 최대값을 추적합니다. 실제로는
다음 재귀 공식으로 정의됩니다:
그리고
그리고 $M_{j+1} = q$입니다. 이를 통해 다음을 계산할 수 있습니다
그리고
결국 다음을 얻게 됩니다
Update on GitHub