Metadata-Version: 2.1
Name: luminoth
Version: 0.2.2
Summary: Computer vision toolkit based on TensorFlow
Home-page: https://luminoth.ai
Author: Tryolabs
Author-email: luminoth@tryolabs.com
Maintainer: Tryolabs
Maintainer-email: luminoth@tryolabs.com
License: BSD 3-Clause License
Description: [![Luminoth](https://user-images.githubusercontent.com/270983/31414425-c12314d2-ae15-11e7-8cc9-42d330b03310.png)](https://luminoth.ai)
        ========
        
        [![Build Status](https://travis-ci.org/tryolabs/luminoth.svg?branch=master)](https://travis-ci.org/tryolabs/luminoth)
        [![Documentation Status](https://readthedocs.org/projects/luminoth/badge/?version=latest)](http://luminoth.readthedocs.io/en/latest/?badge=latest)
        [![codecov](https://codecov.io/gh/tryolabs/luminoth/branch/master/graph/badge.svg)](https://codecov.io/gh/tryolabs/luminoth)
        [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
        
        Luminoth is an open source toolkit for **computer vision**. Currently, we support object detection, but we are aiming for much more. It is built in Python, using [TensorFlow](https://www.tensorflow.org/) and [Sonnet](https://github.com/deepmind/sonnet).
        
        Read the full documentation [here](http://luminoth.readthedocs.io/).
        
        ![Example of Object Detection with Faster R-CNN](https://user-images.githubusercontent.com/1590959/36434494-e509be42-163d-11e8-99c1-d1aa728929ec.jpg)
        
        > **DISCLAIMER**: Luminoth is still alpha-quality release, which means the internal and external interfaces (such as command line) are very likely to change as the codebase matures.
        
        # Installation
        
        Luminoth currently supports Python 2.7 and 3.4–3.6.
        
        ## Pre-requisites
        
        To use Luminoth, [TensorFlow](https://www.tensorflow.org/install/) must be installed beforehand. If you want **GPU support**, you should install the GPU version of TensorFlow with `pip install tensorflow-gpu`, or else you can use the CPU version using `pip install tensorflow`.
        
        ## Installing Luminoth
        
        Just install from PyPI:
        
        ```bash
        pip install luminoth
        ```
        
        Optionally, Luminoth can also install TensorFlow for you if you install it with `pip install luminoth[tf]` or `pip install luminoth[tf-gpu]`, depending on the version of TensorFlow you wish to use.
        
        ### Google Cloud
        
        If you wish to train using **Google Cloud ML Engine**, the optional dependencies must be installed:
        
        ```bash
        pip install luminoth[gcloud]
        ```
        
        ## Installing from source
        
        First, clone the repo on your machine and then install with `pip`:
        
        ```bash
        git clone https://github.com/tryolabs/luminoth.git
        cd luminoth
        pip install -e .
        ```
        
        ## Check that the installation worked
        
        Simply run `lumi --help`.
        
        # Supported models
        
        Currently, we support the following models:
        
        * **Object Detection**
          * [Faster R-CNN](https://arxiv.org/abs/1506.01497)
          * [SSD](https://arxiv.org/abs/1512.02325)
        
        We are planning on adding support for more models in the near future, such as [RetinaNet](https://arxiv.org/abs/1708.02002) and [Mask R-CNN](https://arxiv.org/abs/1703.06870).
        
        We also provide **pre-trained checkpoints** for the above models trained on popular datasets such as [COCO](http://cocodataset.org/) and [Pascal](http://host.robots.ox.ac.uk/pascal/VOC/).
        
        # Usage
        
        There is one main command line interface which you can use with the `lumi` command. Whenever you are confused on how you are supposed to do something just type:
        
        `lumi --help` or `lumi <subcommand> --help`
        
        and a list of available options with descriptions will show up.
        
        ## Working with datasets
        
        See [Adapting a dataset](http://luminoth.readthedocs.io/en/latest/usage/dataset.html).
        
        ## Training
        
        See [Training your own model](http://luminoth.readthedocs.io/en/latest/usage/training.html) to learn how to train locally or in Google Cloud.
        
        ## Visualizing results
        
        We strive to get useful and understandable summary and graph visualizations. We consider them to be essential not only for monitoring (duh!), but for getting a broader understanding of what's going under the hood. The same way it is important for code to be understandable and easy to follow, the computation graph should be as well.
        
        By default summary and graph logs are saved to `jobs/` under the current directory. You can use TensorBoard by running:
        
        ```bash
        tensorboard --logdir path/to/jobs
        ```
        
        ## Why the name?
        
        > The Dark Visor is a Visor upgrade in Metroid Prime 2: Echoes. Designed by the **Luminoth** during the war, it was used by the Champion of Aether, A-Kul, to penetrate Dark Aether's haze in battle against the Ing.
        >
        > -- [Dark Visor - Wikitroid](http://metroid.wikia.com/wiki/Dark_Visor)
        >
        
        # License
        
        Copyright © 2018, [Tryolabs](https://tryolabs.com).
        Released under the [BSD 3-Clause](LICENSE).
        
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: BSD License
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*
Provides-Extra: tf-gpu
Provides-Extra: tf
Provides-Extra: gcloud
