Skip to content

Updated model with current best practices, added getting started notebook#5

Merged
drewoldag merged 4 commits intomainfrom
awo/update-2026-03-017
Mar 17, 2026
Merged

Updated model with current best practices, added getting started notebook#5
drewoldag merged 4 commits intomainfrom
awo/update-2026-03-017

Conversation

@drewoldag
Copy link
Collaborator

Updating the example model to show current Hyrax best practices.
Implemented a VGG11 model.
Created a getting started notebook that uses the VGG11 model and trains on HyraxCifar data - results in 70% accuracy.

…ted a getting started notebook that uses the model.
@drewoldag drewoldag self-assigned this Mar 17, 2026
Copilot AI review requested due to automatic review settings March 17, 2026 19:57
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@codecov
Copy link

codecov bot commented Mar 17, 2026

Codecov Report

❌ Patch coverage is 26.08696% with 51 lines in your changes missing coverage. Please review.
✅ Project coverage is 26.08%. Comparing base (a5fcd6a) to head (783593f).
⚠️ Report is 10 commits behind head on main.

Files with missing lines Patch % Lines
src/external_hyrax_example/models/vgg11.py 23.88% 51 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##              main       #5       +/-   ##
============================================
- Coverage   100.00%   26.08%   -73.92%     
============================================
  Files            2        2               
  Lines            6       69       +63     
============================================
+ Hits             6       18       +12     
- Misses           0       51       +51     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

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 updates the external Hyrax example package to showcase a more realistic CNN model (VGG11) and adds a pre-executed “getting started” notebook demonstrating training/inference on HyraxCifar data.

Changes:

  • Added a VGG11 PyTorch model registered via @hyrax_model, including train/validate/test/infer batch hooks.
  • Updated the package default config and public exports to use VGG11 instead of the removed ExampleModel.
  • Added a pre-executed notebook documenting end-to-end usage, and updated .gitignore for generated outputs/data.

Reviewed changes

Copilot reviewed 6 out of 7 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
src/external_hyrax_example/models/vgg11.py New VGG11 model implementation + Hyrax loop hooks and data preparation.
src/external_hyrax_example/example_model.py Removed the prior minimal example model.
src/external_hyrax_example/default_config.toml Switched default configuration structure to external_hyrax_example.VGG11.*.
src/external_hyrax_example/__init__.py Export VGG11 as the package public model.
pyproject.toml Added hyrax and torch dependencies.
docs/pre_executed/model_usage_example.ipynb Added a pre-executed notebook showing how to configure/train/infer/evaluate.
.gitignore Ignored Hyrax results directories and local data/.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

drewoldag and others added 3 commits March 17, 2026 13:06
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copy link

@mtauraso mtauraso left a comment

Choose a reason for hiding this comment

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

LGTM

@drewoldag drewoldag merged commit ec8c269 into main Mar 17, 2026
5 checks passed
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.

3 participants