像搭积木一样构建你的NLP深度神经网络模型

简体中文

Tutorial 中文教程 Demo Video

目录

• 概述
• 60秒快速上手
• 哪些人适合使用NeuronBlocks
• 贡献
• 参考文献
• 相关项目
• 许可证
• 联系我们

概述

NeuronBlocks是一个NLP深度学习建模工具包，旨在帮助工程师和研究人员为NLP任务构建端到端的神经网络模型训练流水线。该工具包的主要目标是最大限度地降低NLP深度神经网络模型开发的成本，涵盖训练和推理两个阶段。

NeuronBlocks由两大核心组件组成：Block Zoo 和 Model Zoo。

• 在Block Zoo中，我们提供了常用的神经网络组件，作为模型架构设计的积木模块。
• 在Model Zoo中，我们提供了一系列针对常见NLP任务的模型，以JSON配置文件的形式呈现。

支持的语言

• 英语
• 中文

支持的NLP任务

• 句子分类
• 情感分析
• 问答匹配
• 文本蕴含
• 实体识别
• 机器阅读理解
• 知识蒸馏用于模型压缩
• 更多任务正在开发中

工具包使用方式

用户可以选择Model Zoo中的现有模型（配置文件）来开始模型训练，也可以利用Block Zoo中的神经网络模块像搭积木一样创建新模型。

60秒快速上手

安装

注意：NeuronBlocks需要Python 3.6及以上版本。

1. 克隆该项目。

   git clone https://github.com/Microsoft/NeuronBlocks
   

2. 使用以下命令安装requirements.txt中的Python包。

   pip install -r requirements.txt
   

3. 安装PyTorch（NeuronBlocks支持PyTorch 0.4.1及以上版本）。

   对于Linux系统，运行以下命令：

   pip install "torch>=0.4.1"
   

   对于Windows系统，建议您通过Conda按照PyTorch官网的指引进行安装。

快速入门

从提供的示例开始尝试。Linux/Windows、GPU/CPU均支持。对于Windows系统，建议使用PowerShell而非CMD。

提示：在以下说明中，PROJECTROOT表示该项目的根目录。

# 训练
cd PROJECT_ROOT
python train.py --conf_path=model_zoo/demo/conf.json

# 测试
python test.py --conf_path=model_zoo/demo/conf.json

# 预测
python predict.py --conf_path=model_zoo/demo/conf.json

对于预测功能，NeuronBlocks有两种模式：交互式和批量式。

• 交互式预测模式： 交互式模式提供了一个交互界面，用户可以根据提示信息输入案例，并从训练好的模型中获得实时预测结果，输入“exit”即可退出交互界面。

# 使用上述示例
# 交互式预测
python predict.py --conf_path=model_zoo/demo/conf.json --predict_mode='interactive'

• 批量式预测模式： 对于批量案例的预测，NeuronBlocks提供了批量预测模式，该模式接收一个案例文件作为输入，并将预测结果写入预测文件。

# 使用上述示例
# 按批量预测
python predict.py --conf_path=model_zoo/demo/conf.json --predict_mode='batch' --predict_data_path=dataset/demo/predict.tsv

更多详细信息，请参阅Tutorial.md和代码文档。

哪些人适合使用NeuronBlocks

当使用神经网络模型解决NLP问题时，面临以下挑战的工程师或研究人员可以考虑使用NeuronBlocks：

• 框架众多，学习成本高。
• 编码工作量大，细节繁多，调试困难。
• 模型架构迭代迅速，工程师难以理解其背后的数学原理。
• 模型代码优化需要深厚的专业知识。
• 不同平台兼容性要求高，例如在Linux/Windows、GPU/CPU等不同平台上运行模型需要额外的编码工作。

利用NeuronBlocks进行NLP神经网络模型训练的优势包括：

• 模型构建：在模型构建和参数调优过程中，用户只需编写简单的JSON配置文件，从而大大减少了实现新想法的工作量。

• 模型共享：通过JSON文件即可轻松共享模型，无需复杂的代码。对于不同的模型或任务，用户只需维护一个统一的源代码库。

• 代码复用：常用模块可以在不同模型或任务之间轻松共享，减少重复编码工作。

• 平台灵活性：NeuronBlocks可在Linux和Windows机器上运行，同时支持CPU和GPU计算。它还支持在Philly和PAI等GPU平台上进行训练。

  	CPU推理	单GPU推理	多GPU推理
  CPU训练	✓	✓	✓
  单GPU训练	✓	✓	✓
  多GPU训练	✓	✓	✓

• 模型可视化：提供了一个模型可视化工具，用于检查模型架构的正确性，帮助用户在调试过程中轻松地可视化模型结构。

• 可扩展性：NeuronBlocks具有良好的可扩展性，允许用户贡献新的模块或创新的模型（JSON文件）。

贡献

NeuronBlocks 采用开放模式运行。它由 STCA NLP Group, Microsoft 设计和开发。我们也非常欢迎来自学术界和工业界的贡献。更多详情，请参阅 Contributing.md。

正在进行的工作及贡献号召

熟悉相关领域的人员均被鼓励贡献代码。

• 模型压缩中的知识蒸馏。针对 BERT、OpenAI Transformer 等重型模型的知识蒸馏。基于教师-学生架构的知识蒸馏是模型压缩的一种常用方法。
• 多语言支持
• NER 模型支持
• 多任务训练支持

参考文献

NeuronBlocks -- 像搭乐高积木一样构建你的 NLP DNN 模型。EMNLP 2019, 见 https://arxiv.org/abs/1904.09535。

@article{gong2019neuronblocks,
  title={NeuronBlocks--Building Your NLP DNN Models Like Playing Lego},
  author={Gong, Ming and Shou, Linjun and Lin, Wutao and Sang, Zhijie and Yan, Quanjia and Yang, Ze, Cheng, Feixiang and Jiang, Daxin},
  journal={arXiv preprint arXiv:1904.09535},
  year={2019}
}

相关项目

• OpenPAI 是一个开源平台，提供完整的 AI 模型训练和资源管理能力，易于扩展，并支持各种规模的本地、云端及混合环境。
• AI 示例库：一个深度学习示例和项目集合。其中包含大量使用不同框架的经典深度学习算法和应用，是初学者入门深度学习的良好起点。

许可证

版权所有 © 微软公司。保留所有权利。

根据 MIT 许可证授权。

联系方式

如有任何问题，请联系 NeuronBlocks@microsoft.com。

如果您有微信，也可以添加以下账号：

NeuronBlocks 快速上手指南

NeuronBlocks 是一款由微软开发的 NLP 深度学习建模工具包，旨在让开发者像“搭乐高”一样，通过简单的 JSON 配置文件快速构建、训练和部署 NLP 深度神经网络模型。

1. 环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：支持 Linux 或 Windows（Windows 用户建议使用 PowerShell）。
• Python 版本：Python 3.6 或更高版本。
• 深度学习框架：PyTorch 0.4.1 或更高版本。
• 硬件支持：支持 CPU 及 GPU（单卡/多卡）训练与推理。

2. 安装步骤

第一步：克隆项目

将 NeuronBlocks 代码库克隆到本地：

git clone https://github.com/Microsoft/NeuronBlocks
cd NeuronBlocks

第二步：安装依赖包

安装项目所需的 Python 依赖库：

pip install -r requirements.txt

提示：国内用户若下载缓慢，可添加清华源加速： pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple

第三步：安装 PyTorch

根据操作系统选择安装方式：

• Linux 用户：

  pip install "torch>=0.4.1"
  

  提示：国内用户推荐使用清华源： pip install "torch>=0.4.1" -i https://pypi.tuna.tsinghua.edu.cn/simple

• Windows 用户： 建议通过 Conda 安装，请访问 PyTorch 官网 获取适合您环境的命令，或使用以下通用命令（需已安装 conda）：

  conda install pytorch torchvision torchaudio cpuonly -c pytorch
  

3. 基本使用

安装完成后，您可以直接使用项目自带的示例模型进行训练、测试和预测。假设 PROJECT_ROOT 为您刚才克隆的项目根目录。

训练模型 (Train)

使用默认的演示配置文件启动训练：

cd PROJECT_ROOT
python train.py --conf_path=model_zoo/demo/conf.json

测试模型 (Test)

训练完成后，使用测试集评估模型效果：

python test.py --conf_path=model_zoo/demo/conf.json

模型预测 (Predict)

NeuronBlocks 提供两种预测模式：

1. 交互式预测 (Interactive) 输入数据后实时获取预测结果，输入 exit 退出：

python predict.py --conf_path=model_zoo/demo/conf.json --predict_mode='interactive'

2. 批量预测 (Batch) 读取文件中的批量数据进行预测，并将结果输出到文件：

python predict.py --conf_path=model_zoo/demo/conf.json --predict_mode='batch' --predict_data_path=dataset/demo/predict.tsv

---

更多高级用法（如自定义模型结构、修改超参数等），请参考项目内的 Tutorial_zh_CN.md 文档。