README.md

Project

• What ?
• Why ?
• How ?

Table of Contents

• Installation
  • Prerequisites
  • Virtual environment
  • Dependencies
  • Environment variables
• Usage
  • Download data
  • Run Notebook
  • Quality Assurance
• Troubleshooting

---

Installation

Prerequisites

• Python 3.9

Virtual environment

# python -m venv env
# > or just :
make venv
source env/bin/activate

Dependencies

# pip install jupyterlab ipykernel ipywidgets widgetsnbextension graphviz python-dotenv requests matplotlib seaborn plotly bokeh dtale lux-api pandas-profiling autoviz great_expectations popmon numpy statsmodels pandas modin[ray] sklearn torch tensorflow
# > or :
# pip install -r requirements.txt
# > or just :
make install

Environment variables

• Set environment variable values in .env file (copy or rename .env.example).

Usage

Download data

Download, extract and upload to Azure Cityscape zip files.

make dataset

Run Notebook

jupyter-lab notebooks/main.ipynb

Quality Assurance

# make isort
# make format
# make lint
# make bandit
# make mypy
# make test
# > or just :
make qa

Troubleshooting

• Fix Plotly issues with JupyterLab

cf. Plotly troubleshooting

jupyter labextension install jupyterlab-plotly

• If using Jupyter Notebook instead of JupyterLab, uncomment the following lines in the notebook

import plotly.io as pio
pio.renderers.default='notebook'