From b3c63a6dcddfa888c8223ac7e2d07f0a605df998 Mon Sep 17 00:00:00 2001 From: Yann Bouteiller Date: Sat, 27 Nov 2021 18:58:55 -0500 Subject: [PATCH] v0.0.2 --- README.md | 7 ++++--- setup.py | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c80c586..d51482a 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ ```terminal pip install -e . ``` -- download the [datasets.zip](https://github.com/nicolasvalenchon/Portiloop/releases/download/v0.0.1/dataset.zip) and the [experiments.zip](https://github.com/nicolasvalenchon/Portiloop/releases/download/v0.0.1/experiments.zip) files +- download the [datasets.zip](https://github.com/nicolasvalenchon/Portiloop/releases/download/v0.0.2/dataset.zip) and the [experiments.zip](https://github.com/nicolasvalenchon/Portiloop/releases/download/v0.0.2/experiments.zip) files - unzip the `datasets.zip` file and paste its content under `Portiloop>portiloop_software>dataset` - unzip the `experiments.zip` file and paste its content under `Portiloop>portiloop_software>experiments` @@ -21,11 +21,12 @@ This notebook can be executed with `jupyter notebook`. ### Offline inference: We enable easily using out trained artificial neural network on your own data to detect sleep spindles (note that the data must be collected in the same experimental setting as MODA for this to work, see [our paper](https://arxiv.org/abs/2107.13473)). -This is easily done by writing your signal in a simple text file, on the model of example_data_not_annotated.txt. Your file can then be directly used for inference in our offline_inference notebook. +This is easily done by writing your signal in a simple text file, on the model of the `example_data_not_annotated.txt` file provided in the `datasets.zip` file. +Your file can then be directly used for inference in our `offline_inference` [notebook](https://github.com/nicolasvalenchon/Portiloop/blob/main/notebooks/offline_inference.ipynb). ### Training: Functions used for training are defined in python under the `Software` folder. -We provide [bash scripts examples](https://github.com/nicolasvalenchon/Portiloop/releases/download/v0.0.1/scripts.zip) for `SLURM` to train the model on HPC systems. +We provide [bash scripts examples](https://github.com/nicolasvalenchon/Portiloop/releases/download/v0.0.2/scripts.zip) for `SLURM` to train the model on HPC systems. Adapt these scripts to your configuration. Your training curves can be visualized in real time easily using [wandb](https://wandb.ai/portiloop) (the code is ready, you may adapt it to your project name and entity). diff --git a/setup.py b/setup.py index ace4d37..e723ec0 100644 --- a/setup.py +++ b/setup.py @@ -20,7 +20,7 @@ setup(name='portiloop', packages=[package for package in find_packages()], - version='0.0.1', + version='0.0.2', license='MIT', description='Sleep spindle detector', long_description=long_description,