fastNLP/README.md

• fastNLP
• • 安装指南
  • fastNLP教程
  • 内置组件
  • 项目结构

fastNLP

fastNLP 是一款轻量级的 NLP 处理套件。你既可以使用它快速地完成一个序列标注（NER、POS-Tagging等）、中文分词、文本分类、Matching、指代消解、摘要等任务； 也可以使用它构建许多复杂的网络模型，进行科研。它具有如下的特性：

• 统一的Tabular式数据容器，让数据预处理过程简洁明了。内置多种数据集的DataSet Loader，省去预处理代码;
• 多种训练、测试组件，例如训练器Trainer；测试器Tester；以及各种评测metrics等等;
• 各种方便的NLP工具，例如预处理embedding加载（包括ELMo和BERT）; 中间数据cache等;
• 详尽的中文文档、教程以供查阅;
• 提供诸多高级模块，例如Variational LSTM, Transformer, CRF等;
• 在序列标注、中文分词、文本分类、Matching、指代消解、摘要等任务上封装了各种模型可供直接使用，详细内容见 reproduction 部分;
• 便捷且具有扩展性的训练器; 提供多种内置callback函数，方便实验记录、异常捕获等。

安装指南

fastNLP 依赖以下包:

• numpy>=1.14.2
• torch>=1.0.0
• tqdm>=4.28.1
• nltk>=3.4.1
• requests
• spacy

其中torch的安装可能与操作系统及 CUDA 的版本相关，请参见 PyTorch 官网 。
在依赖包安装完成后，您可以在命令行执行如下指令完成安装

pip install fastNLP
python -m spacy download en

fastNLP教程

• 0. 快速入门
• 1. 使用DataSet预处理文本
• 2. 使用DataSetLoader加载数据集
• 3. 使用Embedding模块将文本转成向量
• 4. 动手实现一个文本分类器I-使用Trainer和Tester快速训练和测试
• 5. 动手实现一个文本分类器II-使用DataSetIter实现自定义训练过程
• 6. 快速实现序列标注模型
• 7. 使用Modules和Models快速搭建自定义模型
• 8. 使用Metric快速评测你的模型
• 9. 使用Callback自定义你的训练过程
• 10. 使用fitlog 辅助 fastNLP 进行科研

内置组件

大部分用于的 NLP 任务神经网络都可以看做由编码器（encoder）、解码器（decoder）两种模块组成。

fastNLP 在 modules 模块中内置了两种模块的诸多组件，可以帮助用户快速搭建自己所需的网络。 两种模块的功能和常见组件如下:

类型	功能	例子
encoder	将输入编码为具有具有表示能力的向量	embedding, RNN, CNN, transformer
decoder	将具有某种表示意义的向量解码为需要的输出形式	MLP, CRF

项目结构

fastNLP的大致工作流程如上图所示，而项目结构如下：

fastNLP	开源的自然语言处理库
fastNLP.core	实现了核心功能，包括数据处理组件、训练器、测试器等
fastNLP.models	实现了一些完整的神经网络模型
fastNLP.modules	实现了用于搭建神经网络模型的诸多组件
fastNLP.io	实现了读写功能，包括数据读入，模型读写等

---

In memory of @FengZiYjun. May his soul rest in peace. We will miss you very very much!