From 5ebd23abd0177bd008e3dd70f5681862e7d9d121 Mon Sep 17 00:00:00 2001 From: Kaushlendra Pratap Date: Fri, 28 Aug 2020 15:11:20 +0530 Subject: [PATCH] docs(Readme): Add Classification Model Usage --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8d177d14..23dc7501 100644 --- a/README.md +++ b/README.md @@ -81,16 +81,22 @@ Get the help by running `atarashi -h` or `atarashi --help` - With **Bigram Cosine similarity** `atarashi -a Ngram -s BigramCosineSim /path/to/file.c` -- Running **Classification** models - - **Logistic Regression** +- **Classification models** + - **Training** (optional) + + `python3 train.py` + - Running **Classification Models** - `atarashi -a lr_classifier -m /path/to/models/folder/ /path/to/file.c` - - **Multimomial Naive Bayes** - `atarashi -a nb_classifier -m /path/to/models/folder/ /path/to/file.c` - - **Linear SVC** + - **Logistic Regression** - `atarashi -a svc_classifier -m /path/to/models/folder/ /path/to/file.c` + `atarashi -a lr_classifier -m /path/to/models/folder/ /path/to/file.c` + - **Multimomial Naive Bayes** + + `atarashi -a nb_classifier -m /path/to/models/folder/ /path/to/file.c` + - **Linear SVC** + + `atarashi -a svc_classifier -m /path/to/models/folder/ /path/to/file.c` - Running in **verbose** mode `atarashi -a DLD -v /path/to/file.c`