Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

experimental: support for power spectrum data #164

Closed
wants to merge 1 commit into from
Closed

Conversation

wcxve
Copy link
Owner

@wcxve wcxve commented Feb 21, 2025

Summary by Sourcery

This pull request introduces support for power spectrum data analysis by implementing the Whittle likelihood function. It includes a custom exponential distribution (BetterExponential) and integrates the new likelihood into the existing inference and plotting framework. It also adds a check to ensure that the quantile residuals are finite.

New Features:

  • Adds support for the Whittle likelihood function, enabling power spectrum (periodogram) analysis.

Enhancements:

  • Introduces a BetterExponential distribution for improved handling of exponential distributions in the context of the Whittle likelihood.

Tests:

  • Adds an assertion to check that the quantile residuals are finite.

Copy link

sourcery-ai bot commented Feb 21, 2025

Reviewer's Guide by Sourcery

This pull request introduces support for the Whittle likelihood, enabling the analysis of power spectrum data. It includes a new likelihood function, a custom exponential distribution, and updates to data handling, simulation, and plotting functions to accommodate the new statistic.

Updated class diagram for Statistic enum

classDiagram
    class Statistic {
      <<enumeration>>
      chi2
      cstat
      pstat
      pgstat
      wstat
      whittle
    }
Loading

File-Level Changes

Change Details Files
Added support for the 'whittle' statistic for power spectrum data, including a new likelihood function and modifications to data handling and simulation.
  • Added 'whittle' to the Statistic type.
  • Implemented the whittle likelihood function.
  • Added a BetterExponential distribution for use with the Whittle likelihood.
  • Modified get_counts_data to handle 'whittle' statistic.
  • Added 'exp' as a possible distribution for data simulation.
  • Updated simulate to include the whittle likelihood.
  • Modified get_stat to include a check for the validity of using the whittle statistic.
  • Modified _pearson_residuals to handle 'whittle' statistic.
  • Modified quantile_residuals_mle to assert that the residuals are finite.
  • Modified pit to handle 'whittle' statistic.
src/elisa/infer/likelihood.py
src/elisa/infer/helper.py
src/elisa/plot/data.py
src/elisa/infer/fit.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

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

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

Overall Comments:

  • Consider adding a short example demonstrating how to use the new whittle likelihood.
  • The BetterExponential class could be simplified by directly calculating the log probability instead of using jnp.log.
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 ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@wcxve wcxve closed this Feb 21, 2025
@wcxve wcxve deleted the power-spectra branch February 21, 2025 18:08
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