jiz148 / classifier

Classifier

Python machine learning: classifier

Contents

• Design
• Documentation
• Prerequisites Checklist
• Dev Setup
• Testing

Prerequisites

• Python 3
• Python 3 pip version 19.0.1 and up
• Python 3 built-in virtual env venv
• System tools: find, rm, tee, xargs, zip
• Command line JSON processor: jq
• Docker (optional)

Dev Setup

Running a dev-setup script to install the project and libraries.

make clean setup  # this will create a python virtualenv

Testing

After running make dev-setup, the project and libraries are installed (in python virtual environment). Now it is able to run tests.

make test  # also available to run `make unittest` or `make nosetest`

or to start a clean test (highly recommended before committing changes) -

make clean test-all

and open test coverage report

make show  # must be on docker host