Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
__pycache__
*.pyc
*.pyo
*.pyd
.Python
env
pip-log.txt
pip-delete-this-directory.txt
.tox
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
*.log
.git
**/*.nemo
**/*.ckpt
4 changes: 4 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.github/ @nvidia-nemo/automation
docker/ @nvidia-nemo/automation
pyproject.toml @nvidia-nemo/automation
uv.lock @nvidia-nemo/automation
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

**Describe the bug**

A clear and concise description of what the bug is.

**Steps/Code to reproduce bug**

Please list *minimal* steps or code snippet for us to be able to reproduce the bug.

A helpful guide on on how to craft a minimal bug report http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports.


**Expected behavior**

A clear and concise description of what you expected to happen.

**Environment overview (please complete the following information)**

- Environment location: [Bare-metal, Docker, Cloud(specify cloud provider - AWS, Azure, GCP, Collab)]
- Method of install: [pip install or from source]. Please specify exact commands you used to install.
- If method of install is [Docker], provide `docker pull` & `docker run` commands used

**Environment details**

If NVIDIA docker image is used you don't need to specify these.
Otherwise, please provide:
- OS version
- PyTorch version
- Python version

**Additional context**

Add any other context about the problem here.
Example: GPU model
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: feature request
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.
Provide a code snippet on how new APIs/changes would be used by others.

**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
251 changes: 251 additions & 0 deletions .github/actions/test-template/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,251 @@
# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
#
# 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: "Test Template"
description: "Template for running NeMo tests in a containerized environment"

inputs:
runner:
description: "Runner to use for test"
required: true
timeout:
description: "Max runtime of test in minutes"
required: false
default: "10"
script:
description: "Test script to execute"
required: true
is_optional:
description: "Failure will cancel all other tests if set to true"
required: false
default: "false"
is_unit_test:
description: "Upload coverage as unit test"
required: false
default: "false"
image:
description: "Image to use for test"
required: false
default: "llm_shower"
cpu-only:
description: "Run tests on CPU only"
required: false
default: "false"
azure-client-id:
description: "Azure Client ID"
required: true
azure-tenant-id:
description: "Azure Tenant ID"
required: true
azure-subscription-id:
description: "Azure Subscription ID"
required: true
has-azure-credentials:
description: "Has Azure credentials"
required: false
default: "false"

runs:
using: "composite"
steps:
- name: Install Azure CLI
if: ${{ inputs.has-azure-credentials == 'true' }}
shell: bash
run: |
curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash

- name: Azure Login
if: ${{ inputs.has-azure-credentials == 'true' }}
uses: azure/login@v2
with:
client-id: ${{ inputs.azure-client-id }}
tenant-id: ${{ inputs.azure-tenant-id }}
subscription-id: ${{ inputs.azure-subscription-id }}

- name: Azure ACR Login
if: ${{ inputs.has-azure-credentials == 'true' }}
shell: bash
run: |
az acr login --name nemoci

- name: Azure Fileshare
if: ${{ inputs.has-azure-credentials == 'true' && inputs.is_unit_test == 'false' }}
shell: bash
id: azure-fileshare
run: |
sudo apt update
sudo apt install -y cifs-utils

RESOURCE_GROUP_NAME="azure-gpu-vm-runner_group"
STORAGE_ACCOUNT_NAME="nemocistorageaccount2"
FILE_SHARE_NAME="fileshare"

MNT_ROOT="/media"
MNT_PATH="$MNT_ROOT/$STORAGE_ACCOUNT_NAME/$FILE_SHARE_NAME"

echo "MNT_PATH=$MNT_PATH" | tee -a "$GITHUB_OUTPUT"

sudo mkdir -p $MNT_PATH

# Create a folder to store the credentials for this storage account and
# any other that you might set up.
CREDENTIAL_ROOT="/etc/smbcredentials"
sudo mkdir -p "/etc/smbcredentials"

# Get the storage account key for the indicated storage account.
# You must be logged in with az login and your user identity must have
# permissions to list the storage account keys for this command to work.
STORAGE_ACCOUNT_KEY=$(az storage account keys list \
--resource-group $RESOURCE_GROUP_NAME \
--account-name $STORAGE_ACCOUNT_NAME \
--query "[0].value" --output tsv | tr -d '"')

# Create the credential file for this individual storage account
SMB_CREDENTIAL_FILE="$CREDENTIAL_ROOT/$STORAGE_ACCOUNT_NAME.cred"
if [ ! -f $SMB_CREDENTIAL_FILE ]; then
echo "username=$STORAGE_ACCOUNT_NAME" | sudo tee $SMB_CREDENTIAL_FILE > /dev/null
echo "password=$STORAGE_ACCOUNT_KEY" | sudo tee -a $SMB_CREDENTIAL_FILE > /dev/null
else
echo "The credential file $SMB_CREDENTIAL_FILE already exists, and was not modified."
fi

# Change permissions on the credential file so only root can read or modify the password file.
sudo chmod 600 $SMB_CREDENTIAL_FILE

# This command assumes you have logged in with az login
HTTP_ENDPOINT=$(az storage account show --resource-group $RESOURCE_GROUP_NAME --name $STORAGE_ACCOUNT_NAME --query "primaryEndpoints.file" --output tsv | tr -d '"')
SMB_PATH=$(echo $HTTP_ENDPOINT | cut -c7-${#HTTP_ENDPOINT})$FILE_SHARE_NAME

STORAGE_ACCOUNT_KEY=$(az storage account keys list --resource-group $RESOURCE_GROUP_NAME --account-name $STORAGE_ACCOUNT_NAME --query "[0].value" --output tsv | tr -d '"')

sudo mount -t cifs $SMB_PATH $MNT_PATH -o credentials=$SMB_CREDENTIAL_FILE,serverino,nosharesock,actimeo=30,mfsymlinks

ls -al $MNT_PATH/TestData

- name: Docker pull image
shell: bash
run: |
docker pull nemoci.azurecr.io/${{ inputs.image }}:${{ github.run_id }}

- name: Checkout repository
uses: actions/checkout@v2
with:
path: LLM-Shower

- name: Start container
shell: bash
run: |
MNT_PATH=${{ steps.azure-fileshare.outputs.mnt_path }}

ARG=("")
if [[ "${{ inputs.cpu-only }}" == "false" ]]; then
ARG=("--runtime=nvidia --gpus all")
fi

cmd=$(cat <<RUN_TEST_EOF
#!/bin/bash
docker container rm -f nemo_container_${{ github.run_id }} || true
docker run \
--rm \
-d \
--name nemo_container_${{ github.run_id }} ${ARG[@]} \
--shm-size=64g \
--env TRANSFORMERS_OFFLINE=0 \
--env HYDRA_FULL_ERROR=1 \
--env HF_HOME=/home/TestData/HF_HOME \
--env RUN_ID=${{ github.run_id }} \
--volume $(pwd)/LLM-Shower:/workspace \
--volume $MNT_PATH/TestData:/home/TestData \
nemoci.azurecr.io/${{ inputs.image }}:${{ github.run_id }} \
bash -c "sleep $(( ${{ inputs.timeout }} * 60 + 60))"
RUN_TEST_EOF
)

echo "$cmd" | tee "retry_job.sh"
bash retry_job.sh

- name: Create run-script
id: create
shell: bash
run: |
COVERAGE_PREFIX=$([[ "${{ inputs.is_unit_test }}" == "true" ]] && echo "unit-test" || echo "e2e")
echo "coverage-prefix=$COVERAGE_PREFIX" | tee -a "$GITHUB_OUTPUT"

cmd=$(cat <<RUN_TEST_EOF
#!/bin/bash

(
set -e

docker exec -t nemo_container_${{ github.run_id }} bash -c '\
uv pip install --no-deps -e . && \
bash tests/${{ inputs.is_unit_test == 'true' && 'unit_tests' || 'functional_tests' }}/${{ inputs.script }}.sh && \
echo "Finished successfully." || echo "Did not finish."'
) 2>&1 | tee err.log

RUN_TEST_EOF
)

echo "timeout_in_seconds=$(( ${{ inputs.timeout }} * 60 ))" | tee -a "$GITHUB_OUTPUT"
echo "$cmd" | tee "job.sh"

- name: Run main script
uses: nick-fields/retry@v3
with:
timeout_seconds: ${{ steps.create.outputs.timeout_in_seconds }}
max_attempts: 3
shell: bash
retry_on: timeout
command: /bin/bash job.sh
on_retry_command: /bin/bash retry_job.sh

- name: Check result
id: check
shell: bash
run: |
docker exec nemo_container_${{ github.run_id }} coverage combine || true
docker exec nemo_container_${{ github.run_id }} coverage xml
docker cp nemo_container_${{ github.run_id }}:/workspace/.coverage .coverage
docker cp nemo_container_${{ github.run_id }}:/workspace/coverage.xml coverage.xml

coverage_report=coverage-${{ steps.create.outputs.coverage-prefix }}-${{ github.run_id }}-$(uuidgen)
echo "coverage_report=$coverage_report" >> "$GITHUB_OUTPUT"

IS_SUCCESS=$(tail -n 1 err.log | grep -q "Finished successfully." && echo "true" || echo "false")

if [[ "$IS_SUCCESS" == "false" && "{% raw %}${{ inputs.is_optional }}" == "true" ]]; then
echo "::warning:: Test failed, but displayed as successful because it is marked as optional."
IS_SUCCESS=true
fi

if [[ "$IS_SUCCESS" == "false" ]]; then
echo Test did not finish successfully.
exit 1
fi

exit $EXIT_CODE

- name: Test coverage
shell: bash -x -e -u -o pipefail {0}
run: |
docker exec -t nemo_container_${{ github.run_id }} coverage report -i

- name: Upload artifacts
uses: actions/upload-artifact@v4
if: ${{ steps.check.outputs.coverage_report != 'none' }}
with:
name: ${{ steps.check.outputs.coverage_report }}
path: |
coverage.xml
.coverage
include-hidden-files: true
Loading