Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
data/processed/*.npy filter=lfs diff=lfs merge=lfs -text

# Keep notebooks available in the repository without counting them in GitHub's language bar.
*.ipynb -linguist-detectable
63 changes: 0 additions & 63 deletions docs/api.md

This file was deleted.

6 changes: 6 additions & 0 deletions docs/api/augmentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# GAN Augmentation

::: eegclassify.augmentation
options:
show_root_heading: false

6 changes: 6 additions & 0 deletions docs/api/bci2a.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# BCI IV-2a Conversion

::: eegclassify.bci2a
options:
show_root_heading: false

6 changes: 6 additions & 0 deletions docs/api/cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Command Line Interface

::: eegclassify.cli
options:
show_root_heading: false

6 changes: 6 additions & 0 deletions docs/api/config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Configuration

::: eegclassify.config
options:
show_root_heading: false

6 changes: 6 additions & 0 deletions docs/api/constants.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Constants

::: eegclassify.constants
options:
show_root_heading: false

6 changes: 6 additions & 0 deletions docs/api/data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Data Loading And Comparison

::: eegclassify.data
options:
show_root_heading: false

14 changes: 14 additions & 0 deletions docs/api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# API Reference

The API reference is organized around the main EEG classification workflow: configure an experiment, prepare data, optionally augment training samples, train framework-specific models, and inspect results.

- [Configuration](config.md)
- [Data Loading And Comparison](data.md)
- [Preprocessing](preprocessing.md)
- [BCI IV-2a Conversion](bci2a.md)
- [GAN Augmentation](augmentation.md)
- [Model APIs](models/index.md)
- [Plotting](plotting.md)
- [Command Line Interface](cli.md)
- [Constants](constants.md)

8 changes: 8 additions & 0 deletions docs/api/models/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Model APIs

The framework modules expose matching classifier families for TensorFlow/Keras, PyTorch, and JAX/Flax, along with the reusable GAN augmentation path used by the training workflow.

- [TensorFlow Models](tensorflow.md)
- [PyTorch Models](pytorch.md)
- [JAX Models](jax.md)

6 changes: 6 additions & 0 deletions docs/api/models/jax.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# JAX Models

::: eegclassify.models.jax
options:
show_root_heading: false

6 changes: 6 additions & 0 deletions docs/api/models/pytorch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# PyTorch Models

::: eegclassify.models.pytorch
options:
show_root_heading: false

6 changes: 6 additions & 0 deletions docs/api/models/tensorflow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# TensorFlow Models

::: eegclassify.models.tensorflow
options:
show_root_heading: false

6 changes: 6 additions & 0 deletions docs/api/plotting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Plotting

::: eegclassify.plotting
options:
show_root_heading: false

6 changes: 6 additions & 0 deletions docs/api/preprocessing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Preprocessing

::: eegclassify.preprocessing
options:
show_root_heading: false

17 changes: 16 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,22 @@ nav:
- Data: data.md
- Reproduce Results: reproduce.md
- Results: results.md
- API: api.md
- API Reference:
- Overview: api/index.md
- Configuration: api/config.md
- Data:
- Loading And Comparison: api/data.md
- Preprocessing: api/preprocessing.md
- BCI IV-2a Conversion: api/bci2a.md
- GAN Augmentation: api/augmentation.md
- Models:
- Overview: api/models/index.md
- TensorFlow: api/models/tensorflow.md
- PyTorch: api/models/pytorch.md
- JAX: api/models/jax.md
- Plotting: api/plotting.md
- Command Line Interface: api/cli.md
- Constants: api/constants.md

watch:
- src
Expand Down