Skip to content

Latest commit

 

History

History
40 lines (30 loc) · 3.45 KB

README.md

File metadata and controls

40 lines (30 loc) · 3.45 KB
Raw

Optimus

Quickly train, evaluate and deploy an optimum classifier for your text classification task. Currently, it allows you to train a CNN (Convolutional Neural Network) based text classifier. Using this toolkit, you should be able to train a classifier for most of the text classification tasks without writing a single piece of code.

The main features of Optimus are:

  • Easily train a CNN classifier
  • Config driven to make hyperparameter tuning and experimentation easy
  • Debug mode: which allows you to visualize what is happening in the internal layers of the model
  • Flask server for querying the trained model through an API

This project is based on: https://github.com/yoonkim/CNN_sentence (Many thanks to Yoon for open sourcing his code for the paper: http://arxiv.org/abs/1408.5882, which is arguably the best generic Deep Learning based text classifier at the time of writing.) The improvements over the original code are:

  • Multi-channel mode
  • Complete refactoring to make the code modular
  • Config driven, for easy experimentation
  • Model serialization/deserialization
  • Detailed evaluation results
  • Model deployment on a Flask server
  • Multi Class classification [In progress]
  • Debug Mode [In progress] img

This project is also inspired by https://github.com/japerk/nltk-trainer, which allows users to easily train NLTK based statistical classifiers.

Why deep learning?

Deep learning has dominated pattern recognition in the last few years, especially in image and speech. Recently deep learning models have outperformed statistical classifiers in a variety of NLP tasks as well. Also, one of the biggest advantage of using deep learning models is that task specific feature engineering is not required. The wiki contains a summary of exciting results we obtained using optimus, on a variety of different text classification tasks. Those interested in understanding how this model works can also check out my talk at Fifth elephant, in which I give an introduction to NLP using deep learning. Other good recommended resources can also be found [here].

Requirements

Code requires Python 2.7 and Theano 0.7. You can go to the Setting Up page, for instructions on how to quickly set up the python environment required for Optimus. Requirements are also listed in the requirements.txt file.

Start Using it

Visit the Quick Start guide to get started on using Optimus! I have also written a small tutorial on Optimus on my blog.

You can compare models trained using optimus to statistical models by using https://github.com/japerk/nltk-trainer, an awesome tool for easily training statistical classifiers. If you get some good results on a dataset, I would love to know about them!

In case you face any issue, you can create an issue on github or send me a mail at [email protected]. Suggestions and improvements are most welcome. Open github issues are a good place to start. A contributor's guide is under works.

Core contributors