TextClf（简单易上手的基于pytorch/sklearn的文本分类工具） NLP

文本分类是自然语言处理中最常见的任务之一。从邮箱应用中的垃圾邮件识别到搜索引擎中的query意图判别，
再到商品评论中的情感分析, 这些其实都是我们身边对文本分类的常见需求。
为了帮助大家更好的应对经常遇到的文本分类场景，我最近开发了一个工具箱TextClf，使用TextClf，
你可以通过生成和修改配置文件，快速尝试多种分类算法模型、调整参数、搭建baseline，
有了这个工具箱，你可以从模型搭建、模型训练、模型测试等一系列复杂的实现中脱离出来, 让你能有更多精力关注于数据本身的特点，做针对性的改进优化。
如果你是一个文本分类任务的初学者，那么TextClf的简单易用会让你很快上手。如果你是更高级的用户，
想尝试更多新奇的想法,比如搭建一个分类模型或者是使用你自己设计的训练方式），那么你也可以借助TextClf，
在TextClf基础上进行开发，它会帮你省下很多麻烦的工作。
TextClf的github主页在
https://github.com/luopeixiang/textclf
想直接看代码的同学可以移步GitHub。
下面我将主要通过以下几点来介绍TextClf

TextClf简介
- 概览
- 系统设计思路
- 目录结构
安装
快速开始
- 预处理
- 训练一个逻辑回归模型
- 加载训练完毕的模型进行测试分析
- 训练TextCNN模型
结语
参考

TextClf简介概览
如前言所述，TextClf 是一个面向文本分类场景的工具箱，它的目标是可以通过配置文件快速尝试多种分类算法模型、调整参数、搭建baseline，从而让使用者能有更多精力关注于数据本身的特点，做针对性改进优化。
TextClf有以下这些特性：

同时支持机器学习模型如逻辑回归、线性向量机与深度学习模型如TextCNN、TextRNN、TextRCNN、DRNN、DPCNN、Bert等等。
支持多种优化方法，如Adam 、AdamW 、Adamax、RMSprop等等
支持多种学习率调整的方式，如ReduceLROnPlateau 、 StepLR 、 MultiStepLR
支持多种损失函数，如CrossEntropyLoss、CrossEntropyLoss with label smoothing、FocalLoss
可以通过和程序交互生成配置，再通过修改配置文件快速调整参数。
在训练深度学习模型时，支持使用对embedding层和classifier层分别使用不同的学习率进行训练
支持从断点（checkpoint）重新训练
具有清晰的代码结构，可以让你很方便的加入自己的模型，使用textclf，你可以不用去关注优化方法、数据加载等方面，可以把更多精力放在模型实现上。

与其他文本分类框架 NeuralClassifier 的比较：

NeuralClassifier不支持机器学习模型，也不支持Bert/Xlnet等深度的预训练模型。
TextClf会比NeuralClassifier对新手更加友好，清晰的代码结构也会使得你能方便地对它进行拓展。
特别地，对于深度学习模型，TextClf将其看成两个部分，Embedding层和Classifier层。
Embedding层可以是随机初始化的词向量，也可以是预训练好的静态词向量（word2vec、glove、fasttext），也可以是动态词向量如Bert、Xlnet等等。
Classifier层可以是MLP，CNN，将来也会支持RCNN，RNN with attention等各种模型。
通过将embedding层和classifier层分开，在配置深度学习模型时，我们可以选择对embedding层和classifier层进行排列组合，比如Bert embedding + CNN ，word2vec + RCNN 等等。
这样，通过比较少的代码实现，textclf就可以涵盖更多的模型组合的可能。

系统设计思路
TextClf将文本分类的流程看成预处理、模型训练、模型测试三个阶段。
预处理阶段做的事情主要是：

读入原始数据，进行分词，构建词典
分析标签分布等数据特点
保存成二进制的形式方便快速读入

数据经过预处理之后，我们就可以在上面训练各种模型、比较模型的效果。
模型训练阶段负责的是：

读入预处理过的数据
根据配置初始化模型、优化器等训练模型必需的因素
训练模型，根据需要最优模型

测试阶段的功能主要是：

加载训练阶段保存的模型进行测试
支持使用文件输入或者终端输入两种方式进行测试

为了方便地对预处理、模型训练、模型测试阶段进行控制，TextClf使用了json文件来对相关的参数（如预处理中指定原始文件的路径、模型训练阶段指定模型参数、优化器参数等等）进行配置。运行的时候，只要指定配置文件，TextClf就会根据文件中的参数完成预处理、训练或者测试等工作，详情可参见快速开始部分。
目录结构
textclf源代码目录下有六个子目录和两个文件，每项的作用如下所示：

├── config# 包括预处理、模型训练、模型测试的各种参数及其默认设置 ├── data# 数据预处理、数据加载的代码 ├── models# 主要包括深度学习模型的实现 ├── tester# 负责加载模型进行测试 ├── __init__.py # 模块的初始化文件 ├── main.py# textclf的接口文件，运行textclf会调用该文件中的main函数 ├── trainer# 负责模型的训练 └── utils# 包含各种工具函数

安装依赖环境：python >=3.6
使用pip安装：

pip install textclf

上述命令首先将代码clone到本地，然后切换到项目目录，使用pip安装textclf及其依赖。
之后就可以使用textclf了！
快速开始下面我们看一下如何使用textclf训练模型进行文本分类。
在目录examples/toutiao 下有以下文件：

3900行 train.csv 600行 valid.csv 600行 test.csv 5100行 total

这些数据来自
今日头条新闻分类数据集，
在这里用作演示。
文件的格式如下：

下周一（5.7日）手上持有这些股的要小心news_finance 猪伪狂犬苗的免疫方案怎么做？news_edu 小米7未到！这两款小米手机目前性价比最高，米粉：可惜买不到news_tech 任何指望技术来解决社会公正、公平的设想，都是幻想news_tech 诸葛亮能借东风火烧曹营，为什么火烧司马懿却没料到会下雨？news_culture 福利几款旅行必备神器，便宜实用颜值高！news_travel 抵押车要怎样年审和购买保险？news_car 现在一万一平米的房子，十年后大概卖多少钱？news_house 第一位有中国国籍的外国人，留中国五十多年，死前留下这样的话！news_world 为什么A股投资者越保护越亏？stock

【TextClf（简单易上手的基于pytorch/sklearn的文本分类工具）】文件每一行由两个字段组成，分别是句子和对应的label，句子和label之间使用\t字符隔开。
预处理
第一步是预处理。预处理将会完成读入原始数据，进行分词，构建词典，保存成二进制的形式方便快速读入等工作。要对预处理的参数进行控制，需要相应的配置文件，textclf中的help-config功能可以帮助我们快速生成配置，运行：

textclf help-config

输入0让系统为我们生成默认的PreprocessConfig，接着将它保存成preprocess.json文件：

(textclf) luo@luo-pc:~/projects$ textclf help-config Config有以下选择(Default: DLTrainerConfig): 0. PreprocessConfig预处理的设置 1. DLTrainerConfig训练深度学习模型的设置 2. DLTesterConfig测试深度学习模型的设置 3. MLTrainerConfig训练机器学习模型的设置 4. MLTesterConfig测试机器学习模型的设置输入您选择的ID (q to quit, enter for default):0 Chooce value PreprocessConfig预处理的设置输入保存的文件名(Default: config.json): preprocess.json 已经将您的配置写入到 preprocess.json,你可以在该文件中查看、修改参数以便后续使用 Bye!

打开文件preprocess.json，可以看到以下内容：

{ "__class__": "PreprocessConfig", "params": { "train_file": "train.csv", "valid_file": "valid.csv", "test_file": "test.csv", "datadir": "dataset", "tokenizer": "char", "nwords": -1, "min_word_count": 1 } }

params中是我们可以进行设置的参数，这些字段的详细含义可以查看文档。
这里我们只需要把datadir字段修改成toutiao目录即可
（最好使用绝对路径，若使用相对路径，要确保当前工作目录正确访问该路径。）
然后，就可以根据配置文件进行预处理了：

textclf --config-file preprocess.json preprocess

如无错误，输出如下：

(textclf) luo@V_PXLUO-NB2:~/textclf/test$ textclf --config-file config.json preprocess Tokenize text from /home/luo/textclf/textclf_source/examples/toutiao/train.csv... 3900it [00:00, 311624.35it/s] Tokenize text from /home/luo/textclf/textclf_source/examples/toutiao/valid.csv... 600it [00:00, 299700.18it/s] Tokenize text from /home/luo/textclf/textclf_source/examples/toutiao/test.csv... 600it [00:00, 289795.30it/s] Label Prob: +--------------------+-------------+-------------+------------+ ||train.csv |valid.csv |test.csv | +====================+=============+=============+============+ | news_finance|0.0667 |0.0667 |0.0667 | +--------------------+-------------+-------------+------------+ | news_edu|0.0667 |0.0667 |0.0667 | +--------------------+-------------+-------------+------------+ | news_tech|0.0667 |0.0667 |0.0667 | +--------------------+-------------+-------------+------------+ | news_culture|0.0667 |0.0667 |0.0667 | +--------------------+-------------+-------------+------------+ | news_travel|0.0667 |0.0667 |0.0667 | +--------------------+-------------+-------------+------------+ | news_car|0.0667 |0.0667 |0.0667 | +--------------------+-------------+-------------+------------+ | news_house|0.0667 |0.0667 |0.0667 | +--------------------+-------------+-------------+------------+ | news_world|0.0667 |0.0667 |0.0667 | +--------------------+-------------+-------------+------------+ | stock|0.0667 |0.0667 |0.0667 | +--------------------+-------------+-------------+------------+ | news_story|0.0667 |0.0667 |0.0667 | +--------------------+-------------+-------------+------------+ | news_agriculture|0.0667 |0.0667 |0.0667 | +--------------------+-------------+-------------+------------+ | news_entertainment |0.0667 |0.0667 |0.0667 | +--------------------+-------------+-------------+------------+ | news_military|0.0667 |0.0667 |0.0667 | +--------------------+-------------+-------------+------------+ | news_sports|0.0667 |0.0667 |0.0667 | +--------------------+-------------+-------------+------------+ | news_game|0.0667 |0.0667 |0.0667 | +--------------------+-------------+-------------+------------+ | Sum|3900.0000 |600.0000 |600.0000 | +--------------------+-------------+-------------+------------+ Dictionary Size: 2981 Saving data to ./textclf.joblib...

预处理会打印每个数据集标签分布的信息。同时，处理过后的数据被保存到二进制文件./textclf.joblib中了。
（每个类别所含的样本数是相同的。）
预处理中的详细参数说明，请查看文档。
训练一个逻辑回归模型
同样的，我们先使用textclf help-config生成train_lr.json配置文件，输入3 选择训练机器学习模型的配置。
根据提示分别选择CountVectorizer（文本向量化的方式）以及模型LR：

(textclf) luo@luo-pc:~/projects$ textclf help-config Config有以下选择(Default: DLTrainerConfig): 0. PreprocessConfig预处理的设置 1. DLTrainerConfig训练深度学习模型的设置 2. DLTesterConfig测试深度学习模型的设置 3. MLTrainerConfig训练机器学习模型的设置 4. MLTesterConfig测试机器学习模型的设置输入您选择的ID (q to quit, enter for default):3 Chooce value MLTrainerConfig训练机器学习模型的设置正在设置vectorizer vectorizer 有以下选择(Default: CountVectorizer): 0. CountVectorizer 1. TfidfVectorizer 输入您选择的ID (q to quit, enter for default):0 Chooce value CountVectorizer 正在设置model model 有以下选择(Default: LogisticRegression): 0. LogisticRegression 1. LinearSVM 输入您选择的ID (q to quit, enter for default):0 Chooce value LogisticRegression 输入保存的文件名(Default: config.json): train_lr.json 已经将您的配置写入到 train_lr.json,你可以在该文件中查看、修改参数以便后续使用 Bye!

对于更细粒度的配置，如逻辑回归模型的参数，CountVectorizer的参数，可以在生成的train_lr.json中进行修改。这里使用默认的配置进行训练：

textclf --config-file train_lr.json train

因为数据量比较小，所以应该马上就能看到结果。训练结束后，textclf会在测试集上测试模型效果，同时将模型保存在ckpts目录下。
机器学习模型训练中的详细参数说明，请查看文档。
加载训练完毕的模型进行测试分析
首先使用help-config生成MLTesterConfig的默认设置到test_lr.json：

(textclf) luo@luo-pc:~/projects$ textclf help-config Config有以下选择(Default: DLTrainerConfig): 0. PreprocessConfig预处理的设置 1. DLTrainerConfig训练深度学习模型的设置 2. DLTesterConfig测试深度学习模型的设置 3. MLTrainerConfig训练机器学习模型的设置 4. MLTesterConfig测试机器学习模型的设置输入您选择的ID (q to quit, enter for default):4 Chooce value MLTesterConfig测试机器学习模型的设置输入保存的文件名(Default: config.json): test_lr.json 已经将您的配置写入到 test_lr.json,你可以在该文件中查看、修改参数以便后续使用 Bye!

将test_lr.json中的input_file字段修改成query_intent_toy_data/test.csv 的路径，然后进行测试：

textclf --config-file test_lr.json test

测试结束，textclf将会打印出准确率、每个label的f1值：

Writing predicted labels to predict.csv Acc in test file:66.67% Report: precisionrecallf1-scoresupportnews_agriculture0.69700.57500.630140 news_car0.80560.72500.763240 news_culture0.79490.77500.784840 news_edu0.84210.80000.820540 news_entertainment0.60000.60000.600040 news_finance0.20370.27500.234040 news_game0.71110.80000.752940 news_house0.78050.80000.790140 news_military0.87500.70000.777840 news_sports0.73170.75000.740740 news_story0.72970.67500.701340 news_tech0.65220.75000.697740 news_travel0.64100.62500.632940 news_world0.65850.67500.666740 stock0.50000.47500.487240accuracy0.6667600 macro avg0.68150.66670.6720600 weighted avg0.68150.66670.6720600

关于机器学习模型测试中的详细参数，请查看文档。
训练TextCNN模型
训练深度学习模型TextCNN的过程与训练逻辑回归的流程大体一致。
这里简单做一下说明。先通过help-config进行配置，根据提示，先选择DLTrainerConfig ，然后再先后选择Adam optimzer + ReduceLROnPlateau + StaticEmbeddingLayer + CNNClassifier + CrossEntropyLoss即可。

(textclf) luo@V_PXLUO-NB2:~/textclf/test$ textclf help-config Config有以下选择(Default: DLTrainerConfig): 0. PreprocessConfig预处理的设置 1. DLTrainerConfig训练深度学习模型的设置 2. DLTesterConfig测试深度学习模型的设置 3. MLTrainerConfig训练机器学习模型的设置 4. MLTesterConfig测试机器学习模型的设置输入您选择的ID (q to quit, enter for default): Chooce default value: DLTrainerConfig 正在设置optimizer optimizer 有以下选择(Default: Adam): 0. Adam 1. Adadelta 2. Adagrad 3. AdamW 4. Adamax 5. ASGD 6. RMSprop 7. Rprop 8. SGD 输入您选择的ID (q to quit, enter for default): Chooce default value: Adam 正在设置scheduler scheduler 有以下选择(Default: NoneScheduler): 0. NoneScheduler 1. ReduceLROnPlateau 2. StepLR 3. MultiStepLR 输入您选择的ID (q to quit, enter for default): Chooce default value: NoneScheduler 正在设置model 正在设置embedding_layer embedding_layer 有以下选择(Default: StaticEmbeddingLayer): 0. StaticEmbeddingLayer 1. BertEmbeddingLayer 输入您选择的ID (q to quit, enter for default): Chooce default value: StaticEmbeddingLayer 正在设置classifier classifier 有以下选择(Default: CNNClassifier): 0. CNNClassifier 1. LinearClassifier 2. RNNClassifier 3. RCNNClassifier 4. DRNNClassifier 5. DPCNNClassifier 输入您选择的ID (q to quit, enter for default):0 Chooce value CNNClassifier 正在设置data_loader 正在设置criterion criterion 有以下选择(Default: CrossEntropyLoss): 0. CrossEntropyLoss 1. FocalLoss 输入您选择的ID (q to quit, enter for default):q^Hq 请输入整数ID！输入您选择的ID (q to quit, enter for default):q Goodbye! (textclf) luo@V_PXLUO-NB2:~/textclf/test$ (textclf) luo@V_PXLUO-NB2:~/textclf/test$ textclf help-config Config有以下选择(Default: DLTrainerConfig): 0. PreprocessConfig预处理的设置 1. DLTrainerConfig训练深度学习模型的设置 2. DLTesterConfig测试深度学习模型的设置 3. MLTrainerConfig训练机器学习模型的设置 4. MLTesterConfig测试机器学习模型的设置输入您选择的ID (q to quit, enter for default):1 Chooce value DLTrainerConfig训练深度学习模型的设置正在设置optimizer optimizer 有以下选择(Default: Adam): 0. Adam 1. Adadelta 2. Adagrad 3. AdamW 4. Adamax 5. ASGD 6. RMSprop 7. Rprop 8. SGD 输入您选择的ID (q to quit, enter for default):0 Chooce value Adam 正在设置scheduler scheduler 有以下选择(Default: NoneScheduler): 0. NoneScheduler 1. ReduceLROnPlateau 2. StepLR 3. MultiStepLR 输入您选择的ID (q to quit, enter for default):0 Chooce value NoneScheduler 正在设置model 正在设置embedding_layer embedding_layer 有以下选择(Default: StaticEmbeddingLayer): 0. StaticEmbeddingLayer 1. BertEmbeddingLayer 输入您选择的ID (q to quit, enter for default):0 Chooce value StaticEmbeddingLayer 正在设置classifier classifier 有以下选择(Default: CNNClassifier): 0. CNNClassifier 1. LinearClassifier 2. RNNClassifier 3. RCNNClassifier 4. DRNNClassifier 5. DPCNNClassifier 输入您选择的ID (q to quit, enter for default):0 Chooce value CNNClassifier 正在设置data_loader 正在设置criterion criterion 有以下选择(Default: CrossEntropyLoss): 0. CrossEntropyLoss 1. FocalLoss 输入您选择的ID (q to quit, enter for default):0 Chooce value CrossEntropyLoss 输入保存的文件名(Default: config.json): train_cnn.json 已经将您的配置写入到 train_cnn.json,你可以在该文件中查看、修改参数以便后续使用 Bye!

然后运行：

textclf --config-file train_cnn.json train

即可开始训练我们配置好的textcnn模型。
当然，在训练结束之后，我们也可以通过DLTesterConfig配置来测试模型效果。而且，如果你想使用预训练的静态embedding如word2vec、glove只需要修改配置文件即可。
上述就是TextCNN的训练过程。如果你想尝试更多的模型，比如Bert，只需要在设置DLTrainerConfig时将EmbeddingLayer设置为 BertEmbeddingLayer，并且在生成的配置文件中手动设置一下预训练Bert模型的路径。这里就不再赘述了。
本节的相关文档：
训练深度学习模型的详细参数说明
测试深度学习模型的详细参数说明
textclf文档
结语以上就是TextClf的简单介绍啦。如果你手头上有文本分类相关的任务，那么不妨试一试TextClf吧！
要是TextClf对你产生了帮助，可以到TextClf的github主页点个star或者fork哦！
有人用的话，那么之后我也会多抽点时间，给TextClf加一些其他的特性,让它变得更好的。
最后，因为个人能力和精力有限，TextClf肯定是存在一些不足的，如果你对这个项目有什么建议或者指导意见，也欢迎直接和我交流哦!
参考 DeepText/NeuralClassifier
pytext