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.

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

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

Uploaded Source

Built Distribution

shira_audio-0.1.1-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shira_audio-0.1.1.tar.gz
  • Upload date:
  • Size: 14.5 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.1.tar.gz
Algorithm Hash digest
SHA256 269609b6035c36dad5d3ff90a859dee0a8bba3a6f58f7a9bfacab4405158011f
MD5 cda4741e9a62a79391593592f07bf789
BLAKE2b-256 a5423177d84154b2994f1f02638e49ea5d3ba62245c0bfdde243b8696ece0ef6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shira_audio-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 14.9 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 847bc8aa332ac9ed04e18041cb42d890fbfc71535c38cdf131a94be231920559
MD5 dc04a202cbc67f7b592d22702dc6154b
BLAKE2b-256 9874df6889161dd137014eb8f355bc61590b52238984e02bb989b177a0996093

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