Metadata-Version: 2.1
Name: openl3
Version: 0.1.0rc5
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, 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/
Description: # OpenL3
        
        Open-source deep audio and image embeddings.
        
        [![PyPI](https://img.shields.io/badge/python-2.7%2C%203.5%2C%203.6-blue.svg)]()
        [![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://choosealicense.com/licenses/mit/)
        [![Build Status](https://travis-ci.org/marl/openl3.svg?branch=master)](https://travis-ci.org/marl/openl3)
        [![Coverage Status](https://coveralls.io/repos/github/marl/openl3/badge.svg?branch=master)](https://coveralls.io/github/marl/openl3?branch=master)
        [![Documentation Status](https://readthedocs.org/projects/openl3/badge/?version=latest)](http://openl3.readthedocs.io/en/latest/?badge=latest)
        
        Please refer to the [documentation](https://openl3.readthedocs.io/en/latest/) for detailed instructions and examples.
        
        For details about the embedding models and how they were trained, please see:
        
        Look, Listen, and Learn More: Design Choices for Deep Audio Embeddings<br/>
        Jason Cramer, Ho-Hsiang Wu, Justin Salamon and Juan Pablo Bello<br/>
        Under review, 2018.
        
        # 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 # CPU-only version
            pip install tensorflow-gpu # GPU version
        
        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
        ``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
        
        For more detailed information, please consult the
        [`pysoundfile` installation documentation](https://pysoundfile.readthedocs.io/en/0.9.0/#installation>).
        
        
        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).
        
        
Keywords: deep audio embeddings machine listening learning tensorflow keras
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
Provides-Extra: docs
Provides-Extra: tests
