Skip to content

Commit ea8f095

Browse files
committed
Update documentation for new module structure
1 parent 4aca89f commit ea8f095

2 files changed

Lines changed: 146 additions & 63 deletions

File tree

docs/source/modules/datasets.rst

Lines changed: 57 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,75 @@
11
Datasets
22
========
33

4-
Supervised Dataset
5-
-------------------
6-
.. currentmodule:: myoverse.datasets.supervised
4+
The datasets module provides a layered architecture for data handling:
5+
6+
- **Base Layer**: WindowedDataset handles zarr I/O, windowing, caching
7+
- **Paradigm Layer**: SupervisedDataset for supervised learning
8+
- **Integration Layer**: DataModule for Lightning integration
9+
- **Storage Layer**: DatasetCreator and Modality for creating datasets
10+
11+
Storage
12+
-------
13+
.. currentmodule:: myoverse.datasets
714
.. autosummary::
815
:toctree: generated/datasets
916
:template: class.rst
1017

11-
EMGDataset
18+
DatasetCreator
19+
Modality
1220

13-
Default Supervised Datasets
14-
---------------------------
15-
.. currentmodule:: myoverse.datasets.defaults
21+
Base Dataset
22+
------------
23+
.. currentmodule:: myoverse.datasets.base
1624
.. autosummary::
1725
:toctree: generated/datasets
1826
:template: class.rst
1927

20-
EMBCDataset
28+
WindowedDataset
29+
30+
Paradigms
31+
---------
32+
.. currentmodule:: myoverse.datasets.paradigms
33+
.. autosummary::
34+
:toctree: generated/datasets
35+
:template: class.rst
36+
37+
SupervisedDataset
38+
39+
Integration
40+
-----------
41+
.. currentmodule:: myoverse.datasets.datamodule
42+
.. autosummary::
43+
:toctree: generated/datasets
44+
:template: class.rst
2145

22-
Loader
23-
------
24-
This module provides a loader that can be used with pytorch lightning to load the datasets during training.
46+
DataModule
2547

26-
.. currentmodule:: myoverse.datasets.loader
48+
Utilities
49+
---------
50+
.. currentmodule:: myoverse.datasets.utils
2751
.. autosummary::
2852
:toctree: generated/datasets
2953
:template: class.rst
3054

31-
EMGZarrDataset
55+
DataSplitter
56+
DatasetFormatter
57+
58+
Presets
59+
-------
60+
Pre-configured transforms for published papers.
61+
62+
.. currentmodule:: myoverse.datasets.presets
63+
.. autosummary::
64+
:toctree: generated/datasets
65+
:template: class.rst
66+
67+
EMBCConfig
68+
69+
.. autosummary::
70+
:toctree: generated/datasets
71+
72+
embc_train_transform
73+
embc_eval_transform
74+
embc_target_transform
75+
embc_kinematics_transform

docs/source/modules/filters.rst

Lines changed: 89 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,114 @@
11
.. _filters:
22

3-
Filters
4-
=======
3+
Transforms
4+
==========
55

6-
Filters are used to preprocess the data before it is used by the model.
7-
Some filters can only work on chunked data, while others can work on both chunked and unchunked data.
6+
GPU-accelerated transforms using PyTorch named tensors.
7+
Works on both CPU and GPU - tensors provide dimension awareness everywhere.
88

9-
Generic Filters
10-
---------------
11-
Generic filters e.g. allow the use of custom methods to preprocess the data.
12-
13-
.. currentmodule:: myoverse.datasets.filters.generic
9+
Base Classes
10+
------------
11+
.. currentmodule:: myoverse.transforms
1412
.. autosummary::
15-
:toctree: generated/filters
13+
:toctree: generated/transforms
1614
:template: class.rst
1715

18-
ApplyFunctionFilter
19-
IndexDataFilter
20-
ChunkizeDataFilter
21-
IdentityFilter
16+
Transform
2217

23-
Temporal Filters
24-
----------------
25-
Temporal filters can be used to compute most EMG features such as the root mean square or the mean absolute value.
18+
Temporal / Signal Processing
19+
----------------------------
20+
Temporal transforms for EMG feature extraction and signal processing.
2621

27-
.. currentmodule:: myoverse.datasets.filters.temporal
22+
.. currentmodule:: myoverse.transforms
2823
.. autosummary::
29-
:toctree: generated/filters
24+
:toctree: generated/transforms
3025
:template: class.rst
3126

32-
SOSFrequencyFilter
33-
RectifyFilter
34-
WindowedFunctionFilter
35-
RMSFilter
36-
VARFilter
37-
MAVFilter
38-
IAVFilter
39-
WFLFilter
40-
ZCFilter
41-
SSCFilter
42-
SpectralInterpolationFilter
43-
44-
45-
Spatial Filters
46-
---------------
47-
Spatial filters can be used to compute spatial features such as the Laplacian.
48-
49-
.. currentmodule:: myoverse.datasets.filters.spatial
27+
SlidingWindowTransform
28+
RMS
29+
MAV
30+
VAR
31+
Rectify
32+
Bandpass
33+
Highpass
34+
Lowpass
35+
Notch
36+
ZeroCrossings
37+
SlopeSignChanges
38+
WaveformLength
39+
Diff
40+
41+
Normalization
42+
-------------
43+
Normalization transforms for data preprocessing.
44+
45+
.. currentmodule:: myoverse.transforms
5046
.. autosummary::
51-
:toctree: generated/filters
47+
:toctree: generated/transforms
5248
:template: class.rst
5349

54-
DifferentialSpatialFilter
55-
ApplyFunctionSpatialFilter
50+
ZScore
51+
MinMax
52+
Normalize
53+
Standardize
54+
InstanceNorm
55+
LayerNorm
56+
BatchNorm
57+
ClampRange
5658

59+
Generic Operations
60+
------------------
61+
Generic array operations.
5762

58-
Base Filter Classes
59-
-------------------
60-
.. important:: If you wish to add a new filter make sure they inherit from the following base classes.
63+
.. currentmodule:: myoverse.transforms
64+
.. autosummary::
65+
:toctree: generated/transforms
66+
:template: class.rst
6167

62-
.. currentmodule:: myoverse.datasets.filters.generic
68+
Reshape
69+
Index
70+
Flatten
71+
Squeeze
72+
Unsqueeze
73+
Transpose
74+
Mean
75+
Sum
76+
Stack
77+
Concat
78+
Lambda
79+
Identity
80+
Repeat
81+
Pad
82+
83+
Augmentation
84+
------------
85+
Data augmentation transforms.
86+
87+
.. currentmodule:: myoverse.transforms
6388
.. autosummary::
64-
:toctree: generated/filters
89+
:toctree: generated/transforms
6590
:template: class.rst
6691

67-
FilterBaseClass
92+
GaussianNoise
93+
MagnitudeWarp
94+
TimeWarp
95+
Dropout
96+
ChannelShuffle
97+
TimeShift
98+
Scale
99+
Cutout
68100

69-
.. currentmodule:: myoverse.datasets.filters.spatial
101+
Spatial / Grid-Aware
102+
--------------------
103+
Spatial transforms for electrode grid processing.
104+
105+
.. currentmodule:: myoverse.transforms
70106
.. autosummary::
71-
:toctree: generated/filters
107+
:toctree: generated/transforms
72108
:template: class.rst
73109

74-
SpatialFilterGridAware
75-
110+
SpatialFilter
111+
NDD
112+
LSD
113+
TSD
114+
IB2

0 commit comments

Comments
 (0)