README.rst 967 B

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  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. On OS X:
  16. .. code-block:: bash
  17. $ brew install qt qt4
  18. $ pip install labelme
  19. Usage
  20. -----
  21. .. code:: bash
  22. $ labelme # Open GUI
  23. At the moment annotations are saved as a `JSON <http://www.json.org/>`_
  24. file. The file includes the image itself. In the feature support for XML
  25. output or possibly even `SVG <http://www.w3.org/Graphics/SVG/>`_ will
  26. be added.
  27. Screencast
  28. ----------
  29. .. figure:: https://github.com/wkentaro/labelme/raw/master/_media/screencast.gif
  30. :width: 80%