google-deepmind / google-deepmind/deepmind-research

Add beginner-friendly explanatory comments (educational use case)

Open
#664 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
Jupyter Notebook
Stars
15.2k
Forks
2.9k
PR merge metrics
No merged PRs in 30d

Description

Hi 👋,

I used Learning mesh-based simulation with Graph Networks code as part of my scientific machine learning final project, and while working through it, I added some inline comments for myself to better understand the flow, assumptions, and math behind the implementation.

These comments don’t change functionality — they’re purely explanatory — but they helped me significantly in building intuition, and I believe they could be useful for other beginners or students using this code for learning.

This isn’t addressing a listed issue, so I wanted to ask first: would you be open to a PR that adds optional beginner-friendly comments?

Happy to:
• keep comments concise
• follow the project’s style
• limit changes strictly to documentation/comments

Thanks for maintaining this project!

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.