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