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.2.0.tar.gz (48.2 MB view details)

Uploaded Source

Built Distribution

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

audioclass-0.2.0-py3-none-any.whl (48.3 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for audioclass-0.2.0.tar.gz
Algorithm Hash digest
SHA256 8628ae2d08f396a4b5b8c7cba461195f948c5a123c57c4b1625d83f6f424bfae
MD5 6a3d66741b7e448d2d588a29784ca5c1
BLAKE2b-256 866c9202b3ffdd8f6bb0915b99d1ea782fd3990957fcf97ea0a7234bc0cb6631

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for audioclass-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2d4ed97655c83ba0df13147115becc7d23313729c5dd76c96d541974f25ddfe2
MD5 9775b19595935d337c754d9fc705c585
BLAKE2b-256 0f79b032175571295ff29b9363e281e4a1eb3686b0f323d633939eaee7ea155f

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