This is a Machine Learning project that is to be used on experimentation tracking and data science training. The Divorce Predictors data set is used as a
To setup this repository locally for testing and implementation please follow this guidelines. This repository is based on Python 3.7.1 or above, Makefile, Poetry, and gsutil. Poetry is extensively used as a virtual environment manager, if you use other virtual environment manager, double check the orientations and commands that will be showing here. After cloning this repository, and having poetry and python 3.7.1 or above installed, run the following command for installing this package for common usage:
make installIf your intention is for code development or maintainance, after installing this package apply the command below to install development dependencies and setup pre-commit:
make devOther useful command targets available at Makefile are:
poetry run make test-codeThe command above will run all unit tests. Notice that I'm using poetry to correctly run inside my development virtual environment.
poetry run make static-analysisAbove command will do an static analysis, checking style with flake8 and computing some code complexity statistics. This will also break if style is wrong or code complexity is too high.
poetry run make coverageAbove command will run all unit tests and check that test coverage is above and specified percentage, defined inside Makefile.