Falcon E 3B Instruct

🚀 Transformers庫 - Falcon-E模型

本項目提供了基於transformers庫的Falcon-E模型，這是一系列強大、通用且可微調的1.58bit語言模型，具有低內存佔用和良好的性能表現，可用於文本生成等自然語言處理任務。

🚀 快速開始

目前，要使用此模型，你可以依賴Hugging Face的transformers庫或BitNet庫。根據你的目標用途，有多種方式可以與模型進行交互。對於每個Falcon-E系列模型，你有三種變體：BitNet模型、用於微調的預量化檢查點以及BitNet模型的bfloat16版本。

✨ 主要特性

• 低內存佔用：在不同規模的模型中，Falcon-E系列模型相較於其他模型具有更低的內存佔用，如Falcon-E-1B-Base僅需635MB，Falcon-E-3B-Base僅需955MB。
• 性能良好：在多個評估指標上表現出色，如在IFEVAL、Math-Hard等任務中取得了較好的成績。
• 可微調：支持使用onebitllms Python包進行微調。

📦 安裝指南

若使用transformers庫，可通過以下命令安裝：

pip install transformers

若使用BitNet庫，可通過以下命令安裝：

git clone https://github.com/microsoft/BitNet && cd BitNet
pip install -r requirements.txt

💻 使用示例

基礎用法

使用transformers庫進行推理（BitNet檢查點）

import torch
from transformers import AutoModelForCausalLM, AutoTokenizer

model_id = "tiiuae/Falcon-E-3B-Instruct"

model = AutoModelForCausalLM.from_pretrained(
  model_id,
  torch_dtype=torch.bfloat16,
).to("cuda")

# Perform text generation

使用transformers庫進行推理（經典bfloat16版本）

import torch
from transformers import AutoModelForCausalLM, AutoTokenizer

model_id = "tiiuae/Falcon-E-3B-Instruct"
revision = "bfloat16"

model = AutoModelForCausalLM.from_pretrained(
  model_id,
  torch_dtype=torch.bfloat16,
  revision=revision,
).to("cuda")

# Perform text generation

使用BitNet庫進行推理

python setup_env.py --hf-repo tiiuae/Falcon-E-3B-Instruct -q i2_s
python run_inference.py -m models/Falcon-E-3B-Instruct/ggml-model-i2_s.gguf -p "You are a helpful assistant" -cnv

高級用法

模型微調

import torch

from transformers import AutoModelForCausalLM, AutoTokenizer
from trl import SFTTrainer
from onebitllms import replace_linear_with_bitnet_linear, quantize_to_1bit

model_id = "tiiuae/Falcon-E-3B-Instruct"

tokenizer = AutoTokenizer.from_pretrained(model_id, revision="prequantized")
model = AutoModelForCausalLM.from_pretrained(
    model_id,
    torch_dtype=torch.bfloat16,
    revision="prequantized"
)
model = replace_linear_with_bitnet_linear(model)

trainer = SFTTrainer(
    model,
    ...
)

trainer.train()

quantize_to_1bit(output_directory)

📚 詳細文檔

模型詳情

訓練詳情

有關此模型訓練協議的更多詳細信息，請參考Falcon-E技術博客文章。

評估結果

我們在以下表格中報告了內部管道基準測試結果：

注意：評估結果是來自前Hugging Face排行榜v2任務的歸一化分數

1B規模及以下模型

3B規模模型

指令微調模型 - 1B規模及以下

指令微調模型 - 3B規模

有用鏈接

• 查看我們的發佈博客文章。
• 瞭解更多關於onebitllms庫的信息。
• 如果你有任何問題或想與我們的研究人員和開發人員交流，請加入我們的Discord服務器。

📄 許可證

本模型使用Falcon-LLM許可證，詳情請見許可證鏈接。

📚 引用

如果Falcon-E系列模型對你的工作有幫助，請引用：

@misc{tiionebitllms,
    title = {Falcon-E, a series of powerful, universal and fine-tunable 1.58bit language models.},
    author = {Falcon-LLM Team},
    month = {April},
    url = {https://falcon-lm.github.io/blog/falcon-edge},
    year = {2025}
}