Falcon E 3B Base

🚀 Transformers库之Falcon-E模型

本项目的Falcon-E模型是由相关机构开发的强大语言模型，具有特定的架构和语言支持，适用于多种自然语言处理任务，在推理和微调方面都有相应的使用方法，并且在评估中展现出了一定的性能优势。

🚀 快速开始

目前，若要使用此模型，你可以依赖Hugging Face的transformers库或 BitNet 库。根据你的目标用途，有多种方式可以与模型进行交互。对于每个Falcon - E系列模型，你有三种变体：BitNet模型、用于微调的预量化检查点以及BitNet模型的bfloat16版本。

✨ 主要特性

• 开发方：https://www.tii.ae
• 模型类型：因果解码器 / 基础版本
• 架构：纯Transformer - 1.58bit版本
• 语言（NLP）：英语
• 许可证：Falcon - LLM许可证

📦 安装指南

若要使用此模型，你可以通过以下方式安装所需依赖：

• 若使用Hugging Face的transformers库，可通过常规的Python包管理工具进行安装。
• 若使用 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-1B-Base"

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

# Perform text generation

若要使用经典的bfloat16版本，可运行以下代码：

import torch
from transformers import AutoModelForCausalLM, AutoTokenizer

model_id = "tiiuae/Falcon-E-1B-Base"
revision = "bfloat16"

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

# Perform text generation

使用BitNet库进行推理

git clone https://github.com/microsoft/BitNet && cd BitNet
pip install -r requirements.txt
python setup_env.py --hf-repo tiiuae/Falcon-E-1B-Base -q i2_s
python run_inference.py -m models/Falcon-E-1B-Base/ggml-model-i2_s.gguf -p "You are a helpful assistant" -cnv

高级用法

模型微调

若要对模型进行微调，你应该加载模型的prequantized版本，并使用onebitllms Python包，示例代码如下：

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-1B-Base"

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)

📚 详细文档

评估结果

以下表格展示了该模型在内部管道基准测试中的评估结果（评估结果为前Hugging Face排行榜v2任务的标准化分数）：

以下是指令微调模型的结果：

有用链接

• 查看 发布博客文章。
• 了解更多关于 onebitllms 库 的信息。
• 如果你有任何问题或想与研究人员和开发人员交流，欢迎加入 Discord服务器。

🔧 技术细节

关于此模型的训练协议的更多详细信息，请参考 Falcon - E技术博客文章。

📄 许可证

本模型使用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}
}