Skip to content

Add a GPU-based benchmarking workflow#477

Merged
shi-eric merged 1 commit into
newton-physics:mainfrom
shi-eric:ershi/asv-gpu-workflow
Jul 27, 2025
Merged

Add a GPU-based benchmarking workflow#477
shi-eric merged 1 commit into
newton-physics:mainfrom
shi-eric:ershi/asv-gpu-workflow

Conversation

@shi-eric

@shi-eric shi-eric commented Jul 27, 2025

Copy link
Copy Markdown
Member

Description

This replaces the CPU-only ASV workflow with a GPU-based workflow using EC2 instances.

Log-downloading logic has been revised.

Instances have been moved to a g6e.xlarge.

Newton Migration Guide

Please ensure the migration guide for warp.sim users is up-to-date with the changes made in this MR.

  • The migration guide in docs/migration.rst is up-to date

Before your PR is "Ready for review"

  • All commits are signed-off to indicate that your contribution adheres to the Developer Certificate of Origin requirements
  • Necessary tests have been added and new examples are tested (see newton/tests/test_examples.py)
  • Documentation is up-to-date
  • Code passes formatting and linting checks with pre-commit run -a

Summary by CodeRabbit

  • Chores
    • Removed the previous benchmark workflow for pull requests.
    • Added a new GPU benchmarking workflow for pull requests, including secure AWS resource management and automated cleanup.
    • Updated GPU test workflows to use a newer EC2 instance type and improved log retrieval by utilizing SSM combined output logs instead of manual log file handling.
    • Renamed test artifacts for consistency across workflows.

Signed-off-by: Eric Shi <ershi@nvidia.com>
@coderabbitai

coderabbitai Bot commented Jul 27, 2025

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The changes remove the existing ASV benchmark workflow (pr_asv.yml), introduce a new GPU benchmark workflow running on AWS EC2 instances (pr_aws_gpu_asv.yml), and update the AWS GPU test workflows (pr_aws_gpu_tests.yml, push_aws_gpu_tests.yml) to use a new EC2 instance type, improve artifact naming, and streamline log retrieval by leveraging SSM combined output logs.

Changes

File(s) Change Summary
.github/workflows/pr_asv.yml Deleted the ASV benchmark workflow for pull requests.
.github/workflows/pr_aws_gpu_asv.yml Added a new workflow for running GPU benchmarks on AWS EC2 with jobs for author membership, benchmarks, and cleanup.
.github/workflows/pr_aws_gpu_tests.yml
.github/workflows/push_aws_gpu_tests.yml
Updated EC2 instance type to g6e.xlarge, changed artifact naming, removed custom log/status handling, and now use SSM combined output logs for test output retrieval.

Sequence Diagram(s)

sequenceDiagram
    participant GitHubActions
    participant Author
    participant AWS
    participant EC2Instance
    participant S3

    GitHubActions->>Author: On PR to 'newton-physics/newton', check author membership
    GitHubActions->>AWS: Assume IAM role and find latest GPU AMI
    GitHubActions->>AWS: Launch EC2 GPU instance
    AWS->>EC2Instance: Start instance
    GitHubActions->>EC2Instance: Send benchmark script via SSM
    EC2Instance->>S3: Upload logs and results
    GitHubActions->>S3: Retrieve logs
    GitHubActions->>AWS: Terminate EC2 instance (cleanup)
Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~35 minutes

Suggested reviewers

  • eric-heiden

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 03b0d44 and 379b267.

📒 Files selected for processing (4)
  • .github/workflows/pr_asv.yml (0 hunks)
  • .github/workflows/pr_aws_gpu_asv.yml (1 hunks)
  • .github/workflows/pr_aws_gpu_tests.yml (7 hunks)
  • .github/workflows/push_aws_gpu_tests.yml (6 hunks)
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@shi-eric shi-eric merged commit 3f8ffc2 into newton-physics:main Jul 27, 2025
7 of 8 checks passed
@shi-eric shi-eric deleted the ershi/asv-gpu-workflow branch July 27, 2025 08:47
vidurv-nvidia pushed a commit to vidurv-nvidia/newton that referenced this pull request Mar 6, 2026
…ics#477)

# Description

Fixes in Cosmos-Mimic (Augmented Imitation Learning) documentation:
1. Corrected the command specified for the Mimic data generation step to
use CPU instead of GPU.
2. Added link to specific Cosmos example to follow for Cosmos
generation/augmentation step.

## Type of change

- Bug fix (non-breaking change which fixes an issue)
- This change requires a documentation update

## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.sh --format`
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file
- [x] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there
@coderabbitai coderabbitai Bot mentioned this pull request Mar 12, 2026
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant