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

Or you could use it from your terminal like:

# -t for text query and --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.23.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

shira_audio-0.1.23-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shira_audio-0.1.23.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.23.tar.gz
Algorithm Hash digest
SHA256 fc398b3639647214aae9c921a71b95d539e1ec9aad29e6be9a7fcc3a2e6efc0f
MD5 ba5485dab683d02818c3a905bf1a1c70
BLAKE2b-256 71095a32056c79b62d7c78ea1cd1b117350c1c57e93ffffe86884b994aedcea6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shira_audio-0.1.23-py3-none-any.whl
  • Upload date:
  • Size: 15.1 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.23-py3-none-any.whl
Algorithm Hash digest
SHA256 2f45e9b88c6afc034dcee524cb4c959053f4fbf398c149a73d8ade47554df4c2
MD5 dc2a93c158cc7a0b6115e82c5f0e28c8
BLAKE2b-256 2f26ed41cea5f5c835da4241f1d921a05d62eb9ad906b67a2c4fc87d1d63e3b4

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