Migrated repository
Go to file
2021-12-06 17:43:20 +08:00
.github Update PULL_REQUEST_TEMPLATE.md 2018-12-14 19:10:44 +08:00
docs 更新了文档的链接 2021-12-06 17:27:48 +08:00
fastNLP Merge branch 'dev' of github.com:fastNLP/fastNLP into dev 2021-12-06 17:43:20 +08:00
reproduction [bugfix]修复 coreference resolution复现代码中参数名字不对应的bug (#323) 2020-08-29 16:16:57 +08:00
tests 增加Mr, R8, R52, Ohsumed, 20ng数据集的loader ,pipe (#382) 2021-09-23 14:40:07 +08:00
tutorials 更新了 tutorial 的 README,准备合入 master 分支 2020-03-04 23:07:11 +08:00
.coverage 修改travis converage设置 2019-08-29 10:12:30 +08:00
.gitignore update documents 2019-09-17 14:37:22 +08:00
.Jenkinsfile update .Jenkinsfile. 2020-12-27 15:52:39 +08:00
.travis.yml 删除对spacy的依赖 2020-12-11 14:03:10 +08:00
codecov.yml add codecov fix 2019-02-04 09:56:08 +08:00
LICENSE add LICENSE, setup.py & requirements.txt 2018-05-25 18:32:02 +08:00
MANIFEST.in 把测试文件夹 test 改名为 tests 2020-11-23 13:00:31 +08:00
README.md 更新了文档的链接 2021-12-06 17:27:48 +08:00
readthedocs.yml 更新了文档的链接 2021-12-06 17:27:48 +08:00
requirements.txt 删除对spacy的依赖 2020-12-11 14:03:10 +08:00
setup.py Update Python version to 3.7 2021-10-28 15:22:00 +08:00

fastNLP

Build Status codecov Pypi Hex.pm Documentation Status

fastNLP是一款轻量级的自然语言处理NLP工具包目标是快速实现NLP任务以及构建复杂模型。

fastNLP具有如下的特性

  • 统一的Tabular式数据容器简化数据预处理过程
  • 内置多种数据集的Loader和Pipe省去预处理代码;
  • 各种方便的NLP工具例如Embedding加载包括ELMo和BERT、中间数据cache等;
  • 部分数据集与预训练模型的自动下载;
  • 提供多种神经网络组件以及复现模型(涵盖中文分词、命名实体识别、句法分析、文本分类、文本匹配、指代消解、摘要等任务);
  • Trainer提供多种内置Callback函数方便实验记录、异常捕获等。

安装指南

fastNLP 依赖以下包:

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

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

pip install fastNLP
python -m spacy download en

fastNLP教程

中文文档教程

快速入门

详细使用教程

扩展教程

内置组件

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

以文本分类任务为例下图展示了一个BiLSTM+Attention实现文本分类器的模型流程图

fastNLP 在 embeddings 模块中内置了几种不同的embedding静态embeddingGloVe、word2vec、上下文相关embedding ELMo、BERT、字符embedding基于CNN或者LSTM的CharEmbedding

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

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

项目结构

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

fastNLP 开源的自然语言处理库
fastNLP.core 实现了核心功能,包括数据处理组件、训练器、测试器等
fastNLP.models 实现了一些完整的神经网络模型
fastNLP.modules 实现了用于搭建神经网络模型的诸多组件
fastNLP.embeddings 实现了将序列index转为向量序列的功能包括读取预训练embedding等
fastNLP.io 实现了读写功能,包括数据读入与预处理,模型读写,数据与模型自动下载等

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