Skip to main content

EEG emotion recognition with CNN-Transformer encoders and three-stage hierarchical classifiers

Project description

DGLZ

EEG emotion recognition with CNN-Transformer encoders and three-stage hierarchical classifiers.

Overview

DGLZ is a Python toolkit for EEG-based emotion recognition. It combines convolutional neural network (CNN) feature extractors with Transformer encoders to model both local and global temporal patterns in EEG signals. A three-stage hierarchical classification pipeline progressively refines emotion predictions.

Key components:

  • Data processing -- EEG I/O, channel selection, band filtering, signal transforms, and index building.
  • Resampling -- Truncated-Gaussian and subject-state-aware resampling strategies for balanced training data.
  • Datasets -- PyTorch-style dataset classes for resampled, subject-state, normal-emotion, and depression-emotion data with configurable collation and splitting.
  • Models -- CNN blocks, Transformer blocks, token embeddings, and specialised encoder architectures for trial-level, subject-state, normal-emotion, and depression-emotion classification.
  • Training -- Loss functions, optimizers, schedulers, early stopping, checkpointing, and metric tracking.
  • Prediction -- Post-processing, prediction aggregation, three-stage inference pipeline, and submission formatting.
  • CLI -- A unified eemo command-line interface built on Typer.

Installation

Requires Python 3.13 or later.

# Clone the repository
git clone https://github.com/SuShuHeng/DGLZ.git
cd DGLZ

# Install in editable (development) mode
pip install -e .

# Or with all optional dependencies (test + packaging tools)
pip install -e ".[all]"

CLI Usage

After installation the eemo command is available:

# Show available commands
eemo --help

# Prepare raw EEG data for processing
eemo prepare --help

# Resample datasets for balanced training
eemo resample --help

# Train a model
eemo train --help

# Run the three-stage hierarchical inference pipeline
eemo infer-three-stage --help

# Run predictions with a trained model
eemo pred --help

# Display the current version
eemo version

# Manage configuration files
eemo config --help

# Run experiment training sweeps
eemo exp-train --help

# Run experiment prediction sweeps
eemo exp-pred --help

# Manage model checkpoints
eemo ckpt --help

Project Structure

DGLZ/
├── pyproject.toml          # Package metadata and build configuration
├── README.md               # This file
├── .python-version         # Python version pin (3.13)
├── configs/                # Configuration files
├── docs/                   # Documentation
├── src/
│   └── eemoclas/           # Main package
│       ├── __init__.py
│       ├── __version__.py
│       ├── cli/            # Command-line interface
│       │   └── main.py     # Entry point (registers as `eemo`)
│       ├── data/           # EEG I/O, splitting, transforms
│       ├── datasets/       # PyTorch dataset classes
│       ├── model/          # CNN-Transformer architectures
│       ├── prediction/     # Inference and post-processing
│       ├── resampling/     # Data resampling strategies
│       ├── training/       # Training loop utilities
│       └── utils/          # Configuration, logging, metrics, paths
└── tests/                  # Test suite

Running Tests

pip install -e ".[test]"
pytest

License

Licensed under the Apache License 2.0.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dglz-0.1.12.post2.tar.gz (245.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dglz-0.1.12.post2-py3-none-any.whl (263.3 kB view details)

Uploaded Python 3

File details

Details for the file dglz-0.1.12.post2.tar.gz.

File metadata

  • Download URL: dglz-0.1.12.post2.tar.gz
  • Upload date:
  • Size: 245.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for dglz-0.1.12.post2.tar.gz
Algorithm Hash digest
SHA256 9c99647a50428803e349afb824cff7a0e027628a92d541fc1adab8d72e04e6ec
MD5 0304f5c5665646bfb2465d07e1ad3185
BLAKE2b-256 8d129be0d62a86d9bd7826d4b4e6246d8a214054a9de1e057698bd58b9b542ae

See more details on using hashes here.

File details

Details for the file dglz-0.1.12.post2-py3-none-any.whl.

File metadata

  • Download URL: dglz-0.1.12.post2-py3-none-any.whl
  • Upload date:
  • Size: 263.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for dglz-0.1.12.post2-py3-none-any.whl
Algorithm Hash digest
SHA256 df43e29053f33aaa7c7ed50cb9811fcf2ed028abb18f92a20e362589df7204bb
MD5 6f6da0e3e3b42eb6e739c1b9fde14456
BLAKE2b-256 d50fa34c30e884a0d5c859119e632a1a3991ed13fb93694975e2fa45ebd0fd77

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page