Merge pull request #634 from aimakerspace/docs-v1.2

v1.2.0 Changes

.github/actions/system-test/action.yaml

@@ -1,9 +1,9 @@
-name: 'ML Model Test'
-description: 'Run and test machine learning models in repository'
+name: "ML Model Test"
+description: "Run and test machine learning models in repository"
 runs:
   using: "composite"
   steps:
-    - name: Initialise peekingduck
+    - name: Initialize peekingduck
       run: peekingduck init
       shell: bash
     - name: Test Usecases

.github/workflows/daily_drift_checks.yml

@@ -13,7 +13,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-18.04, windows-2019]
-        python-version: [3.6, 3.7, 3.8]
+        python-version: [3.6, 3.7, 3.8, 3.9]
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python ${{ matrix.python-version }}
@@ -30,6 +30,7 @@ jobs:
           fi
           echo "test_module_import.py TEST_VER=${TEST_VER}"
           python -m pip install --upgrade pip
+          pip install -r requirements.txt
           pip install -r cicd_requirements.txt
           bash ./scripts/update_version.sh ${TEST_VER}
           pip install . --no-dependencies

.github/workflows/post_merge_checks.yml

@@ -5,32 +5,39 @@ on:
     branches:
       - main
       - dev
+      - docs-v1.2
 
 jobs:
   all_tests:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-18.04]
+        os: [ubuntu-18.04, windows-latest]
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
       - name: Setup python
         uses: actions/setup-python@v2
         with:
           python-version: 3.7
-          cache: 'pip'
+          cache: "pip"
       - name: Install dependencies
         run: |
+          if [ "$RUNNER_OS" == "Windows" ]; then
+            TEST_VER=0.0.0dev
+          else
+            TEST_VER=`grep -m 1 TEST_VERSION ./tests/module_import/test_module_import.py | cut -d ' ' -f 3`
+            TEST_VER=`echo ${TEST_VER} | cut -d '"' -f 2`
+          fi
+          echo "test_module_import.py TEST_VER=${TEST_VER}"
           python -m pip install --upgrade pip
+          pip install wheel
+          pip install -r requirements.txt
           pip install -r cicd_requirements.txt
-          TEST_VER=`grep -m 1 TEST_VERSION ./tests/module_import/test_module_import.py | cut -d ' ' -f 3`
-          TEST_VER=`echo ${TEST_VER} | cut -d '"' -f 2`
-          echo "test_module_import.py TEST_VER=${TEST_VER}"
           bash ./scripts/update_version.sh ${TEST_VER}
           pip install . --no-dependencies
+        shell: bash
       - name: Run all tests
-        run: bash ./scripts/run_tests.sh all
+        run: bash ./scripts/run_tests.sh post_merge
       - name: Run broken link report
         run: python ./scripts/check_links.py
-

.github/workflows/pre_merge_ci.yml

@@ -14,13 +14,15 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: 3.7
-          cache: 'pip'
+          cache: "pip"
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
+          pip install wheel
+          pip install -r lint_requirements.txt
           pip install -r cicd_requirements.txt
       - name: Run lint checks
-        uses: ./.github/actions/linting-checks  # note only works after checkout@v2
+        uses: ./.github/actions/linting-checks # note only works after checkout@v2
       - name: Run unit tests
         run: bash ./scripts/run_tests.sh unit
       - name: Run broken link report

.github/workflows/publish_pypi.yml

@@ -22,6 +22,7 @@ jobs:
       - name: Local Test
         run: |
           python -m pip install --upgrade pip
+          pip install -r requirements.txt
           pip install -r cicd_requirements.txt
           pip install .
           bash ./scripts/run_tests.sh all

.github/workflows/publish_skip_testpypi.yml

@@ -19,6 +19,7 @@ jobs:
       - name: Local Test
         run: |
           python -m pip install --upgrade pip
+          pip install -r requirements.txt
           pip install -r cicd_requirements.txt
           pip install .
           bash ./scripts/run_tests.sh all

.gitignore

@@ -151,5 +151,6 @@ build/
 dist/
 peekingduck.egg-info/
 docs/source/peekingduck.*
+docs/source/nodes
 # Other likely files that should not be committed
 .DS_Store

.readthedocs.yaml

@@ -3,15 +3,15 @@ version: 2
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-   configuration: docs/source/conf.py
+  configuration: docs/source/conf.py
 
 # Optionally build your docs in additional formats such as PDF
 formats:
-   - pdf
+  - pdf
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-   version: 3.7
-   install:
-      - requirements: cicd_requirements.txt
-
+  version: 3.7
+  install:
+    - requirements: requirements.txt
+    - requirements: cicd_requirements.txt

CONTRIBUTING.md

@@ -131,7 +131,7 @@ The following are commonly used conventions which we adhere to:
   - `CapWords` for `ClassName`, `ExceptionName`
   - Fully capitalised for `GLOBAL_CONSTANT_NAME`
   - `_dir` postfix for full paths of directories, e.g. where weights are stored
-  - `_path` postfix for full paths to files, e.g. `~/demo/run_config.yml`
+  - `_path` postfix for full paths to files, e.g. `~/demo/pipeline_config.yml`
   - `_subdir` postfix for part of paths, e.g. `src/custom_nodes`
   - `_name` postfix for file names, e.g. `output.mp4`
 - Docstrings and comments

LICENSE

@@ -175,7 +175,7 @@
 
    END OF TERMS AND CONDITIONS
 
-   Copyright 2021 AI Singapore
+   Copyright 2022 AI Singapore
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.