Recommender System 2019 Competition

Code Notation

• Java-style (i.e. FirstLetterUppercase) notation for Class file and Class name
• Python-style (i.e. under_score) notation for function definition and function-only filename (e.g. helper files)
• Python-style for variable names
• Jupyter notebooks name format should be: dev_name_notebook_name_only_lowercase.ipynb
• Packages and directories names should be written only lowercase

Requirements

• Python 3.6 virtual environment

Installation

1. pip install -r requirements_dev.txt
2. Follow the guide on how to compile all cython files in RecSys Course 2018 GitHub Project

Jupyter Notebooks

All notebooks has as a root folder notebooks/

Versioning Notebooks

In order to versioning notebooks, use jupytext which is a library of commands written in python to convert notebooks into pure python files. For pairing a notebook, after having installed jupytext, it is possible to do it by

jupytext --set-formats ipynb,py notebook.ipynb

Then, it is possible to sync (i.e. update python file) with

jupytext --sync notebook.ipynb

Convert Notebook to HTML

To convert a notebook into HTML, just run the following command line

jupyter nbconvert --to html notebook.ipynb

Remember to move the html file into the report section folder