Skip to content

Improved documentation and usability for new contributors#200

Open
DhruvrajSinhZala24 wants to merge 1 commit intoML4SCI:mainfrom
DhruvrajSinhZala24:improve-docs-and-usability
Open

Improved documentation and usability for new contributors#200
DhruvrajSinhZala24 wants to merge 1 commit intoML4SCI:mainfrom
DhruvrajSinhZala24:improve-docs-and-usability

Conversation

@DhruvrajSinhZala24
Copy link

Summary

  • Improved top-level and project-specific documentation for beginners
  • Added comments and safer dataset-loading logic in a Python utility
  • Added structure and explanations to the evaluation notebook
  • Fixed notebook config paths for the vanilla workflow

Details

  • Added a beginner-friendly project overview and step-by-step "How to Run" section to the root README
  • Corrected invalid install commands and improved wording in the physics-informed super-resolution README
  • Updated the LensingDataset loader with clearer variable names, inline comments, missing-file checks, and safer normalization behavior
  • Added markdown titles and explanations throughout the evaluation notebook to make the workflow easier to follow
  • Corrected config.json paths in the affected vanilla notebooks

Validation

  • Verified DeepLense_Physics_Informed_Super_Resolution_Anirudh_Shankar/vanilla/data.py with python3 -m py_compile
  • Validated edited notebooks as JSON
  • Did not run the full notebook workflow end-to-end because the required evaluation dataset files are not present in this checkout

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