Transformers documentation
FalconMamba
이 모델은 2024-10-07에 HF papers에 게시되었으며, 2024-08-12에 Hugging Face Transformers에 기여되었습니다.
FalconMamba
FalconMamba는 Mamba를 기반으로 한 7B 대규모 언어 모델로, 사전 학습 및 지시 튜닝된 변형으로 제공됩니다. 이 모델은 강력한 성능을 유지하면서 계산 효율성에 초점을 맞춘 순수 Mamba 설계를 구현합니다. FalconMamba는 추론 속도가 현저히 빠르고, 긴 시퀀스 생성에 필요한 메모리도 크게 적습니다. 해당 모델은 RefinedWeb, 기술 콘텐츠, 코드, 수학 데이터를 포함한 다양한 5.8T 토큰 데이터셋으로 사전 학습되었습니다.
공식 FalconMamba 체크포인트는 FalconMamba 7B 컬렉션에서 찾을 수 있습니다.
FalconMamba를 다양한 언어 작업에 적용하는 방법에 대한 추가 예제는 오른쪽 사이드바의 FalconMamba 모델 항목을 클릭하여 확인하세요.
아래 예제는 Pipeline, AutoModel, 그리고 명령줄을 사용하여 텍스트를 생성하는 방법을 보여줍니다.
from transformers import pipeline
pipeline = pipeline(
"text-generation",
model="tiiuae/falcon-mamba-7b-instruct",
device=0
)
pipeline(
"Explain the difference between transformers and SSMs",
max_length=100,
do_sample=True,
temperature=0.7
)from transformers import AutoModelForCausalLM, AutoTokenizer
tokenizer = AutoTokenizer.from_pretrained("tiiuae/falcon-mamba-7b-instruct")
model = AutoModelForCausalLM.from_pretrained(
"tiiuae/falcon-mamba-7b-instruct",
device_map="auto"
)
input_ids = tokenizer("Explain the difference between transformers and SSMs", return_tensors="pt").to(model.device)
output = model.generate(**input_ids, max_new_tokens=100, cache_implementation="static")
print(tokenizer.decode(output[0], skip_special_tokens=True))transformers chat tiiuae/falcon-mamba-7b-instruct --dtype auto --device 0
Quantization은 가중치를 더 낮은 정밀도로 표현하여 대규모 모델의 메모리 부담을 줄입니다. 사용 가능한 다른 양자화 백엔드에 대해서는 Quantization 개요를 참조하세요.
아래 예제는 bitsandbytes를 사용하여 가중치를 4-bit로 양자화합니다.
from transformers import AutoTokenizer, BitsAndBytesConfig, FalconMambaForCausalLM
quantization_config = BitsAndBytesConfig(
load_in_4bit=True,
bnb_4bit_quant_type="nf4",
bnb_4bit_use_double_quant=True,
)
tokenizer = AutoTokenizer.from_pretrained("tiiuae/falcon-mamba-7b")
model = FalconMambaForCausalLM.from_pretrained(
"tiiuae/falcon-mamba-7b",
device_map="auto",
quantization_config=quantization_config,
)
inputs = tokenizer("Explain the concept of state space models in simple terms", return_tensors="pt").to(model.device)
outputs = model.generate(**inputs, max_new_tokens=100)
print(tokenizer.decode(outputs[0], skip_special_tokens=True))The input is a single word "Notes". 참고
- 배치 생성에는 왼쪽 패딩을 사용합니다. 패딩 방향을 참조하세요.
FalconMambaConfig
클래스 transformers.FalconMambaConfig
< 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 = 50280hidden_size: int = 768state_size: int = 16num_hidden_layers: int = 32layer_norm_epsilon: float = 1e-05pad_token_id: int | None = 0bos_token_id: int | None = 0eos_token_id: int | list[int] | None = 0expand: int = 2conv_kernel: int = 4use_bias: bool = Falseuse_conv_bias: bool = Truehidden_act: str = 'silu'initializer_range: float = 0.1residual_in_fp32: bool = Truetime_step_rank: str | int = 'auto'time_step_scale: float = 1.0time_step_min: float = 0.001time_step_max: float = 0.1time_step_init_scheme: str = 'random'time_step_floor: float = 0.0001rescale_prenorm_residual: bool = Falseuse_cache: bool = Trueuse_mambapy: bool = Falseuse_associative_scan: bool = Truetie_word_embeddings: bool = Truemixer_rms_eps: float = 1e-06 )
매개변수
- vocab_size (
int, 선택 사항, 기본값50280) — 모델의 어휘 크기입니다.input_ids로 표현할 수 있는 서로 다른 토큰의 수를 정의합니다. - hidden_size (
int, 선택 사항, 기본값768) — 숨겨진 표현의 차원입니다. - state_size (
int, 선택 사항, 기본값16) — Mamba 레이어에서 SSM 상태(잠재 상태 차원)의 크기입니다. - num_hidden_layers (
int, 선택 사항, 기본값32) — Transformer decoder의 숨겨진 레이어 수. - layer_norm_epsilon (
float, 선택 사항, 기본값1e-05) — 레이어 정규화 레이어에서 사용되는 epsilon 값입니다. - pad_token_id (
int, 선택 사항, 기본값0) — 어휘에서 패딩에 사용되는 토큰 ID입니다. - bos_token_id (
int, 선택 사항, 기본값0) — 어휘에서 스트림 시작에 사용되는 토큰 id입니다. - eos_token_id (
Union[int, list[int]], 선택 사항, 기본값0) — 어휘에서 스트림 종료에 사용되는 토큰 id입니다. - expand (
int, 선택 사항, 기본값 2) — 중간 크기를 결정하는 데 사용되는 확장 계수입니다. - conv_kernel (
int, 선택 사항, 기본값 4) — 컨볼루션 커널의 크기입니다. - use_bias (
bool, 선택 사항, 기본값False) — mixer 블록의 ["in_proj", "out_proj"]에서 bias를 사용할지 여부 - use_conv_bias (
bool, 선택 사항, 기본값True) — mixer 블록의 convolution layer에 bias를 사용할지 여부. - hidden_act (
str, 선택 사항, 기본값silu) — 디코더의 비선형 활성화 함수(함수 또는 문자열)입니다. 예를 들어,"gelu","relu","silu"등이 있습니다. - initializer_range (
float, 선택 사항, 기본값0.1) — 모든 가중치 행렬을 초기화하는 truncated_normal_initializer의 표준 편차입니다. - residual_in_fp32 (
bool, 선택 사항, 기본값True) — residuals를float32로 사용할지 여부입니다.False로 설정하면 residuals는 모델의 나머지 부분과 동일한dtype을 유지합니다. - time_step_rank (
Union[str, int], 선택 사항, 기본값auto) — Delta(시간 단계) 투영의 랭크입니다."auto"를 지정하면 자동으로 설정됩니다. - time_step_scale (
float, 선택 사항, 기본값1.0) — 이산화 전에 time step delta에 적용되는 스케일입니다. - time_step_min (
float, 선택 사항, 기본값0.001) —dt_proj.bias의 하한으로 사용되는 최소time_step입니다. - time_step_max (
float, 선택 사항, 기본값0.1) —dt_proj.bias의 상한을 설정하는 데 사용되는 최대time_step입니다. - time_step_init_scheme (
str, 선택 사항, 기본값random) — 시간 단계 델타의 초기화 방식입니다."random"또는"uniform"를 사용할 수 있습니다. - time_step_floor (
float, 선택 사항, 기본값0.0001) — softplus 활성화 이후의 이산 시간 단계 델타에 허용되는 최소 값입니다. - rescale_prenorm_residual (
bool, 선택 사항, 기본값False) — 초기화 시out_proj가중치를 다시 스케일링할지 여부입니다. - use_cache (
bool, 선택 사항, 기본값True) — 모델이 마지막 key/values attention을 반환할지 여부입니다(모든 모델에서 사용되지 않음).config.is_decoder=True인 경우 또는 모델이 decoder-only 생성 모델인 경우에만 관련이 있습니다. - use_mambapy (
bool, 선택 사항, 기본값False) — CUDA 기반의 Mamba 공식 구현이 사용 불가능한 경우 학습 시 적용될 폴백 전략을 결정합니다.True인 경우 mamba.py 구현을 사용합니다.False인 경우 단순하지만 느린 구현을 사용합니다. 메모리가 제한적인 경우 단순 버전으로 전환하는 것을 고려해 보세요. - use_associative_scan (
bool, 선택 사항, 기본값True) — 순차적 구현 대신 병렬 스캔에 PyTorch의torch._higher_order_ops.associative_scan를 사용할지 여부입니다. associative scan은torch.compile트레이싱 중에만 활성화되며 torch >= 2.9.0이 필요합니다. 두 경로 모두 수치적으로 동일한 결과를 생성하도록 테스트되었습니다(참조:test_associative_scan_matches_sequential). 순차 루프로 폴백하려면False로 설정하세요. - tie_word_embeddings (
bool, 선택, 기본값True) — 모델의tied_weights_keys매핑에 따라 가중치 임베딩을 묶을지 여부. - mixer_rms_eps (
float, 선택 사항, 기본값 1e-06) — B, C, dt 상태에 사용되는 Mixer RMS norm의 epsilon 값입니다.
이것은 FalconMambaModel의 설정을 저장하기 위한 설정 클래스입니다. 지정된 인자에 따라 Falcon Mamba 모델을 인스턴스화하고 모델 아키텍처를 정의하는 데 사용됩니다. 기본값으로 설정을 인스턴스화하면 tiiuae/falcon-mamba-7b와 유사한 설정이 생성됩니다.
Configuration 객체는 PreTrainedConfig를 상속하며 모델 출력을 제어하는 데 사용할 수 있습니다. 자세한 내용은 PreTrainedConfig의 문서를 참고하세요.
예:
>>> from transformers import FalconMambaConfig, FalconMambaModel
>>> # Initializing a FalconMamba configuration
>>> configuration = FalconMambaConfig()
>>> # Initializing a model (with random weights) from the configuration
>>> model = FalconMambaModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configFalconMambaModel
class transformers.FalconMambaModel
< source >( config: FalconMambaConfig )
매개변수
- config (FalconMambaConfig) — 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하는 것은 모델과 연관된 가중치를 로드하지 않으며, 구성 정보만 로드합니다. 모델 가중치를 로드하려면 from_pretrained() 메서드를 확인하세요.
특정 헤드가 위에 없는 상태에서 원시 hidden-states를 출력하는 기본 Falcon Mamba Model입니다.
이 모델은 PreTrainedModel에서 상속됩니다. 라이브러리가 모든 모델에 대해 구현하는 일반적 메서드(다운로드 또는 저장, 입력 임베딩 크기 조정, 헤드 프루닝 등)에 대한 세부 사항은 상위 클래스 문서를 확인하세요.
이 모델은 또한 PyTorch torch.nn.Module의 하위 클래스입니다. 일반적인 PyTorch Module처럼 사용하며, 일반적인 사용법 및 동작과 관련된 모든 사항은 PyTorch 문서를 참조하세요.
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = Noneinputs_embeds: typing.Optional[torch.LongTensor] = Nonecache_params: transformers.cache_utils.Cache | None = Noneuse_cache: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = Noneattention_mask: typing.Optional[torch.LongTensor] = None**kwargs ) → FalconMambaOutput or tuple(torch.Tensor)
매개변수
- input_ids (
torch.LongTensor형상이(batch_size, sequence_length), 선택 사항) — 어휘(input vocabulary)에서 입력 시퀀스 토큰의 인덱스입니다. 기본적으로 패딩은 무시됩니다.AutoTokenizer를 사용하여 인덱스를 얻을 수 있습니다. 자세한 내용은 PreTrainedTokenizer.encode() 및 PreTrainedTokenizer.call()를 참조하세요.
- inputs_embeds (
torch.LongTensor, shape(batch_size, sequence_length, hidden_size), 선택) —input_ids를 전달하는 대신 임베딩 표현을 직접 전달할 수 있습니다. 이는 모델 내부의 임베딩 조회 행렬보다input_ids인덱스를 관련 벡터로 변환하는 방식을 더 세밀하게 제어하려는 경우에 유용합니다. - cache_params (
Cache, 선택 사항) — 이 인자가 전달되면, 모델은 모든 블록에서 이전 상태를 사용합니다(이는 모델이state_input_ids + input_ids를 컨텍스트로 추가한 것처럼input_ids에 대한 출력을 제공합니다). - use_cache (
bool, 선택 사항) —True로 설정하면cache_params가 반환되며, 이를 사용하여 다음 logits를 빠르게 생성할 수 있습니다. - output_hidden_states (
bool, 선택 사항) — 모든 레이어의 hidden states를 반환할지 여부입니다. 자세한 내용은 반환되는 텐서 중hidden_states항목을 참고하세요. - return_dict (
bool, 선택) — 일반 튜플 대신 ModelOutput를 반환할지 여부. - attention_mask (
torch.LongTensor형상이(batch_size, sequence_length), 선택 사항) — 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 하는 마스크. [0, 1]에서 선택된 마스크 값: 마스크되지 않은 토큰은 1, 마스크된 토큰은 0. attention mask란 무엇인가요?[0, 1]:- 마스크되지 않은 토큰에 대해 1
- 마스크된 토큰에 대해 0
반환값
FalconMambaOutput 또는 tuple(torch.Tensor)
FalconMambaOutput 또는 torch.Tensor의 튜플(return_dict=False가 전달되었거나 config.return_dict=False인 경우)로, 구성(FalconMambaConfig)과 입력에 따라 다양한 요소를 포함합니다.
FalconMambaModel의 forward 메서드는 __call__ 특수 메서드를 오버라이드합니다.
이 함수 내에서 forward pass의 레시피를 정의해야 하지만, 이후에는 이 함수 대신
Module인스턴스를 호출해야 합니다. 전자는 전처리 및 후처리 단계를 실행하는 것을 처리하는 반면, 후자는 이를 조용히 무시하기 때문입니다.
last_hidden_state (
torch.Tensor, shape(batch_size, sequence_length, hidden_size), 선택 사항) — 모델의 마지막 레이어 출력에서 생성된 hidden-state 시퀀스입니다.cache_params (
~cache_utils.Cache, 선택) — 마지막 시간 단계에서의 모델 상태입니다. 이전input_ids를 다시 제공하지 않고, 다음input_ids와 함께 forward 메서드에서 사용할 수 있습니다.selective scan 이후의 State space model 상태 행렬과 Convolutional states를 모두 포함합니다
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와 선택적 초기 임베딩 출력을 포함합니다.
FalconMambaLMHeadModel
클래스 transformers.FalconMambaForCausalLM
< source >( config: FalconMambaConfig )
매개변수
- config (FalconMambaConfig) — 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하는 것은 모델과 연관된 가중치를 로드하지 않으며, 구성 정보만 로드합니다. 모델 가중치를 로드하려면 from_pretrained() 메서드를 확인하세요.
입력 임베딩과 가중치가 공유되는 선형 레이어로 구성된 언어 모델링 헤드가 위에 있는 FALCON_MAMBA 모델 트랜스포머입니다.
이 모델은 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] = Nonecache_params: transformers.cache_utils.Cache | None = Nonelabels: typing.Optional[torch.LongTensor] = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = Noneuse_cache: bool | None = Nonelogits_to_keep: typing.Union[int, torch.Tensor] = 0**kwargs ) → FalconMambaCausalLMOutput or tuple(torch.Tensor)
매개변수
- input_ids (
torch.LongTensor형상이(batch_size, sequence_length), 선택 사항) — 어휘(input vocabulary)에서 입력 시퀀스 토큰의 인덱스입니다. 기본적으로 패딩은 무시됩니다.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인덱스를 관련 벡터로 변환하는 방식에 대해 더 세밀한 제어가 필요한 경우에 유용합니다. - cache_params (
Cache, 선택 사항) — 이 인자가 전달되면, 모델은 모든 블록에서 이전 상태를 사용합니다(이는 모델이state_input_ids + 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_hidden_states (
bool, 선택 사항) — 모든 레이어의 hidden states를 반환할지 여부입니다. 자세한 내용은 반환되는 텐서 중hidden_states항목을 참고하세요. - return_dict (
bool, 선택) — 일반 튜플 대신 ModelOutput를 반환할지 여부. - use_cache (
bool, 선택 사항) —True로 설정하면cache_params가 반환되며, 이를 사용하여 다음 logits를 빠르게 생성할 수 있습니다. - logits_to_keep (
Union[int, torch.Tensor], 선택 사항, 기본값0) —int인 경우, 마지막logits_to_keep토큰에 대한 logits를 계산합니다.0인 경우, 모든input_ids에 대한 logits를 계산합니다(특수한 경우). 생성에는 마지막 토큰의 logits만 필요하며, 해당 토큰에 대해서만 계산하면 메모리를 절약할 수 있습니다. 이는 긴 시퀀스나 큰 어휘 크기의 경우 상당한 이점을 제공합니다.torch.Tensor인 경우, 시퀀스 길이 차원에서 유지할 인덱스에 해당하는 1차원 텐서여야 합니다. 이는 패킹된 텐서 형식(배치와 시퀀스 길이를 단일 차원으로 사용하는 경우)을 사용할 때 유용합니다.
반환값
FalconMambaCausalLMOutput 또는 tuple(torch.Tensor)
FalconMambaCausalLMOutput 또는 torch.Tensor의 튜플(return_dict=False가 전달되었거나 config.return_dict=False인 경우)로, 구성(FalconMambaConfig)과 입력에 따라 다양한 요소를 포함합니다.
FalconMambaForCausalLM의 forward 메서드는 __call__ 특수 메서드를 오버라이드합니다.
이 함수 내에서 forward pass의 레시피를 정의해야 하지만, 이후에는 이 함수 대신
Module인스턴스를 호출해야 합니다. 전자는 전처리 및 후처리 단계를 실행하는 것을 처리하는 반면, 후자는 이를 조용히 무시하기 때문입니다.
loss (
torch.Tensor, shape(1,), 선택 사항,labels이 제공될 때 반환됨) — 언어 모델링 손실(다음 토큰 예측용).logits (
torch.Tensor, shape(batch_size, sequence_length, config.vocab_size)) — 언어 모델링 헤드에서 생성된 예측 점수(SoftMax 적용 전 각 어휘 토큰에 대한 점수).cache_params (
~cache_utils.Cache, 선택) — 마지막 시간 단계에서의 모델 상태입니다. 이전input_ids를 다시 제공하지 않고, 다음input_ids와 함께 forward 메서드에서 사용할 수 있습니다.selective scan 이후의 State space model 상태 행렬과 Convolutional states를 모두 포함합니다
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와 선택적 초기 임베딩 출력을 포함합니다.