- Clone repository
git clone - Install requirements
pip install -r requirements.txt - Unpack data you need from "data" directory. "encoded_data.zip" is the ready-to-use data.
- Run notebooks from "notebooks" section one-by-one. Replace only paths from which data and model download by your own.
- If you want to use only pretrained model - you can find it in "models" directory in two variations - .pkl and .json
If you want to use benchmark function - you have to follow these rules:
- Benchmark function works with dicts that are saved as .pkl files (Examples that are ready-to-use are in "benchmark" folder).
- As input it takes two dicts - one with predicted values and the second with original values
- You can run the function from the command line by writing
python3 benchmark_script.py dict1.pkl dict2.pkl