mirror repository on gitlab + ci

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,67 @@
+name: Bug Report
+description: File a bug report
+title: "[Bug]: "
+labels: ["bug"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+    validations:
+      required: true
+  - type: textarea
+    id: code
+    attributes:
+      label: Code snippet triggering the error
+      description: Please copy and paste your lines of code.
+      render: shell
+  - type: textarea
+    id: logs
+    attributes:
+      label: Error message or erroneous outcome
+      description: Please copy and paste your error.
+      render: shell
+  - type: dropdown
+    id: version
+    attributes:
+      label: Version
+      description: What version of Heat are you running?
+      options:
+        - 1.2.x
+        - 1.1.x
+        - main (development branch)
+    validations:
+      required: true
+  - type: dropdown
+    id: python-version
+    attributes:
+      label: Python version
+      description: What Python version?
+      options:
+        - 3.8
+        - 3.9
+        - 3.10
+        - 3.7
+  - type: dropdown
+    id: pytorch-version
+    attributes:
+      label: PyTorch version
+      description: What PyTorch version?
+      options:
+        - 1.11
+        - 1.10
+        - 1.9
+        - 1.8
+        - 1.7
+  - type: textarea
+    id: mpi-version
+    attributes:
+      label: MPI version
+      description: OpenMPI, ParaStation, IntelMPI version?
+      render: shell

.github/release-drafter.yml

@@ -0,0 +1,43 @@
+categories:
+  - title: '🔥 Features'
+    labels:
+      - 'enhancement'
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 'bug :bug:'
+  - title: '🧹 Maintenance'
+    label: 'chore'
+  - title: '📜 Documentation'
+    label: 'documentation :book:'
+  - title: '🧪 Testing'
+    label: 'testing'
+  - title: '💯 Benchmarking'
+    label: 'benchmarking'
+  - title: 'Linear Algebra'
+    label: 'linalg'
+  - title: 'DNDarray'
+    label: 'dndarray'
+  - title: 'Arithmetic'
+    label: 'arithmetic'
+  - title: 'Random'
+    label: 'random'
+  - title: 'Logical'
+    label: 'logical'
+  - title: 'Manipulation'
+    label: 'manipulation'
+  - title: 'Communication'
+    labels:
+      - 'io'
+      - 'communication'
+change-template: '- #$NUMBER $TITLE (by @$AUTHOR)'
+categorie-template: '### $TITLE'
+exclude-labels:
+- 'workflow'
+template: |
+  ## Changes
+
+  $CHANGES
+
+  ## Contributors
+
+  $CONTRIBUTORS

.github/workflows/changelog-updater.yml

@@ -0,0 +1,27 @@
+name: 'Update Changelog'
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          ref: main
+
+      - name: Update Changelog
+        uses: stefanzweifel/changelog-updater-action@v1
+        with:
+          release-notes: ${{ github.event.release.body }}
+          latest-version: ${{ github.event.release.name }}
+
+      - name: Commit updated CHANGELOG
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          branch: main
+          commit_message: Update CHANGELOG
+          file_pattern: CHANGELOG.md

.github/workflows/ci.yaml

@@ -14,12 +14,17 @@ jobs:
         py-version:
           - 3.7
           - 3.8
+          - 3.9
         mpi: [ 'openmpi' ]
         install-options: [ '.', '.[hdf5,netcdf]' ]
         pytorch-version:
           - 'torch==1.7.1+cpu torchvision==0.8.2+cpu torchaudio==0.7.2'
           - 'torch==1.8.1+cpu torchvision==0.9.1+cpu torchaudio==0.8.1'
           - 'torch==1.9.0+cpu torchvision==0.10.0+cpu torchaudio==0.9.0'
+          - 'torch==1.12.0+cpu torchvision==0.13.0+cpu torchaudio==0.12.0'
+        exclude:
+          - py-version: 3.9
+            pytorch-version: 'torch==1.7.1+cpu torchvision==0.8.2+cpu torchaudio==0.7.2'
 
 
     name: Python ${{ matrix.py-version }} with ${{ matrix.pytorch-version }}; options ${{ matrix.install-options }}

.github/workflows/latest-pytorch-support.yml

@@ -4,7 +4,6 @@ on:
   push:
     paths:
       - '.github/pytorch-release-versions/*'
-
 env:
   previous_pytorch: $(grep 'torch>=' setup.py | awk -F '<=' '{print $2}' | tr -d '",')
   new_pytorch: $(<.github/pytorch-release-versions/pytorch-latest.txt)
@@ -14,6 +13,9 @@ permissions:
   pull-requests: write
 jobs:
   latest-torch-support:
+    strategy:
+      matrix:
+        branches: ['main', 'release/1.2.x']
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2

.github/workflows/mirrorci.yml

@@ -0,0 +1,20 @@
+name: Mirror and run GitLab CI
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Mirror + trigger CI
+      uses: SvanBoxel/gitlab-mirror-and-ci-action@master
+      with:
+        args: "https://gitlab.jsc.fz-juelich.de/haf/heat"
+      env:
+        FORCE_PUSH: "false"
+        GITLAB_HOSTNAME: "gitlab.jsc.fz-juelich.de"
+        GITLAB_USERNAME: ""
+        GITLAB_PASSWORD: ${{ secrets.GITLAB_TOKEN }}
+        GITLAB_PROJECT_ID: "4935"
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pytorch-latest-release.yml

@@ -1,26 +1,28 @@
 name: Get latest PyTorch release version
 on:
   schedule:
-    - cron:  '0 5 * * 1-5'
+    - cron:  '25 14 * * 2'
+permissions:
+  contents: write
 jobs:
   get-version:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          ref: 'main'
+          token: ${{ secrets.GHACTIONS }}
+          ref: 'release/1.2.x'
       - name: Fetch PyTorch release version
         run: |
           curl -sL https://api.github.com/repos/pytorch/pytorch/releases/latest | \
-          jq -r ".tag_name" | tr -d 'v' > .github/workflows/pytorch-release-versions/pytorch-latest.txt
+          jq -r ".tag_name" | tr -d 'v' > .github/pytorch-release-versions/pytorch-latest.txt
       - name: Check for modified files
         id: git-check
         run: echo ::set-output name=modified::$([ -z "`git status --porcelain`" ] && echo "false" || echo "true")
       - name: Commit latest PyTorch release version
         if: steps.git-check.outputs.modified == 'true'
         run: |
-          echo "new=$(<.github/workflows/pytorch-release-versions/pytorch-latest.txt)" >> $GITHUB_ENV
+          echo "new=$(<.github/pytorch-release-versions/pytorch-latest.txt)" >> $GITHUB_ENV
           git config --global user.name 'ClaudiaComito'
           git config --global user.email '[email protected]@users.noreply.github.com'
           git commit -am "New PyTorch release ${{ env.new }}"

.github/workflows/release-drafter.yml

@@ -0,0 +1,13 @@
+name: Release Drafter
+
+on:
+  pull_request_target:
+    types: [closed]
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitlab-ci.yml

@@ -0,0 +1,19 @@
+test:
+  image: ubuntu:20.04
+  tags:
+  - heat
+  script:
+  - apt update
+  - apt -y install build-essential python3-pip curl
+  - DEBIAN_FRONTEND=noninteractive apt -y install libopenmpi-dev openmpi-bin openmpi-doc
+  - apt -y install libhdf5-openmpi-dev libpnetcdf-dev
+  - pip install pytest coverage
+  - pip install .[hdf5,netcdf]
+  - COVERAGE_FILE=report/cov/coverage1 mpirun --allow-run-as-root -n 1 coverage run --source=heat --parallel-mode -m pytest --junitxml=report/test/report1.xml heat/
+  - COVERAGE_FILE=report/cov/coverage2 mpirun --allow-run-as-root -n 3 coverage run --source=heat --parallel-mode -m pytest --junitxml=report/test/report2.xml heat/
+  - COVERAGE_FILE=report/cov/coverage5 mpirun --allow-run-as-root -n 5 coverage run --source=heat --parallel-mode -m pytest --junitxml=report/test/report5.xml heat/
+  - COVERAGE_FILE=report/cov/coverage8 mpirun --allow-run-as-root -n 8 coverage run --source=heat --parallel-mode -m pytest --junitxml=report/test/report8.xml heat/
+  - coverage combine report/cov/*
+  - coverage report
+  - coverage xml
+  - curl -s https://codecov.io/bash | bash -s -- -c -F unit -f coverage.xml -t $CODECOV_TOKEN  || echo "Codecov failed to upload"

.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
     -   id: check-added-large-files
     -   id: flake8
 -   repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 22.6.0
     hooks:
     -   id: black
 -   repo: https://github.com/pycqa/pydocstyle

contributing.md

@@ -98,6 +98,8 @@ git push origin features/123-boolean-operators
 
 * If your commit introduces a new feature or changes functionality, **please explain your changes and the thinking behind them**. This greatly simplifies the review process. For bug fixes, documentation updates, etc., this is generally not necessary, though if you do not get any reaction, do feel free to ask for review.
 
+* Phrase the PR title as a changelog message and make sure the PR is properly tagged ('enhancement', 'bug', 'ci/cd', 'chore', 'documentation').
+
 #### Review Process
 
 * Reviewers (the other developers and interested community members) will write inline and/or general comments on your Pull Request (PR) to help you improve its implementation, documentation and style. Every single developer working on the project has their code reviewed, and we’ve come to see it as friendly conversation from which we all learn and the overall code quality benefits. Therefore, please don’t let the review discourage you from contributing: its only aim is to improve the quality of project, not to criticize (we are, after all, very grateful for the time you’re donating!).

doc/source/tutorial_parallel_computation.rst

@@ -85,7 +85,10 @@ Data chunking in Heat is always done along a singular axis, i.e. a one-dimension
 
 .. note::
 
-    If your running the following examples in a distributed computation environment, please modify your program invocation from ``python ./my_script.py`` to ``mpirun -p <number_of_processors> python ./my_script.py``. By the way, invoking a Heat program like this on your laptop or workstation also works.
+    If you're running the following examples in a distributed computation environment, please modify your program invocation from ``python ./my_script.py`` to ``mpirun -p <number_of_processors> python ./my_script.py``. By the way, invoking a Heat program like this on your laptop or workstation also works.
+
+.. note ::
+   Most of the examples throughout the documentation display the split ``DNDarrays``. This is not the default behavior when displaying a ``DNDarray``, and the full array will be printed multiple times (based on the number of processes). This behaviour can be changed using the ``ht.local_printing()`` option or by printing the local arrays for each process with the property `larray <https://heat.readthedocs.io/en/latest/autoapi/heat/core/dndarray/index.html?highlight=dndarray#heat.core.dndarray.DNDarray.larray>`_.
 
 .. code:: python
 

heat/core/factories.py

@@ -946,7 +946,7 @@ def linspace(
     start = float(start)
     stop = float(stop)
     num = int(num)
-    if num <= 0:
+    if num < 0:
         raise ValueError(
             "number of samples 'num' must be non-negative integer, but was {}".format(num)
         )