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.24.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: shira_audio-0.1.24.tar.gz
  • Upload date:
  • Size: 14.6 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.24.tar.gz
Algorithm Hash digest
SHA256 6a7437b67cc66327ec06858a33b8fb67bd2fb3cb48da75a5198c65a06ae134d8
MD5 eac4dd3346726a964177a883134e1db9
BLAKE2b-256 406b02558ef76d99cc346744006a39fc63456fd26e8528a1fce9c36e2d18a463

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shira_audio-0.1.24-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.24-py3-none-any.whl
Algorithm Hash digest
SHA256 d4ea3b5dc05643399dfd7f684c9bb41df61bcb93057fa2f0142f70266a558d7d
MD5 9a16c6ba47f50b0311ade9f34808be59
BLAKE2b-256 8d1ca7e5ef77e13b2af8d1cc202988e223277e3a3e17ac1af14df80507159b7a

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