zillow / luminaire

Luminaire is a python package that provides ML driven solutions for monitoring time series data.
https://zillow.github.io/luminaire
Apache License 2.0
764 stars 59 forks source link

Add getting started example #80

Closed kylebuckingham closed 2 years ago

kylebuckingham commented 3 years ago

We need a simple hello world-like example. It would also be nice to pull benchmarks from the paper out on the main page

Aristarhys commented 3 years ago

As option it can be ipynb? They are displayable in github directly (with some limitations)

https://docs.github.com/en/github/managing-files-in-a-repository/working-with-jupyter-notebook-files-on-github

Cell 0

 import sys
 !{sys.executable} -m pip install luminaire
 !{sys.executable} -m pip <other deps>

Cell 1

from luminaire.exploration.data_exploration import DataExploration
...