Metadata-Version: 2.1
Name: senselab
Version: 0.5.1
Summary: Senselab is a Python package that simplifies building pipelines for speech and voice analysis.
Home-page: https://github.com/sensein/senselab
License: Apache-2.0
Keywords: voice,speech,audio
Author: Fabio Catania
Author-email: fabiocat@mit.edu
Maintainer: Fabio Catania
Maintainer-email: fabiocat@mit.edu
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: accelerate (>=0.29.3,<0.30.0)
Requires-Dist: audiomentations (>=0.35.0,<0.36.0)
Requires-Dist: click (>=8.1.7,<9.0.0)
Requires-Dist: datasets (>=2.19.2,<3.0.0)
Requires-Dist: ffmpeg-python (>=0.2.0,<0.3.0)
Requires-Dist: huggingface-hub (>=0.23.3,<0.24.0)
Requires-Dist: ipykernel (>=6.29.4,<7.0.0)
Requires-Dist: jiwer (>=3.0.4,<4.0.0)
Requires-Dist: jsonschema (>=4.21.1,<5.0.0)
Requires-Dist: numpy (>=1.26,<2.0)
Requires-Dist: opensmile (>=2.5.0,<3.0.0)
Requires-Dist: praat-parselmouth (>=0.4.3,<0.5.0)
Requires-Dist: pyannote-audio (>=3.2.0,<4.0.0)
Requires-Dist: pyav (>=12.1.0,<13.0.0)
Requires-Dist: pycountry (>=24.6.1,<25.0.0)
Requires-Dist: pydantic (>=2.7.4,<3.0.0)
Requires-Dist: pydra (>=0.23,<0.24)
Requires-Dist: scikit-learn (>=1.5.0,<2.0.0)
Requires-Dist: sentence-transformers (>=2.7.0,<3.0.0)
Requires-Dist: speechbrain (>=1.0.0,<2.0.0)
Requires-Dist: torch (>=2.2.2,<3.0.0)
Requires-Dist: torch-audiomentations (>=0.11.1,<0.12.0)
Requires-Dist: torchaudio (>=2.2.2,<3.0.0)
Requires-Dist: torchvision (>=0.17.2,<0.18.0)
Requires-Dist: transformers (>=4.39.3,<5.0.0)
Requires-Dist: types-requests (>=2.32,<3.0)
Requires-Dist: umap-learn (>=0.5.6,<0.6.0)
Project-URL: Documentation, https://sensein.github.io/senselab
Project-URL: Repository, https://github.com/sensein/senselab
Description-Content-Type: text/markdown

# The ```senselab``` repo

[![Build](https://github.com/sensein/senselab/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/sensein/senselab/actions/workflows/test.yaml?query=branch%3Amain)
[![codecov](https://codecov.io/gh/sensein/senselab/graph/badge.svg?token=9S8WY128PO)](https://codecov.io/gh/sensein/senselab)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

[![PyPI](https://img.shields.io/pypi/v/senselab.svg)](https://pypi.org/project/senselab/)
[![Python Version](https://img.shields.io/pypi/pyversions/senselab)](https://pypi.org/project/senselab)
[![License](https://img.shields.io/pypi/l/senselab)](https://opensource.org/licenses/Apache-2.0)

[![pages](https://img.shields.io/badge/api-docs-blue)](https://sensein.github.io/senselab)

Welcome to the ```senselab``` repo! 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.

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

## Features
- **Modular design**: Utilize a variety of task-specific transformations that can be easily integrated or used standalone, allowing for flexible data manipulation and analysis strategies.

- **Pre-built pipelines**: Access pre-configured pipelines combining multiple transformations tailored for common analysis tasks, which help in reducing setup time and effort.

- **Reproducibility**: Ensures consistent outputs through the use of fixed seeds and version-controlled processing steps, making your results verifiable and easily comparable.

- **Easy integration**: Designed to fit into existing workflows with minimal configuration, `senselab` can be used alongside other data analysis tools and frameworks seamlessly.

- **Extensible**: Open to modifications and contributions, the package can be expanded with custom transformations and pipelines to meet specific research needs. <u>Do you want to contribute? Please, reach out!</u>

- **Comprehensive documentation**: Comes with detailed documentation for all features and modules, including examples and guides on how to extend the package for other types of behavioral data analysis.

- **Performance Optimized**: Efficiently processes large datasets with optimized code and algorithms, ensuring quick turnaround times even for complex analyses.

- **Interactive Examples**: Includes Jupyter notebooks that provide practical examples of how `senselab` can be implemented to derive insights from real-world data sets.

Whether you're researching speech disorders, analyzing customer service calls, or studying communication patterns, `senselab` provides the tools and flexibility needed to extract meaningful conclusions from your data.


## Installation
Install this package via:

```sh
pip install senselab
```

Or get the newest development version via:

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

## Quick start
```Python
from senselab.app import hello_world

hello_world()
```

## Contributing
Please see [CONTRIBUTING.md](CONTRIBUTING.md) before contributing.

## To do
Please see the [Project Board](https://github.com/orgs/sensein/projects/45).

