Add (result, info) tuple return pattern for simulate/gen_images#30
Closed
Add (result, info) tuple return pattern for simulate/gen_images#30
Conversation
Add SimInfo and ImageInfo structs for returning metadata alongside primary results, following the ecosystem convention. Changes: - Add src/core/info_types.jl with SimInfo and ImageInfo structs - simulate(::StaticSMLMParams) now returns (smld_noisy, SimInfo) - info.smld_true and info.smld_model provide ground truth/kinetic model - simulate(::DiffusionSMLMParams) now returns (smld, SimInfo) - gen_images() and gen_image() now return (images/image, ImageInfo) - All info structs include elapsed_ns timing, backend, device_id - Export SimInfo and ImageInfo from main module - Update all tests to use new tuple return format Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Update README.md with new tuple returns for simulate() and gen_images() - Update api_overview.md with SimInfo and ImageInfo documentation - Update docs/src/index.md quick start examples - Update docs/src/static/overview.md and examples.md - Update docs/src/diffusion/overview.md and examples.md - Update docs/src/images.md with ImageInfo return type All functions now return (result, info) tuples: - simulate() returns (smld_noisy, SimInfo) where info contains smld_true, smld_model - gen_images() returns (images, ImageInfo) with timing and statistics Co-Authored-By: Claude Opus 4.5 <[email protected]>
Minor version bump for new (result, info) tuple return pattern API. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Member
Author
|
Reverting tuple-pattern rollout - starting fresh |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
simulate()to return(smld_noisy, SimInfo)tuple whereSimInfocontainssmld_true,smld_model, timing infogen_images()to return(images, ImageInfo)tuple with timing and statisticsBreaking Changes
Functions now return tuples instead of single values:
Test plan
🤖 Generated with Claude Code