Skip to content

Conversation

@gppezzi
Copy link
Collaborator

@gppezzi gppezzi commented Oct 1, 2025

@gppezzi gppezzi requested review from jgphpc and teojgo October 1, 2025 13:16
@gppezzi gppezzi added the documentation Improvements or additions to documentation label Oct 1, 2025
@jgphpc jgphpc requested a review from Copilot October 2, 2025 10:36
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds descriptive text (descr attribute) to various Alps test classes to improve test documentation and clarity. The changes focus on providing clear, concise descriptions for what each test validates or benchmarks.

  • Added descr attributes to test classes across multiple directories (system checks, microbenchmarks, container engine tests, and application tests)
  • Converted existing docstring to descr attribute for the SlurmGPUGresTest class
  • Enhanced test documentation for container engine tests, GPU/CPU burn tests, communication benchmarks, and PyTorch tests

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
checks/system/slurm/gres_gpu.py Converted docstring to descr attribute for Slurm GPU GRES test
checks/system/ce/ce_import_run_image.py Added descriptions for container engine import and run tests
checks/microbenchmarks/cpu_gpu/node_burn/node-burn-ce.py Added descriptions for GPU and CPU node burn GEMM and Stream tests
checks/containers/container_engine/xccl_tests.py Added descriptions for NCCL and RCCL communication tests
checks/containers/container_engine/ssh.py Added description for SSH availability check
checks/containers/container_engine/omb.py Added descriptions for OSU Micro-benchmarks tests
checks/containers/container_engine/cuda_mps.py Added description for CUDA MPS check
checks/containers/container_engine/check_cuda_nbody.py Added description for CUDA N-Body test
checks/apps/pytorch/pytorch_megatronlm.py Added description for Megatron LM tests
checks/apps/pytorch/pytorch_allreduce.py Added descriptions for PyTorch all-reduce benchmarks

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

'aws_ofi_nccl.enabled': 'true',
'aws_ofi_nccl.variant': 'cuda12',
},
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
}


@run_after('setup')
def set_executable_opts(self):
self.prerun_cmds = ['wget https://jfrog.svc.cscs.ch/artifactory/cscs-reframe-tests/PyTorch/all_reduce_bench.py'] # noqa: E501
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
self.prerun_cmds = ['wget https://jfrog.svc.cscs.ch/artifactory/cscs-reframe-tests/PyTorch/all_reduce_bench.py'] # noqa: E501

@performance_function('GB/s')
def bandwidth(self):
return sn.extractsingle(r'\|\s*16GiB\s*\|\s*(?P<busbw>\S+)GBps\s*\|',
self.stdout, tag='busbw', conv=float
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
self.stdout, tag='busbw', conv=float)

@run_after('setup')
def set_nccl_min_nchannels(self):
gpu_devices = self.current_partition.select_devices('gpu')[0]

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

@sanity_function
def assert_sanity(self):
return sn.assert_found(r'^\d+ /opt/oci-hooks/ssh/dropbear/bin/dropbear.*-p 15263.*$', self.stdout)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

Copy link
Collaborator

@jgphpc jgphpc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok (with formatting changes)

@gppezzi gppezzi changed the title [draft] Adding descriptions to Alps tests Adding descriptions to Alps tests (first round) Oct 2, 2025
@jgphpc jgphpc merged commit 33a3980 into main Oct 2, 2025
3 checks passed
@jgphpc jgphpc deleted the add-descriptions branch October 2, 2025 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants