README.md

cub_benchmarking

A framework for quantifing the performance of CUB metrics

Setup

1. Use pyenv to set up a clean environment using the Python version 3.5.2.
2. pip install -r requirements.txt

Using this benchmark

1. navigate into the cloned repo on your local computer
2. activate the pyenv enviorment that was setup in the previous section
3. launch ipython noteboook using the command: ipython notebook
4. click on the notebook tutorial.ipynb for tutorial