Merge branch 'NVIDIA:main' into test_premerge

.github/DISCUSSION_TEMPLATE/q-a.yml

@@ -0,0 +1,50 @@
+title: "[Q&A] "
+labels: ["q&a"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please fill out the form so the community can better assist you!
+  - type: input
+    attributes:
+      label: Python version (`python3 -V`)
+      description: Python version (`python3 -V`)
+      placeholder: "3.10"
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: NVFlare version (`python3 -m pip list | grep "nvflare"`)
+      description: NVFlare version (`python3 -m pip list | grep "nvflare"`)
+      placeholder: "2.5.0"
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: NVFlare branch (if running examples, please use the branch that corresponds to the NVFlare version, `git branch`)
+      description: NVFlare branch (if running examples, please use the branch that corresponds to the NVFlare version, `git branch`)
+      placeholder: "2.5"
+  - type: input
+    attributes:
+      label: Operating system
+      description: Operating system (Ubuntu, MacOS, Windows, etc)
+      placeholder: "Ubuntu 22.04"
+    validations:
+      required: true
+  - type: checkboxes
+    attributes:
+      label: Have you successfully run any of the following examples?
+      options:
+        - label: hello-numpy-sag with simulator
+        - label: hello-pt with simulator
+        - label: hello-numpy-sag with POC
+        - label: hello-pt with POC
+  - type: textarea
+    id: questions
+    attributes:
+      label: Please describe your question
+      description: "Please describe your question. It would be better if you can attach some logs."
+      value: |
+        I run into the following issue and don't know what to do ...
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/bug_report.md

@@ -24,9 +24,9 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. ubuntu 16.04]
- - Python Version [e.g. 3.8]
- - NVFlare Version [e.g. 2.1]
+ - OS: [e.g. ubuntu 22.04]
+ - Python Version [e.g. 3.10]
+ - NVFlare Version [e.g. 2.5]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,12 @@
+---
+name: Question (please use the Discussion tab)
+about: https://github.com/NVIDIA/NVFlare/discussions
+title: 'Please use NVFlare Discussion tab for questions'
+labels: ''
+assignees: ''
+---
+
+**Please use NVFlare's Discussions tab**
+For questions relating to NVFlare usage, please do not create an issue.
+
+Instead, use [NVFlare's GitHub Discussions tab](https://github.com/NVIDIA/NVFlare/discussions). This can be found next to Issues and Pull Requests along the top of our repository.

.github/pull_request_template.md

@@ -0,0 +1,14 @@
+Fixes # .
+
+### Description
+
+A few sentences describing the changes proposed in this pull request.
+
+### Types of changes
+<!--- Put an `x` in all the boxes that apply, and remove the not applicable items -->
+- [x] Non-breaking change (fix or new feature that would not break existing functionality).
+- [ ] Breaking change (fix or new feature that would cause existing functionality to change).
+- [ ] New tests added to cover the changes.
+- [ ] Quick tests passed locally by running `./runtest.sh`.
+- [ ] In-line docstrings updated.
+- [ ] Documentation updated.

.github/workflows/blossom-ci.yml

@@ -42,15 +42,26 @@ jobs:
       args: ${{ env.args }}
 
     # This job only runs for pull request comments
-    if: contains('\
-      chesterxgchen,\
-      pxLi,\
-      IsaacYangSLA,\
-      YanxuanLiu,\
-      yhwen,\
-      YuanTingHsieh,\
-      holgerroth,\
-      ', format('{0},', github.actor)) && github.event.comment.body == '/build'
+    if: |
+      github.event.comment.body == '/build' &&
+      (
+        github.actor == 'chesterxgchen' ||
+        github.actor == 'pxLi' ||
+        github.actor == 'IsaacYangSLA' ||
+        github.actor == 'YanxuanLiu' ||
+        github.actor == 'yhwen' ||
+        github.actor == 'YuanTingHsieh' ||
+        github.actor == 'holgerroth' ||
+        github.actor == 'yhwen' ||
+        github.actor == 'nvkevlu' ||
+        github.actor == 'nvidianz' ||
+        github.actor == 'yanchengnv' ||
+        github.actor == 'ZiyueXu77' ||
+        github.actor == 'Can-Zhao' ||
+        github.actor == 'guopengf' ||
+        github.actor == 'SYangster' ||
+        github.actor == 'yinqingh'
+      )
     steps:
       - name: Check if comment is issued by authorized person
         run: blossom-ci
@@ -65,7 +76,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           repository: ${{ fromJson(needs.Authorization.outputs.args).repo }}
           ref: ${{ fromJson(needs.Authorization.outputs.args).ref }}

.github/workflows/codeql.yml

@@ -16,10 +16,7 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ "main", "dev" ]
   pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ "main", "dev" ]
 
 jobs:
   analyze:
@@ -39,7 +36,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
@@ -52,6 +49,9 @@ jobs:
 
         # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
         # queries: security-extended,security-and-quality
+        config: |
+          paths-ignore:
+            - 'tests'
 
         
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).

.github/workflows/deploy.yml

@@ -0,0 +1,57 @@
+name: Deploy to gh-pages
+
+on:
+  # Trigger the workflow if any web/** files are modified
+  push:
+    branches:
+      - "main"
+      - "2.5"
+    paths:
+      - 'web/**'
+  workflow_dispatch:
+
+env:
+  site_path: ./web
+  version_path: /
+
+# Allow this job to clone the repo and create a page deployment
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Update version_path for non-main branches
+        if: ${{ github.ref_type == 'branch' && github.ref_name != 'main'}}
+        run: echo version_path=/version/${{ github.ref_name }}/ >> $GITHUB_ENV
+
+      - name: Checkout your repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+          cache-dependency-path: "${{ env.site_path }}/package-lock.json"
+
+      - name: Install dependencies
+        run: npm install
+        working-directory: ${{ env.site_path }}
+
+      - name: Build project
+        run: npm run build
+        env:
+          PUBLIC_GH_BRANCH: ${{ github.ref_name }}
+        working-directory: ${{ env.site_path }}
+
+      - name: Deploy
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages
+          folder: ${{ env.site_path }}/dist
+          target-folder: ${{ env.version_path }}
+          clean-exclude: version

.github/workflows/markdown-links-check.yml

@@ -0,0 +1,33 @@
+# Copyright (c) 2023, NVIDIA CORPORATION.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# A workflow to check if PR got broken hyperlinks
+name: Check Markdown links
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: gaurav-nelson/[email protected]
+      with:
+        max-depth: -1
+        use-verbose-mode: 'yes'
+        config-file: '.github/workflows/mlc_config.json'
+        check-modified-files-only: 'yes'
+        base-branch: 'main'

.github/workflows/mlc_config.json

@@ -0,0 +1,7 @@
+{
+  "ignorePatterns": [
+    {
+      "pattern": "catalog.ngc.nvidia.com"
+    }
+  ]
+}

.github/workflows/premerge.yml

@@ -17,47 +17,47 @@ name: pre-merge
 on:
   # quick tests for pull requests and the releasing branches
   push:
-    branches:
-      - dev
   pull_request:
   workflow_dispatch:
 
 jobs:
   unit-tests:
-    runs-on: ubuntu-20.04
+    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        python-version: [ "3.8" ]
+        os: [ ubuntu-22.04, ubuntu-20.04 ]
+        python-version: [ "3.9", "3.10", "3.11", "3.12" ]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install -r requirements-dev.txt
+          python3 -m pip install --upgrade pip
+          python3 -m pip install --no-cache-dir -e .[dev]
       - name: Run unit test
         run: ./runtest.sh
 
   wheel-build:
-    runs-on: ubuntu-20.04
+    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        python-version: [ "3.8" ]
+        os: [ ubuntu-22.04, ubuntu-20.04 ]
+        python-version: [ "3.9", "3.10", "3.11", "3.12" ]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install -r requirements-dev.txt
-          pip install build twine torch torchvision
+          python3 -m pip install --upgrade pip
+          python3 -m pip install --no-cache-dir -e .[dev]
+          python3 -m pip install --no-cache-dir build twine torch torchvision
       - name: Run wheel build
         run: python3 -m build --wheel

.gitignore

@@ -150,4 +150,20 @@ wrksp/*
 # Jupyter Notebook
 .ipynb_checkpoints
 
-nvflare/dashboard/application/static/**/*
+# nvflare/dashboard/application/static/**/*
+
+# ide
+.idea/
+.ipynb_checkpoints/
+
+# nvflare artifacts
+log.txt
+client_token.txt
+*.fl
+audit.log
+*.crt
+.__nvfl_sig.json
+
+# python
+__pycache__
+.pyc

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "integration/xgboost/encryption_plugins/cuda_plugin/CGBN"]
+	path = integration/xgboost/encryption_plugins/cuda_plugin/CGBN
+	url = https://github.com/NVlabs/CGBN.git