Metadata-Version: 2.4
Name: openl3
Version: 0.4.1
Summary: Deep audio and image embeddings, based on Look, Listen, and Learn approach
Home-page: https://github.com/marl/openl3
Author: Jason Cramer, Ho-Hsiang Wu, Bea Steers, and Justin Salamon
Author-email: jtcramer@nyu.edu
License: MIT
Project-URL: Source, https://github.com/marl/openl3
Project-URL: Tracker, https://github.com/marl/openl3/issues
Project-URL: Documentation, https://readthedocs.org/projects/openl3/
Keywords: deep audio embeddings machine listening learning tensorflow keras
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
Requires-Dist: tensorflow>=2.0.0
Requires-Dist: numpy>=1.20.0
Requires-Dist: scipy>=1.7.0
Requires-Dist: kapre>=0.3.5
Requires-Dist: soundfile>=0.10.0
Requires-Dist: resampy>=0.2.1
Requires-Dist: h5py>=3.0.0
Requires-Dist: moviepy>=1.0.0
Requires-Dist: scikit-image>=0.14.3
Requires-Dist: librosa>=0.9.0
Provides-Extra: docs
Requires-Dist: sphinx==1.2.3; extra == "docs"
Requires-Dist: sphinxcontrib-napoleon; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: numpydoc; extra == "docs"
Provides-Extra: tests
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: summary
# OpenL3
OpenL3 is an open-source Python library for computing deep audio and image embeddings.
[](https://pypi.python.org/pypi/openl3)
[](https://choosealicense.com/licenses/mit/)
[](https://travis-ci.org/marl/openl3)
[](https://coveralls.io/github/marl/openl3?branch=master)
[](http://openl3.readthedocs.io/en/latest/?badge=latest)
Please refer to the [documentation](https://openl3.readthedocs.io/en/latest/) for detailed instructions and examples.
> **UPDATE:** Openl3 now has Tensorflow 2 support!
The audio and image embedding models provided here are published as part of [1], and are based on the Look, Listen and Learn approach [2]. For details about the embedding models and how they were trained, please see:
[Look, Listen and Learn More: Design Choices for Deep Audio Embeddings](http://www.justinsalamon.com/uploads/4/3/9/4/4394963/cramer_looklistenlearnmore_icassp_2019.pdf)
Jason Cramer, Ho-Hsiang Wu, Justin Salamon, and Juan Pablo Bello.
IEEE Int. Conf. on Acoustics, Speech and Signal Processing (ICASSP), pages 3852–3856, Brighton, UK, May 2019.
# Installing OpenL3
Dependencies
------------
#### libsndfile
OpenL3 depends on the `pysoundfile` module to load audio files, which depends on the non-Python library
``libsndfile``. On Windows and macOS, these will be installed via ``pip`` and you can therefore skip this step.
However, on Linux this must be installed manually via your platform's package manager.
For Debian-based distributions (such as Ubuntu), this can be done by simply running
apt-get install libsndfile1
Alternatively, if you are using `conda`, you can install `libsndfile` simply by running
conda install -c conda-forge libsndfile
For more detailed information, please consult the
[`pysoundfile` installation documentation](https://pysoundfile.readthedocs.io/en/0.9.0/#installation>).
#### Tensorflow
Starting with `openl3>=0.4.0`, Openl3 has been upgraded to use Tensorflow 2. Because Tensorflow 2 and higher now includes GPU support, `tensorflow>=2.0.0` is included as a dependency and no longer needs to be installed separately.
If you are interested in using Tensorflow 1.x, please install using `pip install 'openl3<=0.3.1'`.
##### Tensorflow 1x & OpenL3 <= v0.3.1
Because Tensorflow 1.x comes in CPU-only and GPU variants, we leave it up to the user to install the version that best fits
their usecase.
On most platforms, either of the following commands should properly install Tensorflow:
```bash
pip install "tensorflow<1.14" # CPU-only version
pip install "tensorflow-gpu<1.14" # GPU version
```
For more detailed information, please consult the
[Tensorflow installation documentation](https://www.tensorflow.org/install/).
Installing OpenL3
-----------------
The simplest way to install OpenL3 is by using ``pip``, which will also install the additional required dependencies
if needed. To install OpenL3 using ``pip``, simply run
pip install openl3
To install the latest version of OpenL3 from source:
1. Clone or pull the lastest version:
git clone git@github.com:marl/openl3.git
2. Install using pip to handle python dependencies:
cd openl3
pip install -e .
# Using OpenL3
To help you get started with OpenL3 please see the
[tutorial](http://openl3.readthedocs.io/en/latest/tutorial.html).
# Acknowledging OpenL3
Please cite the following papers when using OpenL3 in your work:
[1] [Look, Listen and Learn More: Design Choices for Deep Audio Embeddings](http://www.justinsalamon.com/uploads/4/3/9/4/4394963/cramer\_looklistenlearnmore\_icassp\_2019.pdf)
Jason Cramer, Ho-Hsiang Wu, Justin Salamon, and Juan Pablo Bello.
IEEE Int. Conf. on Acoustics, Speech and Signal Processing (ICASSP), pages 3852–3856, Brighton, UK, May 2019.
[2] [Look, Listen and Learn](http://openaccess.thecvf.com/content\_ICCV\_2017/papers/Arandjelovic\_Look\_Listen\_and\_ICCV\_2017\_paper.pdf)
Relja Arandjelović and Andrew Zisserman
IEEE International Conference on Computer Vision (ICCV), Venice, Italy, Oct. 2017.