From bec3508ddba77b70ba8d2cfe2b5e482a60b3aa05 Mon Sep 17 00:00:00 2001 From: Bea Steers Date: Wed, 9 Jun 2021 11:41:48 -0400 Subject: [PATCH 1/2] update tensorflow 2 install message --- README.md | 38 +++++++++++++++++++++++--------------- 1 file changed, 23 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index ffa4ffa..a93ace8 100644 --- a/README.md +++ b/README.md @@ -10,31 +10,19 @@ OpenL3 is an open-source Python library for computing deep audio and image embed 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 ------------ -#### Tensorflow -Because Tensorflow 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: - - pip install "tensorflow<1.14" # CPU-only version - pip install "tensorflow-gpu<1.14" # GPU version - - -**Please note that Tensorflow 2.x is not yet supported. Ensure that an earlier version of Tensorflow is installed.** If you run into further issues with installation, a known working dependency combination is Tensorflow 1.13, Keras 2.0, and Kapre 0.1.4. - -For more detailed information, please consult the -[Tensorflow installation documentation](https://www.tensorflow.org/install/). - #### libsndfile OpenL3 depends on the `pysoundfile` module to load audio files, which depends on the non-Python library @@ -52,6 +40,26 @@ 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 From bf84faa84086a65091c495270e2e9e60f64777ff Mon Sep 17 00:00:00 2001 From: Bea Steers Date: Wed, 9 Jun 2021 11:43:01 -0400 Subject: [PATCH 2/2] fix version number typo (confused it with kapre) --- docs/installation.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index 00515ff..baed98a 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -26,9 +26,9 @@ 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.4'``. +If you are interested in using Tensorflow 1.x, please install using ``pip install 'openl3<=0.3.1'``. -Tensorflow 1x & OpenL3 <= v0.3.4 +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.