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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: shira_audio-0.1.12.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.12.tar.gz
Algorithm Hash digest
SHA256 2c9da5547191e7553defa5b65dc7940a505635db679638fdea5b8831f7246b52
MD5 4f017b7d69b4850a871d9fff2d8dc323
BLAKE2b-256 d03b503d8c9491e1cc6ef850b877f9ff3b2ce47b351aa49de3a70fcdaa7563d9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shira_audio-0.1.12-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.12-py3-none-any.whl
Algorithm Hash digest
SHA256 a92ff420ab6b4a352ccd69e899cfbe43f7c500a89777a112c6254a5814e46524
MD5 560f16cf72ad67db6ad8773fc3598cc5
BLAKE2b-256 058d17bcd911cf69fdf178b0d4286d36f23f48b64946f9b98aa3d56c2cf0c4bf

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