A lightweight library of Frechet Audio Distance calculation.
Project description
Frechet Audio Distance in PyTorch
A lightweight library of Frechet Audio Distance calculation.
Currently, we support embedding from:
VGGish
by S. Hershey et al.PANN
by Kong et al.CLAP
by Wu et al.
Installation
pip install frechet_audio_distance
Demo
from frechet_audio_distance import FrechetAudioDistance
# to use `vggish`
frechet = FrechetAudioDistance(
model_name="vggish",
use_pca=False,
use_activation=False,
verbose=False
)
# to use `PANN`
frechet = FrechetAudioDistance(
model_name="pann",
use_pca=False,
use_activation=False,
verbose=False
)
# to use `CLAP`
frechet = FrechetAudioDistance(
model_name="clap",
submodel_name="630k-audioset", # for CLAP only
verbose=False,
enable_fusion=False, # for CLAP only
)
fad_score = frechet.score("/path/to/background/set", "/path/to/eval/set", dtype="float32")
You can also have a look at this notebook for a better understanding of how each model is used.
Save pre-computed embeddings
When computing the Frechet Audio Distance, you can choose to save the embeddings for future use.
This capability not only ensures consistency across evaluations but can also significantly reduce computation time, especially if you're evaluating multiple times using the same dataset.
# Specify the paths to your saved embeddings
background_embds_path = "/path/to/saved/background/embeddings.npy"
eval_embds_path = "/path/to/saved/eval/embeddings.npy"
# Compute FAD score while reusing the saved embeddings (or saving new ones if paths are provided and embeddings don't exist yet)
fad_score = frechet.score(
"/path/to/background/set",
"/path/to/eval/set",
background_embds_path=background_embds_path,
eval_embds_path=eval_embds_path,
dtype="float32"
)
Result validation
Test 1: Distorted sine waves on vggish (as provided here) [notes]
FAD scores comparison w.r.t. to original implementation in google-research/frechet-audio-distance
baseline vs test1 | baseline vs test2 | |
---|---|---|
google-research |
12.4375 | 4.7680 |
frechet_audio_distance |
12.7398 | 4.9815 |
Test 2: Distorted sine waves on PANN
baseline vs test1 | baseline vs test2 | |
---|---|---|
frechet_audio_distance |
0.000465 | 0.00008594 |
To contribute
Contributions are welcomed! Kindly raise a PR and ensure that all CI checks are passed.
NOTE: For now, the CI only checks for vggish
as PANN
takes a long time to download.
References
VGGish in PyTorch: https://github.com/harritaylor/torchvggish
Frechet distance implementation: https://github.com/mseitzer/pytorch-fid
Frechet Audio Distance paper: https://arxiv.org/abs/1812.08466
PANN paper: https://arxiv.org/abs/1912.10211
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file frechet_audio_distance-0.2.0-py3-none-any.whl
.
File metadata
- Download URL: frechet_audio_distance-0.2.0-py3-none-any.whl
- Upload date:
- Size: 19.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b83546eb54ca67688e759daff5181cf8dc9888b6315f1fe1c17144008e65c0ce |
|
MD5 | ef7cb296873f7dda4325078e6116bf19 |
|
BLAKE2b-256 | 7012561110404543f6a1266d1181a2af22e6bff19748ea255fba87defbb4060f |