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.3.tar.gz (71.1 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.3-py3-none-any.whl (61.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: audioclass-0.1.3.tar.gz
  • Upload date:
  • Size: 71.1 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.3.tar.gz
Algorithm Hash digest
SHA256 acc7778959a01ec0ba0b0199c00ae78a9e18dae43048615581d30af7db389ca0
MD5 5934b4901a4d0230e2a043e9ce3636f0
BLAKE2b-256 1907ea78234b6dc8d0258508c90b184447e5a315fac4b471f19efa5b38b2392d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: audioclass-0.1.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1d0d8347f42105b9325868d4d02a6c734650e119e9d48974f07c23a03f9bd8a3
MD5 72ad0ec7406e509ebe726f051557690b
BLAKE2b-256 80bc4a03b62d0e4f5c1e7976362eda20d3806576d36cdfaf96f93ea0b3d388ba

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