eegdash 0.0.9__tar.gz → 0.1.0__tar.gz

{eegdash-0.0.9/src/eegdash.egg-info → eegdash-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eegdash
-Version: 0.0.9
+Version: 0.1.0
 Summary: EEG data for machine learning
 Author-email: Young Truong <dt.young112@gmail.com>, Arnaud Delorme <adelorme@gmail.com>
 License: GNU General Public License
@@ -24,29 +24,27 @@ License: GNU General Public License
         along with this program; if not, write to the Free Software
         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1.07  USA
         
-Project-URL: Homepage, https://eegdash.org
-Project-URL: Issues, https://github.com/sccn/EEGDash/issues
+Project-URL: Homepage, https://github.com/sccn/EEG-Dash-Data
+Project-URL: Issues, https://github.com/sccn/EEG-Dash-Data/issues
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
+Requires-Python: >3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: xarray
-Requires-Dist: python-dotenv
-Requires-Dist: s3fs
-Requires-Dist: mne
-Requires-Dist: pynwb
-Requires-Dist: h5py
-Requires-Dist: pymongo
-Requires-Dist: joblib
 Requires-Dist: braindecode
-Requires-Dist: mne-bids
+Requires-Dist: mne_bids
+Requires-Dist: numba
+Requires-Dist: numpy
+Requires-Dist: pandas
 Requires-Dist: pybids
-Requires-Dist: pymatreader
-Requires-Dist: pyarrow
+Requires-Dist: pymongo
+Requires-Dist: python-dotenv
+Requires-Dist: s3fs
+Requires-Dist: scipy
 Requires-Dist: tqdm
-Requires-Dist: numba
+Requires-Dist: xarray
+Requires-Dist: pre-commit
 Dynamic: license-file
 
 # EEG-Dash
@@ -90,7 +88,10 @@ To use the data from a single subject, enter:
 
 ```python
 from eegdash import EEGDashDataset
-ds_NDARDB033FW5 = EEGDashDataset({'dataset': 'ds005514', 'task': 'RestingState', 'subject': 'NDARDB033FW5'})
+
+ds_NDARDB033FW5 = EEGDashDataset(
+    {"dataset": "ds005514", "task": "RestingState", "subject": "NDARDB033FW5"}
+)
 ```
 
 This will search and download the metadata for the task **RestingState** for subject **NDARDB033FW5** in BIDS dataset **ds005514**. The actual data will not be downloaded at this stage. Following standard practice, data is only downloaded once it is processed. The **ds_NDARDB033FW5** object is a fully functional BrainDecode dataset, which is itself a PyTorch dataset. This [tutorial](https://github.com/sccn/EEGDash/blob/develop/notebooks/tutorial_eoec.ipynb) shows how to preprocess the EEG data, extracting portions of the data containing eyes-open and eyes-closed segments, then perform eyes-open vs. eyes-closed classification using a (shallow) deep-learning model. 
@@ -99,7 +100,10 @@ To use the data from multiple subjects, enter:
 
 ```python
 from eegdash import EEGDashDataset
-ds_ds005505rest = EEGDashDataset({'dataset': 'ds005505', 'task': 'RestingState'}, target_name='sex')
+
+ds_ds005505rest = EEGDashDataset(
+    {"dataset": "ds005505", "task": "RestingState"}, target_name="sex"
+)
 ```
 
 This will search and download the metadata for the task 'RestingState' for all subjects in BIDS dataset 'ds005505' (a total of 136). As above, the actual data will not be downloaded at this stage so this command is quick to execute. Also, the target class for each subject is assigned using the target_name parameter. This means that this object is ready to be directly fed to a deep learning model, although the [tutorial script](https://github.com/sccn/EEGDash/blob/develop/notebooks/tutorial_sex_classification.ipynb) performs minimal processing on it, prior to training a deep-learning model. Because 14 gigabytes of data are downloaded, this tutorial takes about 10 minutes to execute.

{eegdash-0.0.9 → eegdash-0.1.0}/README.md

@@ -39,7 +39,10 @@ To use the data from a single subject, enter:
 
 ```python
 from eegdash import EEGDashDataset
-ds_NDARDB033FW5 = EEGDashDataset({'dataset': 'ds005514', 'task': 'RestingState', 'subject': 'NDARDB033FW5'})
+
+ds_NDARDB033FW5 = EEGDashDataset(
+    {"dataset": "ds005514", "task": "RestingState", "subject": "NDARDB033FW5"}
+)
 ```
 
 This will search and download the metadata for the task **RestingState** for subject **NDARDB033FW5** in BIDS dataset **ds005514**. The actual data will not be downloaded at this stage. Following standard practice, data is only downloaded once it is processed. The **ds_NDARDB033FW5** object is a fully functional BrainDecode dataset, which is itself a PyTorch dataset. This [tutorial](https://github.com/sccn/EEGDash/blob/develop/notebooks/tutorial_eoec.ipynb) shows how to preprocess the EEG data, extracting portions of the data containing eyes-open and eyes-closed segments, then perform eyes-open vs. eyes-closed classification using a (shallow) deep-learning model. 
@@ -48,7 +51,10 @@ To use the data from multiple subjects, enter:
 
 ```python
 from eegdash import EEGDashDataset
-ds_ds005505rest = EEGDashDataset({'dataset': 'ds005505', 'task': 'RestingState'}, target_name='sex')
+
+ds_ds005505rest = EEGDashDataset(
+    {"dataset": "ds005505", "task": "RestingState"}, target_name="sex"
+)
 ```
 
 This will search and download the metadata for the task 'RestingState' for all subjects in BIDS dataset 'ds005505' (a total of 136). As above, the actual data will not be downloaded at this stage so this command is quick to execute. Also, the target class for each subject is assigned using the target_name parameter. This means that this object is ready to be directly fed to a deep learning model, although the [tutorial script](https://github.com/sccn/EEGDash/blob/develop/notebooks/tutorial_sex_classification.ipynb) performs minimal processing on it, prior to training a deep-learning model. Because 14 gigabytes of data are downloaded, this tutorial takes about 10 minutes to execute.

eegdash-0.1.0/eegdash/__init__.py

@@ -0,0 +1,4 @@
+from .main import EEGDash, EEGDashDataset
+
+__all__ = ["EEGDash", "EEGDashDataset"]
+__version__ = "0.1.0"

eegdash-0.1.0/eegdash/data_config.py

@@ -0,0 +1,28 @@
+config = {
+    "required_fields": ["data_name"],
+    "attributes": {
+        "data_name": "str",
+        "dataset": "str",
+        "bidspath": "str",
+        "subject": "str",
+        "task": "str",
+        "session": "str",
+        "run": "str",
+        "sampling_frequency": "float",
+        "modality": "str",
+        "nchans": "int",
+        "ntimes": "int",
+    },
+    "description_fields": ["subject", "session", "run", "task", "age", "gender", "sex"],
+    "bids_dependencies_files": [
+        "dataset_description.json",
+        "participants.tsv",
+        "events.tsv",
+        "events.json",
+        "eeg.json",
+        "electrodes.tsv",
+        "channels.tsv",
+        "coordsystem.json",
+    ],
+    "accepted_query_fields": ["data_name", "dataset"],
+}