Skip to main content

A Python package providing a common interface for running machine learning models for audio classification tasks.

Project description

audioclass

A Python library that simplifies the process of using machine learning models for audio classification.

Description

Audioclass provides a unified interface for working with various audio classification models, making it easier to load, preprocess, batch process, and analyze audio data. It offers:

  • Standardized Model Interface: Easily swap between different model implementations (TensorFlow, TensorFlow Lite, etc.) without changing your code.
  • Flexible Data Loading: Load audio data from files, directories, or pandas DataFrames with a few simple commands.
  • Efficient Batch Processing: Effortlessly process large datasets in batches for faster inference.
  • Unified Postprocessing: Convert model outputs into easy-to-use formats like xarray datasets or soundevent objects.
  • Pre-trained Models: Get started quickly with built-in support for popular models like BirdNET and Perch.

Installation

Get started with audioclass in a snap:

pip install audioclass

Optional Dependencies:

  • For BirdNET: Install additional dependencies using pip install "audioclass[birdnet]".
  • For Perch: Install additional dependencies using pip install "audioclass[perch]".

How to Use It

Here's a quick example of how to load the BirdNET model, preprocess an audio file, and get predictions:

from audioclass.models.birdnet import BirdNET

# Load the model
model = BirdNET.load()

# Get predictions
predictions = model.process_file("path/to/audio/file.wav")

print(predictions)

For more detailed examples, tutorials, and complete API documentation, visit our documentation website.

Contributing

We welcome contributions to audioclass! If you'd like to get involved, please check out our Contributing Guidelines.

Attribution

  • The BirdNET model was developed by the K. Lisa Yang Center for Conservation Bioacoustics at the Cornell Lab of Ornithology, in collaboration with Chemnitz University of Technology. This package is not affiliated with the BirdNET project. If you use the BirdNET model, please cite the relevant paper (see the audioclass.models.birdnet module docstring for details).

  • The Perch model is a research product by Google Research. This package is not affiliated with Google Research.

Audioclass is an independent project and is not affiliated with either the BirdNET or Perch projects.

Project details


Download files

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

Source Distribution

audioclass-0.1.1.tar.gz (70.8 kB view details)

Uploaded Source

Built Distribution

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

audioclass-0.1.1-py3-none-any.whl (61.7 kB view details)

Uploaded Python 3

File details

Details for the file audioclass-0.1.1.tar.gz.

File metadata

  • Download URL: audioclass-0.1.1.tar.gz
  • Upload date:
  • Size: 70.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.19

File hashes

Hashes for audioclass-0.1.1.tar.gz
Algorithm Hash digest
SHA256 f5e28b4b64496ee9b4f04659dcf55b9d9d48526caffc2bd59f3d9e3df6ef89ab
MD5 600b5887c906dad870d38ff126a3d050
BLAKE2b-256 b4df0fbd2e2cf327fe46d852552f8e47d09922199f050aff974e5c542f36e3b0

See more details on using hashes here.

File details

Details for the file audioclass-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: audioclass-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 61.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.19

File hashes

Hashes for audioclass-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5caa960d025cd58739cb9ba84e837f50be7b905bdf6a8c9b77ef295f7c955ec1
MD5 6560bbbe36c2f53bc904d1c3a8df39a4
BLAKE2b-256 4cc9c5a58631dde69db9dce34b6c39ae115c2473ad954979326ebbc35cf20d17

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