mmcv/README.rst

50 lines
1.2 KiB
ReStructuredText

mmcv
====
.. image:: https://travis-ci.com/open-mmlab/mmcv.svg?branch=master
:target: https://travis-ci.com/open-mmlab/mmcv
.. image:: https://codecov.io/gh/open-mmlab/mmcv/branch/master/graph/badge.svg
:target: https://codecov.io/gh/open-mmlab/mmcv
.. image:: https://img.shields.io/github/license/open-mmlab/mmcv.svg
:target: https://github.com/open-mmlab/mmcv/blob/master/LICENSE
Introduction
------------
`mmcv` is a foundational python library for computer vision research and supports many
research projects in MMLAB, such as `mmdetection <https://github.com/open-mmlab/mmdetection>`_.
It provides the following functionalities.
- Universal IO APIs
- Image processing
- Video processing
- Image and annotation visualization
- Useful utilities (progress bar, timer, ...)
- PyTorch runner with hooking mechanism
- Various CNN architectures
See the `documentation <http://mmcv.readthedocs.io/en/latest>`_ for more features and usage.
Installation
------------
Try and start with
.. code::
pip install mmcv
or install from source
.. code::
git clone https://github.com/open-mmlab/mmcv.git
cd mmcv
pip install . # (add "-e" if you want to develop or modify the codes)