Package: luminoth
[![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 forcomputer 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.# InstallationLuminoth currently supports Python 2.7 and 3.4–3.6.## Pre-requisitesTo use Luminoth, [TensorFlow](https://www.tensorflow.org/install/) must be installed beforehand. If you wantGPU support, you should install the GPU version of TensorFlow withpip install tensorflow-gpu, or else you can use the CPU version usingpip install tensorflow.## Installing LuminothJust install from PyPI:`bash pip install luminoth `Optionally, Luminoth can also install TensorFlow for you if you install it withpip install luminoth[tf]orpip install luminoth[tf-gpu], depending on the version of TensorFlow you wish to use.### Google CloudIf you wish to train usingGoogle Cloud ML Engine, the optional dependencies must be installed:`bash pip install luminoth[gcloud] `## Installing from sourceFirst, clone the repo on your machine and then install withpip:`bash git clonehttps://github.com/tryolabs/luminoth.gitcd luminoth pip install-e. `## Check that the installation workedSimply runlumi –help.# Supported modelsCurrently, 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 providepre-trained checkpointsfor the above models trained on popular datasets such as [COCO](http://cocodataset.org/) and [Pascal](http://host.robots.ox.ac.uk/pascal/VOC/).# UsageThere is one main command line interface which you can use with thelumicommand. Whenever you are confused on how you are supposed to do something just type:lumi –helporlumi <subcommand> –helpand a list of available options with descriptions will show up.## Working with datasetsSee [Adapting a dataset](http://luminoth.readthedocs.io/en/latest/usage/dataset.html).## TrainingSee [Training your own model](http://luminoth.readthedocs.io/en/latest/usage/training.html) to learn how to train locally or in Google Cloud.## Visualizing resultsWe 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 tojobs/under the current directory. You can use TensorBoard by running:`bash tensorboard--logdirpath/to/jobs `## Why the name?> The Dark Visor is a Visor upgrade in Metroid Prime 2: Echoes. Designed by theLuminothduring 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)
># LicenseCopyright © 2018, [Tryolabs](https://tryolabs.com).
Released under the [BSD 3-Clause](LICENSE).