README.rst 963 B

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  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. The annotations are saved as a `JSON <http://www.json.org/>`_ file.
  24. The file includes the image itself.
  25. To view the json file quickly, you can use utility script:
  26. .. code-block:: bash
  27. $ labelme_draw_json sample.json
  28. Screencast
  29. ----------
  30. .. figure:: https://github.com/wkentaro/labelme/raw/master/_media/screencast.gif
  31. :width: 80%