Skip to main content

audio search/retrieval library

Project description

shira 🔖🎧

A simple audio search/retrieval library. (wip)

This is the audio version of ripple. Search through audio files/data with text queries or audio samples.
It's meant to be an neural encoded version of Shazam, but might just be for small scale/local usage.

Methodology

It's basically a semantic search library for audio.

The local audio data/files are indexed and embeddings are generated(with CLAP), then a FAISS vector index is created.
The files are retrieved based on cosine similarity between embeddings. (it could also be adapted for audio recommendation).

This process makes use of contrastively pretrained audio-language model, CLAP(like OpenAI CLIP for audio), specifically LAION's laion/larger_clap_music_and_speech checkpoint/model

usage

  • Install the library
pip install shira-audio
  • For text-based search
from shira import AudioSearch, AudioEmbedding

embedder = AudioEmbedding(data_path='.') # init embedder class
audio_data_embeds = embedder.index_files() # create embeddings and index audio files

neural_search = AudioSearch() # init semantic search class

text_query = 'classical music' # text description for search

# get k similar audio w/probability score pairs 
matching_samples, scores = neural_search.text_search(text_query, audio_data_embeds, k_count=5)

matching_samples[0]['audio']['path'] # get file path for the top sample

Or you could use it from your terminal:

# -t for text query 
# --dir for [optional] target directory 
shira_text -t classical --dir downloads/music

Acknowldgements

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

shira_audio-0.1.25.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

shira_audio-0.1.25-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

Details for the file shira_audio-0.1.25.tar.gz.

File metadata

  • Download URL: shira_audio-0.1.25.tar.gz
  • Upload date:
  • Size: 14.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for shira_audio-0.1.25.tar.gz
Algorithm Hash digest
SHA256 629945f5cf8402ea76360ed1c02587650a91cabad03f7127daebfbb071f588b6
MD5 ffd144756421e8609cfa607b126481f5
BLAKE2b-256 e5178f8f88f2413050aa09037a46b77eb48a5d5a50f0e0cf57f92be47a937381

See more details on using hashes here.

File details

Details for the file shira_audio-0.1.25-py3-none-any.whl.

File metadata

  • Download URL: shira_audio-0.1.25-py3-none-any.whl
  • Upload date:
  • Size: 15.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for shira_audio-0.1.25-py3-none-any.whl
Algorithm Hash digest
SHA256 2975504f4ee4c2edd6ea88f30a6649ceb6bdc831e4db8325a65a0c8bdf3cbd26
MD5 ad4474a01551e29adf4a5b805d0c7a64
BLAKE2b-256 ef7784ac3c841a42f88f6c4498184a0a7d3e46dcb9762764f5fd67b9f5775610

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page