README.rst 884 B

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. labelme: Image Annotation Tool with Python
  2. ==========================================
  3. Labelme is a graphical image annotation tool inspired by
  4. http://labelme.csail.mit.edu.
  5. It is written in Python and uses Qt for its graphical interface.
  6. Dependencies
  7. ------------
  8. - `PyQt4 <http://www.riverbankcomputing.co.uk/software/pyqt/intro>`_
  9. Installation
  10. ------------
  11. On Ubuntu:
  12. .. code-block:: bash
  13. $ sudo apt-get install python-qt4 qt4-dev-tools
  14. $ sudo pip install labelme
  15. Usage
  16. -----
  17. .. code:: bash
  18. $ labelme # Open GUI
  19. At the moment annotations are saved as a `JSON <http://www.json.org/>`_
  20. file. The file includes the image itself. In the feature support for XML
  21. output or possibly even `SVG <http://www.w3.org/Graphics/SVG/>`_ will
  22. be added.
  23. Screencast
  24. ----------
  25. .. figure:: https://github.com/wkentaro/labelme/raw/master/_media/screencast.gif
  26. :width: 80%