Merge branch 'v-yujiang/ib-mpi' of https://github.com/microsoft/super…

…benchmark into v-yujiang/ib-mpi
microsoft · Oct 21, 2021 · e74d022 · e74d022
2 parents 90fe09a + 1945592
commit e74d022
Show file tree

Hide file tree

Showing 53 changed files with 1,045 additions and 418 deletions.
diff --git a/.azure-pipelines/cpu-unit-test.yml b/.azure-pipelines/cpu-unit-test.yml
@@ -5,6 +5,9 @@ trigger:
   - main
   - release/*
 
+pool:
+  vmImage: ubuntu-latest
+
 container:
   image: python:3.7
 

diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,24 @@
+version: 2
+updates:
+  # enable version updates for pip
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 0
+    allow:
+      - dependency-type: "direct"
+    labels:
+      - "dependencies"
+    assignees:
+      - "guoshzhao"
+  # enable version updates for npm
+  - package-ecosystem: "npm"
+    directory: "/website/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 0
+    labels:
+      - "dependencies"
+    assignees:
+      - "abuccts"
diff --git a/.github/workflows/build-image.yml b/.github/workflows/build-image.yml
@@ -4,15 +4,32 @@ on:
   push:
     branches:
     - main
+    - release/*
   pull_request:
     branches:
     - main
     - release/*
+  release:
+    types:
+    - published
+  workflow_dispatch:
 
 jobs:
   docker:
-    name: Docker build
+    name: Docker build ${{ matrix.name }}
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    strategy:
+      matrix:
+        include:
+        - name: cuda11.1.1
+          tags: superbench/main:cuda11.1.1,superbench/superbench:latest
+        - name: rocm4.2-pytorch1.7.0
+          tags: superbench/main:rocm4.2-pytorch1.7.0
+        - name: rocm4.0-pytorch1.7.0
+          tags: superbench/main:rocm4.0-pytorch1.7.0
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -26,43 +43,63 @@ jobs:
           done
           sudo apt-get clean
           df -h
-          echo 'nproc: '$(nproc)
       - name: Prepare metadata
         id: metadata
         run: |
-          DOCKER_IMAGE=superbench/superbench
-          IMAGE_TAG=latest
+          TAGS=${{ matrix.tags }}
+          if [[ "${{ github.event_name }}" == "push" ]] && [[ "${{ github.ref }}" == "refs/heads/release/"* ]]; then
+            TAGS=$(sed "s/main:/release:${GITHUB_REF##*/}-/g" <<< ${TAGS})
+          fi
+          if [[ "${{ github.event_name }}" == "pull_request" ]] && [[ "${{ github.base_ref }}" == "release/"* ]]; then
+            TAGS=$(sed "s/main:/release:${GITHUB_BASE_REF##*/}-/g" <<< ${TAGS})
+          fi
+          if [[ "${{ github.event_name }}" == "release" ]]; then
+            TAGS=$(sed "s/main:/superbench:${GITHUB_REF##*/}-/g" <<< ${TAGS})
+            GHCR_TAG=$(cut -d, -f1 <<< ${TAGS} | sed "s#superbench/superbench#ghcr.io/${{ github.repository }}/superbench#g")
+            TAGS="${TAGS},${GHCR_TAG}"
+          fi
+          if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
+            TAGS=$(sed "s/main:/dev:/g" <<< ${TAGS})
+          fi
+          DOCKERFILE=dockerfile/${{ matrix.name }}.dockerfile
 
-          DOCKERFILE=dockerfile/cuda11.1.1.dockerfile
-          TAGS="${DOCKER_IMAGE}:${IMAGE_TAG}"
-          CACHE_FROM="type=registry,ref=${DOCKER_IMAGE}:${IMAGE_TAG}"
+          CACHE_FROM="type=registry,ref=$(cut -d, -f1 <<< ${TAGS})"
           CACHE_TO=""
-          if [ "${{ github.event_name }}" = "push" ]; then
+          if [[ "${{ github.event_name }}" != "pull_request" ]]; then
             CACHE_TO="type=inline,mode=max"
           fi
 
           echo ::set-output name=dockerfile::${DOCKERFILE}
           echo ::set-output name=tags::${TAGS}
           echo ::set-output name=cache_from::${CACHE_FROM}
           echo ::set-output name=cache_to::${CACHE_TO}
+      - name: Echo image tag
+        run: echo ${{ steps.metadata.outputs.tags }}
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v1
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v1
       - name: Login to Docker Hub
         uses: docker/login-action@v1
-        if: ${{ github.event_name == 'push' }}
+        if: ${{ github.event_name != 'pull_request' }}
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Login to the GitHub Container Registry
+        uses: docker/login-action@v1
+        if: ${{ github.event_name == 'release' }}
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
       - name: Build and push
         id: docker_build
         uses: docker/build-push-action@v2
         with:
           platforms: linux/amd64
           context: .
           file: ${{ steps.metadata.outputs.dockerfile }}
-          push: ${{ github.event_name == 'push' }}
+          push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.metadata.outputs.tags }}
           cache-from: ${{ steps.metadata.outputs.cache_from }}
           cache-to: ${{ steps.metadata.outputs.cache_to }}

diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -0,0 +1,59 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches:
+    - main
+    - release/*
+  pull_request:
+    branches:
+    - main
+    - release/*
+  schedule:
+  - cron: "30 1 * * 1"
+
+jobs:
+  analyze:
+    name: CodeQL analyze ${{ matrix.language }}
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    strategy:
+      fail-fast: false
+      matrix:
+        language:
+        - python
+        - javascript
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1
+  analyze-cpp:
+    name: CodeQL analyze cpp
+    runs-on: ubuntu-latest
+    container:
+      image: nvcr.io/nvidia/pytorch:20.12-py3
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: cpp
+    - name: Build
+      run: make cppbuild -j
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -9,7 +9,7 @@ on:
 jobs:
   spelling:
     name: Spelling check
-    runs-on: ubuntu-16.04
+    runs-on: ubuntu-latest
     steps:
     - name: Checkout
       uses: actions/checkout@v2

diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@
 
 __SuperBench__ is a validation and profiling tool for AI infrastructure.
 
-📢 [v0.2.1](https://github.com/microsoft/superbenchmark/releases/tag/v0.2.1) has been released!
+📢 [v0.3.0](https://github.com/microsoft/superbenchmark/releases/tag/v0.3.0) has been released!
 
 ## _Check [aka.ms/superbench](https://aka.ms/superbench) for more details._
 

diff --git a/dockerfile/rocm4.0-pytorch1.7.0.dockerfile b/dockerfile/rocm4.0-pytorch1.7.0.dockerfile
@@ -88,7 +88,7 @@ ENV PATH="${PATH}" \
 WORKDIR ${SB_HOME}
 
 ADD third_party third_party
-RUN ROCM_VERSION=rocm-4.0.0 make -j -C third_party rocm
+RUN ROCM_VERSION=rocm-4.0.0 make -j -C third_party -o rocm_rocblas rocm
 
 # Workaround for image having package installed in user path
 RUN mv /root/.local/bin/* /opt/conda/bin/ && \

diff --git a/docs/cli.md b/docs/cli.md
@@ -41,23 +41,23 @@ sb deploy [--docker-image]
 
 #### Optional arguments
 
-| Name | Default | Description |
-| --- | --- | --- |
-| `--docker-image` `-i` | `superbench/superbench` | Docker image URI, [here](./tutorial/container-images) listed all images. |
-| `--docker-password` | `None` | Docker registry password if authentication is needed. |
-| `--docker-username` | `None` | Docker registry username if authentication is needed. |
-| `--host-file` `-f` | `None` | Path to Ansible inventory host file. |
-| `--host-list` `-l` | `None` | Comma separated host list. |
-| `--host-password` | `None` | Host password or key passphase if needed. |
-| `--host-username` | `None` | Host username if needed. |
-| `--output-dir` | `None` | Path to output directory, outputs/{datetime} will be used if not specified. |
-| `--private-key` | `None` | Path to private key if needed. |
+| Name                  | Default                 | Description                                                                   |
+|-----------------------|-------------------------|-------------------------------------------------------------------------------|
+| `--docker-image` `-i` | `superbench/superbench` | Docker image URI, [here](./user-tutorial/container-images) listed all images. |
+| `--docker-password`   | `None`                  | Docker registry password if authentication is needed.                         |
+| `--docker-username`   | `None`                  | Docker registry username if authentication is needed.                         |
+| `--host-file` `-f`    | `None`                  | Path to Ansible inventory host file.                                          |
+| `--host-list` `-l`    | `None`                  | Comma separated host list.                                                    |
+| `--host-password`     | `None`                  | Host password or key passphase if needed.                                     |
+| `--host-username`     | `None`                  | Host username if needed.                                                      |
+| `--output-dir`        | `None`                  | Path to output directory, outputs/{datetime} will be used if not specified.   |
+| `--private-key`       | `None`                  | Path to private key if needed.                                                |
 
 #### Global arguments
 
-| Name | Default | Description |
-| --- | --- | --- |
-| `--help` `-h` | N/A | Show help message. |
+| Name          | Default | Description        |
+|---------------|---------|--------------------|
+| `--help` `-h` | N/A     | Show help message. |
 
 #### Examples
 
@@ -82,17 +82,17 @@ sb exec [--config-file]
 
 #### Optional arguments
 
-| Name | Default | Description |
-| --- | --- | --- |
-| `--config-file` `-c` | `None` | Path to SuperBench config file. |
-| `--config-override` `-C` | `None` | Extra arguments to override config_file. |
-| `--output-dir` | `None` | Path to output directory, outputs/{datetime} will be used if not specified. |
+| Name                     | Default | Description                                                                 |
+|--------------------------|---------|-----------------------------------------------------------------------------|
+| `--config-file` `-c`     | `None`  | Path to SuperBench config file.                                             |
+| `--config-override` `-C` | `None`  | Extra arguments to override config_file.                                    |
+| `--output-dir`           | `None`  | Path to output directory, outputs/{datetime} will be used if not specified. |
 
 #### Global arguments
 
-| Name | Default | Description |
-| --- | --- | --- |
-| `--help` `-h` | N/A | Show help message. |
+| Name          | Default | Description        |
+|---------------|---------|--------------------|
+| `--help` `-h` | N/A     | Show help message. |
 
 #### Examples
 
@@ -120,25 +120,25 @@ sb run [--config-file]
 
 #### Optional arguments
 
-| Name | Default | Description |
-| --- | --- | --- |
-| `--config-file` `-c` | `None` | Path to SuperBench config file. |
-| `--config-override` `-C` | `None` | Extra arguments to override config_file. |
-| `--docker-image` `-i` | `superbench/superbench` | Docker image URI. |
-| `--docker-password` | `None` | Docker registry password if authentication is needed. |
-| `--docker-username` | `None` | Docker registry username if authentication is needed. |
-| `--host-file` `-f` | `None` | Path to Ansible inventory host file. |
-| `--host-list` `-l` | `None` | Comma separated host list. |
-| `--host-password` | `None` | Host password or key passphase if needed. |
-| `--host-username` | `None` | Host username if needed. |
-| `--output-dir` | `None` | Path to output directory, outputs/{datetime} will be used if not specified. |
-| `--private-key` | `None` | Path to private key if needed. |
+| Name                     | Default                 | Description                                                                 |
+|--------------------------|-------------------------|-----------------------------------------------------------------------------|
+| `--config-file` `-c`     | `None`                  | Path to SuperBench config file.                                             |
+| `--config-override` `-C` | `None`                  | Extra arguments to override config_file.                                    |
+| `--docker-image` `-i`    | `superbench/superbench` | Docker image URI.                                                           |
+| `--docker-password`      | `None`                  | Docker registry password if authentication is needed.                       |
+| `--docker-username`      | `None`                  | Docker registry username if authentication is needed.                       |
+| `--host-file` `-f`       | `None`                  | Path to Ansible inventory host file.                                        |
+| `--host-list` `-l`       | `None`                  | Comma separated host list.                                                  |
+| `--host-password`        | `None`                  | Host password or key passphase if needed.                                   |
+| `--host-username`        | `None`                  | Host username if needed.                                                    |
+| `--output-dir`           | `None`                  | Path to output directory, outputs/{datetime} will be used if not specified. |
+| `--private-key`          | `None`                  | Path to private key if needed.                                              |
 
 #### Global arguments
 
-| Name | Default | Description |
-| --- | --- | --- |
-| `--help` `-h` | N/A | Show help message. |
+| Name          | Default | Description        |
+|---------------|---------|--------------------|
+| `--help` `-h` | N/A     | Show help message. |
 
 #### Examples
 
@@ -162,9 +162,9 @@ sb version
 
 #### Global arguments
 
-| Name | Default | Description |
-| --- | --- | --- |
-| `--help` `-h` | N/A | Show help message. |
+| Name          | Default | Description        |
+|---------------|---------|--------------------|
+| `--help` `-h` | N/A     | Show help message. |
 
 #### Examples
 

diff --git a/docs/developer-guides/development.md b/docs/developer-guides/development.md
@@ -11,7 +11,7 @@ You can also develop online with [GitHub Codespaces](https://github.com/codespac
 
 ## Check Environment
 
-Follow [System Requirements](../getting-started/installation.md).
+Follow [System Requirements](../getting-started/installation).
 
 ## Set Up
 

diff --git a/docs/developer-guides/using-docker.mdx b/docs/developer-guides/using-docker.mdx
@@ -36,7 +36,10 @@ docker buildx build \
 <TabItem value='rocm'>
 
 ```bash
-# coming soon
+export DOCKER_BUILDKIT=1
+docker buildx build \
+  --platform linux/amd64 --cache-to type=inline,mode=max \
+  --tag superbench-dev --file dockerfile/rocm4.2-pytorch1.7.0.dockerfile .
 ```
 
 </TabItem>