From 1bfc582c0ed2537cacb0b9ebbb5a936d4ad410c8 Mon Sep 17 00:00:00 2001 From: Maxime RIO Date: Thu, 10 Dec 2020 19:34:13 +0000 Subject: [PATCH] complete README --- README.md | 26 +++++++++++++++++--------- setup.cfg | 2 +- 2 files changed, 18 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f99ae00..d4044fa 100644 --- a/README.md +++ b/README.md @@ -114,23 +114,31 @@ snakemake -j 1 --config N_ITER=1 ## Results -Model results summaries: +Performance plots for the latest run are available in the [results/summary](results/summary) +folder: + ![curves](results/summary/curves.png) ![scores](results/summary/scores.png) -These scores can be downloaded as CSV from https://github.com/neon-ninja/crash_prediction/blob/main/results/summary/scores.csv +These scores can also be downloaded as [a .csv file](results/summary/scores.csv). + +The classifiers being probabilistic, one should particularly pay attention to +the calibration curves to ensure that the prediction has a good coverage. -## Project structure +## Notebooks -### Notebooks +Notebooks have been used for exploratory work: -HTML versions of the notebooks can be browsed at: -https://neon-ninja.github.io/crash_prediction/notebooks/01_explore_cas.html -and -https://neon-ninja.github.io/crash_prediction/notebooks/02_crash_severity.html +- [01_explore_cas.ipynb](notebooks/01_explore_cas.ipynb) + [[html version](https://neon-ninja.github.io/crash_prediction/notebooks/01_explore_cas.html)] + is an exploratory data analysis of the CAS dataset , +- [02_crash_severity.ipynb](notebooks/02_crash_severity.ipynb) + [[html version](https://neon-ninja.github.io/crash_prediction/notebooks/02_crash_severity.html)] + focuses on the severity of the crashes. -TODO folder structure +*Note: the notebooks have been written as Python scripts and converted into +notebooks using [`Jupytext`](https://github.com/mwouts/jupytext).* ## License diff --git a/setup.cfg b/setup.cfg index ad584a2..a0ccd40 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = crash_prediction -version = 0.2.0 +version = 1.0.0 description = Explore car crash prediction using NZTA Crash Analysis System data author = Maxime RIO author_email = maxime.rio@niwa.co.nz