Openelm 3B Instruct

🚀 OpenELM

Sachin Mehta, Mohammad Hossein Sekhavat, Qingqing Cao, Maxwell Horton, Yanzi Jin, Chenfan Sun, Iman Mirzadeh, Mahyar Najibi, Dmitry Belenko, Peter Zatloukal, Mohammad Rastegari

OpenELM 是一系列开放、高效的语言模型。该模型采用逐层缩放策略，在 Transformer 模型的每一层内高效分配参数，从而提高了准确性。我们使用 CoreNet 库对 OpenELM 模型进行了预训练。我们发布了参数分别为 2.7 亿、4.5 亿、11 亿和 30 亿的预训练模型和指令微调模型。同时，我们还发布了完整的框架，包括数据准备、训练、微调、评估等流程，以及多个预训练检查点和训练日志，以促进开放研究。

我们的预训练数据集包含 RefinedWeb、去重后的 PILE、RedPajama 的一个子集和 Dolma v1.6 的一个子集，总计约 18 万亿个标记。使用这些数据集前，请查看其许可协议和使用条款。

🚀 快速开始

我们在 generate_openelm.py 中提供了一个示例函数，用于通过 HuggingFace Hub 加载 OpenELM 模型并生成输出。

你可以运行以下命令来试用该模型：

python generate_openelm.py --model apple/OpenELM-3B-Instruct --hf_access_token [HF_ACCESS_TOKEN] --prompt 'Once upon a time there was' --generate_kwargs repetition_penalty=1.2

请参考 此链接 获取你的 Hugging Face 访问令牌。

可以通过 generate_kwargs 传递其他参数给 Hugging Face 的生成函数。例如，为了加速推理，你可以尝试通过传递 prompt_lookup_num_tokens 参数来使用 查找令牌推测生成：

python generate_openelm.py --model apple/OpenELM-3B-Instruct --hf_access_token [HF_ACCESS_TOKEN] --prompt 'Once upon a time there was' --generate_kwargs repetition_penalty=1.2 prompt_lookup_num_tokens=10

或者，通过 assistant_model 参数传递一个较小的模型，尝试使用 辅助模型 进行模型级别的推测生成，例如：

python generate_openelm.py --model apple/OpenELM-3B-Instruct --hf_access_token [HF_ACCESS_TOKEN] --prompt 'Once upon a time there was' --generate_kwargs repetition_penalty=1.2 --assistant_model [SMALLER_MODEL]

✨ 主要特性

• 高效参数分配：采用逐层缩放策略，在 Transformer 模型的每一层内高效分配参数，提高了模型的准确性。
• 多参数版本发布：发布了参数分别为 2.7 亿、4.5 亿、11 亿和 30 亿的预训练模型和指令微调模型。
• 完整框架开源：发布了完整的框架，包括数据准备、训练、微调、评估等流程，以及多个预训练检查点和训练日志，方便进行开放研究。

💻 使用示例

基础用法

# 以下是在 generate_openelm.py 中使用 OpenELM 模型生成输出的示例代码
python generate_openelm.py --model apple/OpenELM-3B-Instruct --hf_access_token [HF_ACCESS_TOKEN] --prompt 'Once upon a time there was' --generate_kwargs repetition_penalty=1.2

高级用法

# 加速推理，使用查找令牌推测生成
python generate_openelm.py --model apple/OpenELM-3B-Instruct --hf_access_token [HF_ACCESS_TOKEN] --prompt 'Once upon a time there was' --generate_kwargs repetition_penalty=1.2 prompt_lookup_num_tokens=10

# 使用辅助模型进行模型级别的推测生成
python generate_openelm.py --model apple/OpenELM-3B-Instruct --hf_access_token [HF_ACCESS_TOKEN] --prompt 'Once upon a time there was' --generate_kwargs repetition_penalty=1.2 --assistant_model [SMALLER_MODEL]

📚 详细文档

主要结果

零样本学习

LLM360

OpenLLM 排行榜

更多结果和比较请查看技术报告。

评估

环境搭建

安装以下依赖：

# 安装公共的 lm-eval-harness
harness_repo="public-lm-eval-harness"
git clone https://github.com/EleutherAI/lm-evaluation-harness ${harness_repo}
cd ${harness_repo}
# 使用 2024 年 3 月 15 日的主分支，SHA 为 dc90fec
git checkout dc90fec
pip install -e .
cd ..

# 66d6242 是 2024 年 4 月 1 日的主分支
pip install datasets@git+https://github.com/huggingface/datasets.git@66d6242
pip install tokenizers>=0.15.2 transformers>=4.38.2 sentencepiece>=0.2.0

评估 OpenELM

# OpenELM-3B-Instruct
hf_model=apple/OpenELM-3B-Instruct

# 由于 lm-eval-harness 默认将 add_bos_token 设置为 False，但 OpenELM 使用的 LLaMA 分词器需要 add_bos_token 为 True，因此需要此标志
tokenizer=meta-llama/Llama-2-7b-hf
add_bos_token=True
batch_size=1

mkdir lm_eval_output

shot=0
task=arc_challenge,arc_easy,boolq,hellaswag,piqa,race,winogrande,sciq,truthfulqa_mc2
lm_eval --model hf \
        --model_args pretrained=${hf_model},trust_remote_code=True,add_bos_token=${add_bos_token},tokenizer=${tokenizer} \
        --tasks ${task} \
        --device cuda:0 \
        --num_fewshot ${shot} \
        --output_path ./lm_eval_output/${hf_model//\//_}_${task//,/_}-${shot}shot \
        --batch_size ${batch_size} 2>&1 | tee ./lm_eval_output/eval-${hf_model//\//_}_${task//,/_}-${shot}shot.log

shot=5
task=mmlu,winogrande
lm_eval --model hf \
        --model_args pretrained=${hf_model},trust_remote_code=True,add_bos_token=${add_bos_token},tokenizer=${tokenizer} \
        --tasks ${task} \
        --device cuda:0 \
        --num_fewshot ${shot} \
        --output_path ./lm_eval_output/${hf_model//\//_}_${task//,/_}-${shot}shot \
        --batch_size ${batch_size} 2>&1 | tee ./lm_eval_output/eval-${hf_model//\//_}_${task//,/_}-${shot}shot.log

shot=25
task=arc_challenge,crows_pairs_english
lm_eval --model hf \
        --model_args pretrained=${hf_model},trust_remote_code=True,add_bos_token=${add_bos_token},tokenizer=${tokenizer} \
        --tasks ${task} \
        --device cuda:0 \
        --num_fewshot ${shot} \
        --output_path ./lm_eval_output/${hf_model//\//_}_${task//,/_}-${shot}shot \
        --batch_size ${batch_size} 2>&1 | tee ./lm_eval_output/eval-${hf_model//\//_}_${task//,/_}-${shot}shot.log

shot=10
task=hellaswag
lm_eval --model hf \
        --model_args pretrained=${hf_model},trust_remote_code=True,add_bos_token=${add_bos_token},tokenizer=${tokenizer} \
        --tasks ${task} \
        --device cuda:0 \
        --num_fewshot ${shot} \
        --output_path ./lm_eval_output/${hf_model//\//_}_${task//,/_}-${shot}shot \
        --batch_size ${batch_size} 2>&1 | tee ./lm_eval_output/eval-${hf_model//\//_}_${task//,/_}-${shot}shot.log

偏差、风险和局限性

发布 OpenELM 模型旨在为开放研究社区提供最先进的语言模型，以推动和丰富相关研究。这些模型基于公开可用的数据集进行训练，但不提供任何安全保证。因此，这些模型可能会根据用户的提示生成不准确、有害、有偏差或令人反感的输出。所以，用户和开发者必须进行全面的安全测试，并根据自身需求实施适当的过滤机制。

📄 许可证

本项目遵循 apple-amlr 许可证。

📖 引用

如果您觉得我们的工作有用，请引用：

@article{mehtaOpenELMEfficientLanguage2024,
	title = {{OpenELM}: {An} {Efficient} {Language} {Model} {Family} with {Open} {Training} and {Inference} {Framework}},
	shorttitle = {{OpenELM}},
	url = {https://arxiv.org/abs/2404.14619v1},
	language = {en},
	urldate = {2024-04-24},
	journal = {arXiv.org},
	author = {Mehta, Sachin and Sekhavat, Mohammad Hossein and Cao, Qingqing and Horton, Maxwell and Jin, Yanzi and Sun, Chenfan and Mirzadeh, Iman and Najibi, Mahyar and Belenko, Dmitry and Zatloukal, Peter and Rastegari, Mohammad},
	month = apr,
	year = {2024},
}

@inproceedings{mehta2022cvnets, 
     author = {Mehta, Sachin and Abdolhosseini, Farzad and Rastegari, Mohammad}, 
     title = {CVNets: High Performance Library for Computer Vision}, 
     year = {2022}, 
     booktitle = {Proceedings of the 30th ACM International Conference on Multimedia}, 
     series = {MM '22} 
}