Welcome to senselab! This is a Python package for streamlining the processing and analysis of behavioral data, such as voice and speech patterns, with robust and reproducible methodologies.

Why should I use senselab?

• Modular Design: Easily integrate or use standalone transformations for flexible data manipulation.
• Pre-built Pipelines: Access pre-configured pipelines to reduce setup time and effort.
• Reproducibility: Ensure consistent and verifiable results with fixed seeds and version-controlled steps.
• Easy Integration: Seamlessly fit into existing workflows with minimal configuration.
• Extensible: Modify and contribute custom transformations and pipelines to meet specific research needs.
• Comprehensive Documentation: Detailed guides, examples, and documentation for all features and modules.
• Performance Optimized: Efficiently process large datasets with optimized code and algorithms.
• Interactive Examples: Jupyter notebooks provide practical examples for deriving insights from real-world datasets.

Caution:: this package is still under development and may change rapidly over the next few weeks.

⚠️ System Requirements

If on macOS, this package requires an ARM64 architecture due to PyTorch 2.2.2+ dropping support for x86-64 on macOS.

❌ Unsupported systems include:

• macOS (Intel x86-64)
• Other platforms where dependencies are unavailable

To check your system compatibility, please run this command:

python -c "import platform; print(platform.machine())"

If the output is:

• arm64 → ✅ Your system is compatible.
• x86_64 → ❌ Your system is not supported.

If you attempt to install this package on an unsupported system, the installation or execution will fail.

Installation

Install this package via:

pip install senselab['all']

Or get the newest development version via:

pip install git+https://github.com/sensein/senselab.git

If you want to install only audio dependencies, you do:

pip install senselab['audio']

To install video and text extras, please do:

pip install senselab['video,text']

Quick start

from senselab.audio.data_structures import Audio
from senselab.audio.tasks.preprocessing import resample_audios

audio1 = Audio.from_filepath('path_to_audio_file.wav')

print("The original audio has a sampling rate of {} Hz.".format(audio1.sampling_rate))
[audio1] = resample_audios([audio1], resample_rate=16000)
print("The resampled audio has a sampling rate of {} Hz.".format(audio1.sampling_rate))

For more detailed information, check out our Getting Started Tutorial.

Contributing

We welcome contributions from the community! Before getting started, please review our CONTRIBUTING.md.

Acknowledgments

senselab is mostly supported by the following organizations and initiatives:

• McGovern Institute ICON Fellowship
• NIH Bridge2AI Precision Public Health (OT2OD032720)
• Child Mind Institute
• ReadNet Project
• Chris and Lann Woehrle Psychiatric Fund