[Enhancement] Support circleci and fix lint check (#1074)

* use offical markdownlint hook * add lint.yml * add circleci config * Updated config.yml * Updated config.yml * Updated config.yml * Updated config.yml
open-mmlab · Jan 5, 2022 · dc5499f · dc5499f
1 parent 7b83b74
commit dc5499f
Show file tree

Hide file tree

Showing 4 changed files with 206 additions and 22 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -0,0 +1,169 @@
+# Use the latest 2.1 version of CircleCI pipeline process engine.
+# See: https://circleci.com/docs/2.0/configuration-reference
+version: 2.1
+
+# Define a job to be invoked later in a workflow.
+# See: https://circleci.com/docs/2.0/configuration-reference/#jobs
+jobs:
+  lint:
+    docker:
+      - image: cimg/python:3.7.4
+    # Add steps to the job
+    # See: https://circleci.com/docs/2.0/configuration-reference/#steps
+    steps:
+      - checkout
+      - run:
+          name: Install dependencies
+          command: |
+            sudo apt-add-repository ppa:brightbox/ruby-ng -y
+            sudo apt-get update
+            sudo apt-get install -y ruby2.7
+      - run:
+          name: Install pre-commit hook
+          command: |
+            pip install pre-commit
+            pre-commit install
+      - run:
+          name: Linting
+          command: pre-commit run --all-files
+      - run:
+          name: Check docstring coverage
+          command: |
+            pip install interrogate
+            interrogate -v --ignore-init-method --ignore-module --ignore-nested-functions --ignore-regex "__repr__" --fail-under 80 mmpose
+  build_cpu:
+    parameters:
+      # The python version must match available image tags in
+      # https://circleci.com/developer/images/image/cimg/python
+      python:
+        type: string
+        default: "3.7.4"
+      torch:
+        type: string
+      torchvision:
+        type: string
+      env:
+        type: string
+        default: ""
+    docker:
+      - image: cimg/python:<< parameters.python >>
+    resource_class: large
+    steps:
+      - checkout
+      - run:
+          name: Install Libraries
+          command: |
+            sudo apt-get update
+            sudo apt-get install -y ffmpeg libsm6 libxext6 git ninja-build libglib2.0-0 libsm6 libxrender-dev libxext6 libturbojpeg
+      - run:
+          name: Configure Python & pip
+          command: |
+            python -m pip install --upgrade pip
+            python -m pip install wheel
+      - run:
+          name: Install PyTorch
+          command: |
+            python -V
+            python -m pip install torch==<< parameters.torch >>+cpu torchvision==<< parameters.torchvision >>+cpu -f https://download.pytorch.org/whl/torch_stable.html
+      - when:
+          condition:
+            equal: [ "3.9.0", << parameters.python >> ]
+          steps:
+            - run: python -m pip install protobuf && sudo apt-get update && sudo apt-get -y install libprotobuf-dev protobuf-compiler cmake
+      - run:
+          name: Install mmpose dependencies
+          command: |
+            python -m pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/cpu/torch<< parameters.torch >>/index.html
+            python -m pip install -r requirements.txt
+      - run:
+          name: Build and install
+          command: |
+            python -m pip install -e .
+      - run:
+          name: Run unittests
+          command: |
+            python -m coverage run --branch --source mmpose -m pytest tests/
+            python -m coverage xml
+            python -m coverage report -m
+  build_cu101:
+    machine:
+      image: ubuntu-1604-cuda-10.1:201909-23
+    resource_class: gpu.nvidia.small
+    steps:
+      - checkout
+      - run:
+          name: Configure Python & pip
+          command: |
+            pyenv global 3.7.0
+            python -m pip install --upgrade pip
+            python -m pip install wheel
+      - run:
+          name: Install Libraries
+          command: |
+            sudo apt-get update
+            sudo apt-get install -y ffmpeg libsm6 libxext6 git ninja-build libglib2.0-0 libsm6 libxrender-dev libxext6 libturbojpeg
+      - run:
+          name: Install PyTorch
+          command: |
+            python -V
+            pip install torch==1.6.0+cu101 torchvision==0.7.0+cu101 -f https://download.pytorch.org/whl/torch_stable.html
+      - run:
+          name: Install mmpose dependencies
+          # pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/cu101/torch${{matrix.torch_version}}/index.html
+          command: |
+            python -m pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/cu101/torch1.6.0/index.html
+            python -m pip install -r requirements.txt
+            python -c 'import mmcv; print(mmcv.__version__)'
+      - run:
+          name: Build and install
+          command: |
+            python -m pip install -e .
+      - run:
+          name: Run unittests
+          command: |
+            python -m pytest tests/
+
+workflows:
+  unit_tests:
+    jobs:
+      - lint
+      - build_cpu:
+          name: build_cpu_th1.6
+          torch: 1.6.0
+          torchvision: 0.7.0
+          requires:
+            - lint
+      - build_cpu:
+          name: build_cpu_th1.7
+          torch: 1.7.0
+          torchvision: 0.8.1
+          requires:
+            - lint
+      - build_cpu:
+          name: build_cpu_th1.8_py3.9
+          torch: 1.8.0
+          torchvision: 0.9.0
+          python: "3.9.0"
+          requires:
+            - lint
+      - build_cpu:
+          name: build_cpu_th1.9_py3.8
+          torch: 1.9.0
+          torchvision: 0.10.0
+          python: "3.8.12"
+          requires:
+            - lint
+      - build_cpu:
+          name: build_cpu_th1.9_py3.9
+          torch: 1.9.0
+          torchvision: 0.10.0
+          python: "3.9.0"
+          requires:
+            - lint
+      - build_cu101:
+          requires:
+            - build_cpu_th1.6
+            - build_cpu_th1.7
+            - build_cpu_th1.8_py3.9
+            - build_cpu_th1.9_py3.8
+            - build_cpu_th1.9_py3.9
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1,4 +1,4 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# This workflow will install Python dependencies, run tests with a variety of Python versions
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
 name: build
@@ -27,25 +27,6 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  lint:
-    runs-on: ubuntu-18.04
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python 3.7
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.7
-      - name: Install pre-commit hook
-        run: |
-          pip install pre-commit
-          pre-commit install
-      - name: Linting
-        run: pre-commit run --all-files
-      - name: Check docstring coverage
-        run: |
-          pip install interrogate
-          interrogate -v --ignore-init-method --ignore-module --ignore-nested-functions --ignore-regex "__repr__" --fail-under 80 mmpose
-
   build_cpu:
     runs-on: ubuntu-18.04
     strategy:

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,34 @@
+
+# This workflow will run lint
+
+name: lint
+
+on: [push, pull_request]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.7
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+      - name: Install pre-commit hook
+        run: |
+          # markdownlint requires ruby >= 2.7
+          sudo apt-add-repository ppa:brightbox/ruby-ng -y
+          sudo apt-get update
+          sudo apt-get install -y ruby2.7
+          pip install pre-commit
+          pre-commit install
+      - name: Linting
+        run: pre-commit run --all-files
+      - name: Check docstring coverage
+        run: |
+          pip install interrogate
+          interrogate -v --ignore-init-method --ignore-module --ignore-nested-functions --ignore-regex "__repr__" --fail-under 80 mmpose
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -29,8 +29,8 @@ repos:
         args: ["--remove"]
       - id: mixed-line-ending
         args: ["--fix=lf"]
-  - repo: https://github.com/jumanjihouse/pre-commit-hooks
-    rev: 2.1.4
+  - repo: https://github.com/markdownlint/markdownlint
+    rev: v0.11.0
     hooks:
       - id: markdownlint
         args: [ "-r", "~MD002,~MD007,~MD013,~MD024,~MD029,~MD033,~MD034,~MD036,~MD041" ]