Add std to MLEFlux, MLELumin, and MLEEiso

[wcxve]

Summary by Sourcery

New Features:

• Adds the standard deviation to the MLEFlux, MLELumin, and MLEEiso named tuples.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request adds the standard deviation ('std') as a property to the MLEFlux, MLELumin, and MLEEiso NamedTuples. The standard deviation is calculated using the Hessian matrix of the likelihood function.

Updated class diagram for MLEFlux

classDiagram
    class MLEFlux {
        <<NamedTuple>>
        mle: dict[str, Q] | dict[str, dict[str, Q]]
        std: dict[str, Q] | dict[str, dict[str, Q]]
        intervals: dict[str, tuple[Q, Q]] | dict[str, dict[str, tuple[Q, Q]]]
        errors: dict[str, tuple[Q, Q]] | dict[str, dict[str, tuple[Q, Q]]]
        cl: float
    }
    note for MLEFlux "Added 'std' field"

Loading

Updated class diagram for MLELumin

classDiagram
    class MLELumin {
        <<NamedTuple>>
        mle: dict[str, Q] | dict[str, dict[str, Q]]
        std: dict[str, Q] | dict[str, dict[str, Q]]
        intervals: dict[str, tuple[Q, Q]] | dict[str, dict[str, tuple[Q, Q]]]
        errors: dict[str, tuple[Q, Q]] | dict[str, dict[str, tuple[Q, Q]]]
        cl: float
    }
    note for MLELumin "Added 'std' field"

Loading

Updated class diagram for MLEEiso

classDiagram
    class MLEEiso {
        <<NamedTuple>>
        cosmo: Cosmology
        mle: dict[str, Q] | dict[str, dict[str, Q]]
        std: dict[str, Q] | dict[str, dict[str, Q]]
        intervals: dict[str, tuple[Q, Q]] | dict[str, dict[str, tuple[Q, Q]]]
    }
    note for MLEEiso "Added 'std' field"

Loading

File-Level Changes

Change	Details	Files
Add 'std' to MLEFlux, MLELumin, and MLEEiso NamedTuples.	Added 'std' property to MLEFlux NamedTuple. Added 'std' property to MLELumin NamedTuple. Added 'std' property to MLEEiso NamedTuple.	src/elisa/infer/results.py
Calculate and return the standard deviation of the model flux.	Calculated the covariance matrix using the Hessian method. Calculated the standard deviation from the covariance matrix. Added the standard deviation to the returned dictionary.	src/elisa/infer/results.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @wcxve - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider adding a unit test to verify the correctness of the calculated standard deviations.
• It might be helpful to add a brief explanation of how the standard deviation is calculated (e.g., from the Hessian) in the docstring.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}