Skip to content

Commit

Permalink
added note on test notebooks
Browse files Browse the repository at this point in the history
  • Loading branch information
fedepup committed May 9, 2024
1 parent 27dc730 commit 9682271
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ repos:
rev: 1.0.0
hooks:
- id: nb-ensure-clean
files: ^Notebooks/.*\..ipynb$
exclude: ^docs/

- repo: https://github.com/PyCQA/bandit
rev: 1.7.7
Expand Down
6 changes: 5 additions & 1 deletion Notebooks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,8 @@ This folder gathers all the notebooks created during the development of selfEEG.

1. All "_guide" notebooks are the ones included in the official documentation, under the tutorials section. They can be modified or run without worrying about changing the documentation page. If you think additional tutorials must be included, try to implement things here before changing notebooks in the doc folder.
2. All notebooks in the test_notebook folder are the first versions of the library unittests. They are not as complete as the final versions of the library unittests, but they can be useful if you want to add further checks on preexisting functionalities or if you want assess if tests on novel functionalities run smoothly before including them in the official test folder.
3. Augmentation_benchmark is the notebook version of the extra_material augmentation benchmark Python script. You can use it to test how fast a specific augmentation is executed on your device instead of running the whole benchmark.

> [!NOTE]
> Test notebooks will no longer be updated.
4. Augmentation_benchmark is the notebook version of the extra_material augmentation benchmark Python script. You can use it to test how fast a specific augmentation is executed on your device instead of running the whole benchmark.

0 comments on commit 9682271

Please sign in to comment.