Merge branch 'main' into ufmt

Author: pmeier

.circleci/config.yml

@@ -190,9 +190,11 @@ jobs:
       - image: circleci/python:3.7
     steps:
       - checkout
-      - run: pip install --user --progress-bar=off "ufmt>=1.3" usort==0.6.4 black==21.8b0 flake8
-      - run: ufmt check .
-      - run: flake8 --config=setup.cfg .
+      - run:
+          command: |
+            pip install --user --progress-bar off pre-commit
+            pre-commit install-hooks
+      - run: pre-commit run --all-files
 
   python_type_check:
     docker:

.circleci/config.yml.in

@@ -21,8 +21,8 @@
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-"""
-"""A wrapper script around clang-format, suitable for linting multiple files
+
+A wrapper script around clang-format, suitable for linting multiple files
 and to use for continuous integration.
 
 This is an alternative API for the clang-format command line.

.circleci/unittest/linux/scripts/run-clang-format.py

@@ -1 +1 @@
-start /wait "" "%miniconda_exe%" /S /InstallationType=JustMe /RegisterPython=0 /AddToPath=0 /D=%tmp_conda%
+start /wait "" "%miniconda_exe%" /S /InstallationType=JustMe /RegisterPython=0 /AddToPath=0 /D=%tmp_conda%

.circleci/unittest/windows/scripts/install_conda.bat

@@ -0,0 +1,14 @@
+repos:
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.9.2
+    hooks:
+      - id: flake8
+        args: [--config=setup.cfg]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+      - id: check-docstring-first
+      - id: check-toml
+      - id: check-yaml
+        exclude: packaging/.*
+      - id: end-of-file-fixer

.pre-commit-config.yaml

@@ -64,7 +64,7 @@ If you plan to modify the code or documentation, please follow the steps below:
 2. If you have modified the code (new feature or bug-fix), please add unit tests.
 3. If you have changed APIs, update the documentation. Make sure the documentation builds.
 4. Ensure the test suite passes.
-5. Make sure your code passes `flake8` formatting check.
+5. Make sure your code passes the formatting checks (see below).
 
 For more details about pull requests, 
 please read [GitHub's guides](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). 
@@ -75,9 +75,19 @@ If you would like to contribute a new dataset, please see [here](#New-dataset).
 
 ### Code formatting and typing
 
-New code should be compatible with Python 3.X versions and be compliant with PEP8. To check the codebase, please run
+Contributions should be compatible with Python 3.X versions and be compliant with PEP8. To check the codebase, please 
+either run
 ```bash
-flake8 --config=setup.cfg .
+pre-commit run --all-files
+```
+or run
+```bash
+pre-commit install
+```
+once to perform these checks automatically before every `git commit`. If `pre-commit` is not available you can install 
+it with
+```
+pip install pre-commit
 ```
 
 The codebase has type annotations, please make sure to add type hints if required. We use `mypy` tool for type checking:

CONTRIBUTING.md

@@ -106,9 +106,9 @@ otherwise, add the include and library paths in the environment variables ``TORC
 .. _libjpeg: http://ijg.org/
 .. _libjpeg-turbo: https://libjpeg-turbo.org/
 
-C++ API
-=======
-TorchVision also offers a C++ API that contains C++ equivalent of python models.
+Using the models on C++
+=======================
+TorchVision provides an example project for how to use the models on C++ using JIT Script.
 
 Installation From source:
 

README.rst

@@ -39,4 +39,3 @@ allprojects {
 ext.deps = [
         jsr305: 'com.google.code.findbugs:jsr305:3.0.1',
 ]
-

android/build.gradle

@@ -14,4 +14,4 @@
         android:background="@android:color/black"
         android:textColor="@android:color/white" />
 
-</FrameLayout>
+</FrameLayout>

android/test_app/app/src/main/res/layout/activity_main.xml

@@ -9,4 +9,4 @@ torchvision it just hides the links. So we have to put them back here */
 article.pytorch-article .sphx-glr-download-link-note.admonition.note,
 article.pytorch-article .reference.download.internal, article.pytorch-article .sphx-glr-signature {
   display: block;
-}
+}