README.rst 1.82 KB
Newer Older
Soumith Chintala's avatar
Soumith Chintala committed
1
torchvision
Thomas Grainger's avatar
Thomas Grainger committed
2
3
============

4
5
6
.. image:: https://travis-ci.org/pytorch/vision.svg?branch=master
    :target: https://travis-ci.org/pytorch/vision

7
8
9
.. image:: https://codecov.io/gh/pytorch/vision/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/pytorch/vision

10
11
12
13
14
15
.. image:: https://pepy.tech/badge/torchvision
    :target: https://pepy.tech/project/torchvision

.. image:: https://img.shields.io/badge/dynamic/json.svg?label=docs&url=https%3A%2F%2Fpypi.org%2Fpypi%2Ftorchvision%2Fjson&query=%24.info.version&colorB=brightgreen&prefix=v
    :target: https://pytorch.org/docs/stable/torchvision/index.html

16

17
The torchvision package consists of popular datasets, model architectures, and common image transformations for computer vision.
Thomas Grainger's avatar
Thomas Grainger committed
18
19
20
21

Installation
============

Soumith Chintala's avatar
Soumith Chintala committed
22
Anaconda:
Thomas Grainger's avatar
Thomas Grainger committed
23
24
25

.. code:: bash

Soumith Chintala's avatar
Soumith Chintala committed
26
    conda install torchvision -c pytorch
Thomas Grainger's avatar
Thomas Grainger committed
27

Soumith Chintala's avatar
Soumith Chintala committed
28
pip:
Thomas Grainger's avatar
Thomas Grainger committed
29
30
31

.. code:: bash

Thomas Grainger's avatar
Thomas Grainger committed
32
    pip install torchvision
Thomas Grainger's avatar
Thomas Grainger committed
33

Soumith Chintala's avatar
Soumith Chintala committed
34
35
36
37
38
39
From source:

.. code:: bash

    python setup.py install

40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

Image Backend
=============
Torchvision currently supports the following image backends:

* `Pillow`_ (default)

* `Pillow-SIMD`_ - a **much faster** drop-in replacement for Pillow with SIMD. If installed will be used as the default.

* `accimage`_ - if installed can be activated by calling :code:`torchvision.set_image_backend('accimage')`

.. _Pillow : https://python-pillow.org/
.. _Pillow-SIMD : https://github.com/uploadcare/pillow-simd
.. _accimage: https://github.com/pytorch/accimage

55
56
Documentation
=============
Soumith Chintala's avatar
Soumith Chintala committed
57
You can find the API documentation on the pytorch website: http://pytorch.org/docs/master/torchvision/
edgarriba's avatar
edgarriba committed
58

59
60
61
Contributing
============
We appreciate all contributions. If you are planning to contribute back bug-fixes, please do so without any further discussion. If you plan to contribute new features, utility functions or extensions, please first open an issue and discuss the feature with us.