Text Classification Baseline
Pipeline for fast building text classification TF-IDF + LogReg baselines.
Usage
Instead of writing custom code for specific text classification task, you just need:
- install pipeline:
pip install text-classification-baseline
- run pipeline:
- either in terminal:
text-clf-train
- or in python:
import text_clf
text_clf.train()
No data preparation is needed, only a csv file with two raw columns (with arbitrary names):
texttarget
NOTE: the target can be presented in any format, including text - not necessarily integers from 0 to n_classes-1.
Config
The user interface consists of only one file config.yaml.
Change config.yaml to create the desired configuration and train text classification model with the following command:
- terminal:
text-clf-train --path_to_config config.yaml
- python:
import text_clf
text_clf.train(path_to_config="config.yaml")
Default config.yaml:
seed: 42
verbose: true
path_to_save_folder: models
# data
data:
train_data_path: data/train.csv
valid_data_path: data/valid.csv
sep: ','
text_column: text
target_column: target_name_short
# tf-idf
tf-idf:
lowercase: true
ngram_range: (1, 1)
max_df: 1.0
min_df: 0.0
# logreg
logreg:
penalty: l2
C: 1.0
class_weight: balanced
solver: saga
multi_class: auto
n_jobs: -1
NOTE: tf-idf and logreg are sklearn TfidfVectorizer and LogisticRegression parameters correspondingly, so you can parameterize instances of these classes however you want.
Output
After training the model, the pipeline will return the following files:
model.joblib- sklearn pipeline with TF-IDF and LogReg stepstarget_names.json- mapping from encoded target labels from 0 to n_classes-1 to it namesconfig.yaml- config that was used to train the modellogging.txt- logging file
Requirements
Python >= 3.6
Citation
If you use text-classification-baseline in a scientific publication, we would appreciate references to the following BibTex entry:
@misc{dayyass2021textclf,
author = {El-Ayyass, Dani},
title = {Pipeline for training text classification baselines},
howpublished = {\url{https://github.com/dayyass/text-classification-baseline}},
year = {2021}
}
105 Jan 3, 2023
37 Dec 4, 2022
1k Dec 30, 2022
8 Dec 25, 2022
7 Sep 20, 2022
21 Aug 6, 2022
285 Jan 2, 2023
186 Dec 29, 2022
1 Oct 18, 2022
901 Jan 06, 2023
384 Dec 12, 2022
68 Dec 19, 2022
2 Mar 17, 2022
775 Jan 08, 2023
1 Feb 14, 2022
2 Jan 18, 2022
1 Dec 22, 2021
117 Dec 27, 2022
185 Dec 21, 2022
43 Dec 28, 2022
3 May 23, 2022
730 Jan 09, 2023
8 Sep 04, 2021
11 Jun 13, 2022
7 Dec 08, 2022
4 Feb 19, 2022
823 Dec 28, 2022
86 Nov 28, 2022