Skip to content

500 optimization err only script #235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

curtischong
Copy link
Collaborator

@curtischong curtischong commented Aug 8, 2025

Summary

  • Feature 1
  • Fix 1

Checklist

Before a pull request can be merged, the following items must be checked:

  • Doc strings have been added in the Google docstring format.
  • Run ruff on your code.
  • Run uvx ty check on the repo.
  • Tests have been added for any new functionality or bug fixes.

We highly recommended installing the pre-commit hooks running in CI locally to speedup the development process. Simply run pip install pre-commit && pre-commit install to install the hooks which will check your code before each commit.

Summary by CodeRabbit

  • New Features

    • Added a script for batched structure optimization of Zn-based materials using a machine learning potential model.
    • Introduced a script for generating and relaxing random atomic structures for specified compositions, supporting density and volume scaling options.
  • Bug Fixes

    • Improved initial batch handling in automatic batching, increasing the number of states included in the first batch.
  • Chores

    • Updated model checkpoint URLs to use specific versioned files for improved reliability in model loading.

t-reents and others added 4 commits July 17, 2025 16:54
The `velocities` and `cell_velocities` are initialized to `None` in the `(FrechetCell)FIREState`. However, when using the `InFlightAutoBatcher` during an optimization, the current and new states are concatenated in `torch_sim.state.concatenate_states`. When trying to merge states that were already processed for a few iterations (i.e., velocities are not None anymore) and newly initialized ones, an error is raised because the code tries to merge a `Tensor` with a `None`.

Here, we initialize the `(cell_)velocities` as tensors full of `nan` instead, so that one can merge already processed and newly initialized states. During the first initialization, the `fire` methods look for `nan` rows and replace them with zeros.
@cla-bot cla-bot bot added the cla-signed Contributor license agreement signed label Aug 8, 2025
Copy link

coderabbitai bot commented Aug 8, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Two new scripts were added: one for generating and relaxing random Zn-based structures, and another for batched structure optimization using a MACE model. Model checkpoint URLs were updated to versioned links in both the test and model code. The autobatching logic was adjusted to increase the number of states in the initial batch during simulation by fetching additional states after memory scaler finalization.

Changes

Cohort / File(s) Change Summary
New Structure Generation Script
examples/scripts/create_zn_structure.py
Introduces utilities for generating random atomic structures, computing box sizes, packing with soft-sphere potentials, and relaxing with the ORB model. Provides functions and constants for structure creation and relaxation.
New Batched Optimization Script
examples/scripts/500_err.py
Adds a script to generate 500 random Zn-based structures, initialize simulation states, load a MACE model, and run batched optimization using a force convergence criterion and the FIRE optimizer.
Model Checkpoint URL Updates
tests/models/test_metatomic.py, torch_sim/models/metatomic.py
Updates pretrained model checkpoint URLs from "latest" to a specific version "v1.1.0" in both test fixtures and model loader. No logic changes.
Autobatching Logic Adjustment
torch_sim/autobatching.py
Modifies batch initialization to fetch and append additional states after finalizing the memory scaler, increasing the number of states in the first batch.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Script (500_err.py)
    participant ModelLoader
    participant MaceModel
    participant Simulator

    User->>Script (500_err.py): Run script
    Script (500_err.py)->>ModelLoader: Load MACE model (from URL or checkpoint)
    ModelLoader-->>Script (500_err.py): Return model
    Script (500_err.py)->>MaceModel: Wrap model for forces/stress
    Script (500_err.py)->>Simulator: Generate 500 random Zn structures
    Script (500_err.py)->>Simulator: Initialize simulation state
    Script (500_err.py)->>Simulator: Run optimization (FIRE, convergence check)
    Simulator-->>Script (500_err.py): Return relaxed state
    Script (500_err.py)->>User: Print final state
Loading
sequenceDiagram
    participant User
    participant Script (create_zn_structure.py)
    participant Utils
    participant PyTorch/torch_sim

    User->>Script (create_zn_structure.py): Call structure generation function
    Script (create_zn_structure.py)->>Utils: Compute volume per atom, box size
    Script (create_zn_structure.py)->>Utils: Generate random structure
    Script (create_zn_structure.py)->>PyTorch/torch_sim: Pack with soft-sphere, relax with ORB model
    PyTorch/torch_sim-->>Script (create_zn_structure.py): Return relaxed structure
    Script (create_zn_structure.py)-->>User: Output SimState
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15–20 minutes

Poem

In the warren where atoms dance and spin,
New scripts appear, let simulations begin!
Zn structures packed, MACE models run,
URLs now versioned, the batcher’s more fun.
With every hop, our science grows bright—
A bunny’s delight in the data-filled night!
🐇✨

Note

🔌 MCP (Model Context Protocol) integration is now available in Early Access!

Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f6cd006 and 46c38c2.

📒 Files selected for processing (5)
  • examples/scripts/500_err.py (1 hunks)
  • examples/scripts/create_zn_structure.py (1 hunks)
  • tests/models/test_metatomic.py (1 hunks)
  • torch_sim/autobatching.py (1 hunks)
  • torch_sim/models/metatomic.py (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 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.
  • 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.

Support

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

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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@curtischong curtischong closed this Aug 8, 2025
@curtischong
Copy link
Collaborator Author

I opened this PR in the wrong repo. Cause PRs default upstream (which is really annoying https://github.com/orgs/community/discussions/11729)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed Contributor license agreement signed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants