Testing and validating ci with data from huggingface

Author: coreyjadams

.github/actions/bootstrap-cudnn-ci/action.yml

@@ -38,6 +38,14 @@ runs:
         ln -sf /usr/bin/python3 /usr/bin/python
         rm -rf /var/lib/apt/lists/*
 
+    - name: Install Hugging Face CLI
+      shell: bash
+      env:
+        PIP_BREAK_SYSTEM_PACKAGES: "1"
+      run: |
+        set -euo pipefail
+        pip install --quiet huggingface_hub[hf_xet]
+
     - name: Install uv (pinned)
       shell: bash
       env:

.github/actions/download-ci-data/action.yml

@@ -0,0 +1,80 @@
+# SPDX-FileCopyrightText: Copyright (c) 2023 - 2026 NVIDIA CORPORATION & AFFILIATES.
+# SPDX-FileCopyrightText: All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# 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.
+
+name: Download CI test data
+description: |
+  Download PhysicsNeMo CI test data from a private Hugging Face dataset
+  repository and export TEST_DATA_DIR for the pytest nfs_data_dir fixture.
+
+inputs:
+  hf-token:
+    description: Hugging Face token with read access to the CI data repo
+    required: true
+  hf-repo:
+    description: Hugging Face dataset repo ID
+    required: false
+    default: "NVIDIA/PhysicsNeMo-CI-Data"
+  data-dir:
+    description: |
+      Parent directory for the downloaded data.  The dataset contents land
+      in <data-dir>/physicsnemo-data/.  Defaults to $RUNNER_TEMP if set, else /tmp.
+    required: false
+    default: ""
+
+outputs:
+  test-data-dir:
+    description: The parent directory containing physicsnemo-data/ (set as TEST_DATA_DIR)
+    value: ${{ steps.download.outputs.test_data_dir }}
+
+runs:
+  using: composite
+  steps:
+    - name: Download CI test data from Hugging Face
+      id: download
+      shell: bash
+      env:
+        HF_TOKEN: ${{ inputs.hf-token }}
+        # Needed for Ubuntu 24.04+ containers where system python is
+        # externally-managed (PEP 668).
+        PIP_BREAK_SYSTEM_PACKAGES: "1"
+      run: |
+        set -euo pipefail
+        data_dir="${{ inputs.data-dir }}"
+        if [ -z "$data_dir" ]; then
+          data_dir="${RUNNER_TEMP:-/tmp}"
+        fi
+
+        if ! command -v huggingface-cli >/dev/null 2>&1; then
+          pip install --quiet huggingface_hub[hf_xet]
+        fi
+        huggingface-cli download "${{ inputs.hf-repo }}" \
+          --repo-type dataset \
+          --local-dir "${data_dir}/physicsnemo-data" \
+          --token "$HF_TOKEN"
+
+        echo "test_data_dir=${data_dir}" >> "$GITHUB_OUTPUT"
+        echo "TEST_DATA_DIR=${data_dir}" >> "$GITHUB_ENV"
+
+        # Verify the download produced the expected directory structure.
+        # conftest.py resolves TEST_DATA_DIR/physicsnemo-data/datasets/...
+        if [ ! -d "${data_dir}/physicsnemo-data/datasets" ]; then
+          echo "::error::Expected ${data_dir}/physicsnemo-data/datasets/ but it does not exist."
+          echo "Contents of ${data_dir}/physicsnemo-data/:"
+          ls -la "${data_dir}/physicsnemo-data/" 2>/dev/null || echo "  (directory missing entirely)"
+          exit 1
+        fi
+        echo "Downloaded CI test data to ${data_dir}/physicsnemo-data/"
+        ls "${data_dir}/physicsnemo-data/datasets/"

.github/workflows/github-nightly-uv.yml

@@ -248,6 +248,11 @@ jobs:
         uv-cache-key-suffix: "latest"
         extras: ${{ env.EXTRAS_TAG }}
 
+    - name: Download CI test data
+      uses: ./.github/actions/download-ci-data
+      with:
+        hf-token: ${{ secrets.HF_CI_DATA_TOKEN }}
+
     - name: Run core tests (collect all for testmon)
       run: |
         # Workflow-level UV_NO_SYNC=1 + UV_FROZEN=1 keep `uv run` strictly
@@ -287,6 +292,11 @@ jobs:
         uv-cache-key-suffix: "latest"
         extras: ${{ env.EXTRAS_TAG }}
 
+    - name: Download CI test data
+      uses: ./.github/actions/download-ci-data
+      with:
+        hf-token: ${{ secrets.HF_CI_DATA_TOKEN }}
+
     - name: Run core tests for coverage report
       run: |
         # See note in testmon job re: workflow-level UV_NO_SYNC / UV_FROZEN.

.github/workflows/github-pr.yml

@@ -117,6 +117,11 @@ jobs:
         restore-keys: |
           ${{ env.TESTMON_CACHE_KEY_PREFIX }}-
 
+    - name: Download CI test data
+      uses: ./.github/actions/download-ci-data
+      with:
+        hf-token: ${{ secrets.HF_CI_DATA_TOKEN }}
+
     - name: Run core tests (with testmon)
       run: |
         uv run --no-sync python -m pytest --testmon --ignore-glob="*docs*" --ignore-glob="*examples*"
@@ -164,6 +169,11 @@ jobs:
         restore-keys: |
           ${{ env.COVERAGE_CACHE_KEY_PREFIX }}-
 
+    - name: Download CI test data
+      uses: ./.github/actions/download-ci-data
+      with:
+        hf-token: ${{ secrets.HF_CI_DATA_TOKEN }}
+
     - name: Run core tests for coverage report (testmon-selected)
       run: |
         uv run --no-sync coverage run --rcfile='test/coverage.pytest.rc' -m pytest --testmon --ignore-glob="*docs*" --ignore-glob="*examples*"

Makefile

@@ -10,8 +10,8 @@ editable-install:
 get-data:
 	test -n "$(TEST_DATA_DIR)" || { echo "Error: TEST_DATA_DIR should be set"; exit 1; }
 	mkdir -p $(TEST_DATA_DIR) && \
-	rm -rf $(TEST_DATA_DIR)/modulus-data && \
-	git clone https://gitlab-master.nvidia.com/modulus/modulus-data.git $(TEST_DATA_DIR)/modulus-data && \
+	rm -rf $(TEST_DATA_DIR)/physicsnemo-data && \
+	git clone https://gitlab-master.nvidia.com/modulus/modulus-data.git $(TEST_DATA_DIR)/physicsnemo-data && \
 	echo "Test data has been saved in ${TEST_DATA_DIR}"
 
 setup-ci:

test/conftest.py

@@ -41,7 +41,7 @@
 from packaging.requirements import Requirement
 from packaging.version import Version
 
-NFS_DATA_PATH = "/data/nfs/modulus-data"
+NFS_DATA_PATH = "/data/nfs/physicsnemo-data"
 
 # Total time per file
 file_timings = defaultdict(float)
@@ -93,8 +93,8 @@ def nfs_data_dir(request):
     if nfs_data_dir_opt:
         data_dir = pathlib.Path(nfs_data_dir_opt)
     elif test_data_dir_env:
-        # get-data clones into $(TEST_DATA_DIR)/modulus-data
-        data_dir = pathlib.Path(test_data_dir_env) / "modulus-data"
+        # CI downloads into $(TEST_DATA_DIR)/physicsnemo-data
+        data_dir = pathlib.Path(test_data_dir_env) / "physicsnemo-data"
     else:
         data_dir = pathlib.Path(NFS_DATA_PATH)
     if not data_dir.exists():