Skip to content

Commit

Permalink
v0.0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
yannbouteiller committed Nov 27, 2021
1 parent 18ea528 commit b3c63a6
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand All @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit b3c63a6

Please sign in to comment.