208 replacing keyword arguments in single event likelihood by kazewong · Pull Request #237 · kazewong/jim

kazewong · 2025-07-14T19:44:06Z

The following summary is generated by copilot

This pull request includes updates to improve code readability, maintainability, and consistency across multiple files. Key changes involve renaming a likelihood class, reformatting function calls and asset specifications for better clarity, and updating string formatting and list definitions for consistency.

Code Refactoring and Renaming:

Replaced TransientLikelihoodFD with BaseTransientLikelihoodFD in example/workbench.py to align with updated naming conventions. ([[1]](https://github.com/kazewong/jim/pull/237/files#diff-dc32177a64e15860f96ba609e348511deb720d6890f1facac23d9e15f529fa80L18-R18), [[2]](https://github.com/kazewong/jim/pull/237/files#diff-dc32177a64e15860f96ba609e348511deb720d6890f1facac23d9e15f529fa80L210-L216))

Reformatting for Readability:

Reformatted multi-line function calls and asset specifications in jim_dagster/InjectionRecovery/assets.py to improve readability and align with PEP 8 guidelines. ([[1]](https://github.com/kazewong/jim/pull/237/files#diff-e28e009932d0c7d50250726a4ad0e3202111303bac58ad22fd591f4c6eb07dbeR82-R92), [[2]](https://github.com/kazewong/jim/pull/237/files#diff-e28e009932d0c7d50250726a4ad0e3202111303bac58ad22fd591f4c6eb07dbeR135-R181), [[3]](https://github.com/kazewong/jim/pull/237/files#diff-e28e009932d0c7d50250726a4ad0e3202111303bac58ad22fd591f4c6eb07dbeR192-R326))

String Formatting Consistency:

Updated single quotes to double quotes in jim_dagster/RealDataCatalog/assets.py for consistent string formatting. ([[1]](https://github.com/kazewong/jim/pull/237/files#diff-4dd60e2a0bf43ee079f8d8445ce651bcc75dc2427252fb2a9b524bbfef75e88bR15-R29), [[2]](https://github.com/kazewong/jim/pull/237/files#diff-4dd60e2a0bf43ee079f8d8445ce651bcc75dc2427252fb2a9b524bbfef75e88bL104-R108))

List and Code Block Formatting:

Reformatted long lists, such as parameter keys for corner plots, into multi-line definitions for better readability in jim_dagster/RealDataCatalog/assets.py. ([jim_dagster/RealDataCatalog/assets.pyL297-R350](https://github.com/kazewong/jim/pull/237/files#diff-4dd60e2a0bf43ee079f8d8445ce651bcc75dc2427252fb2a9b524bbfef75e88bL297-R350))
Improved formatting of multi-line comments and exception messages for clarity. ([jim_dagster/RealDataCatalog/assets.pyL175-R183](https://github.com/kazewong/jim/pull/237/files#diff-4dd60e2a0bf43ee079f8d8445ce651bcc75dc2427252fb2a9b524bbfef75e88bL175-R183))

Minor Adjustments:

Added blank lines to separate logical sections of code, enhancing visual clarity in several files. ([[1]](https://github.com/kazewong/jim/pull/237/files#diff-e28e009932d0c7d50250726a4ad0e3202111303bac58ad22fd591f4c6eb07dbeR22), [[2]](https://github.com/kazewong/jim/pull/237/files#diff-4dd60e2a0bf43ee079f8d8445ce651bcc75dc2427252fb2a9b524bbfef75e88bR97))

Add placeholder unit test for likelihood module

- Reformat long function calls and asset specs for clarity - Use consistent string quoting and indentation - Move assert error messages to multi-line format for readability - Add properties to SingleEventLikelihood for duration and detector names - Refactor likelihood classes for modularity and clarity

Add abstract _likelihood method to SingleEventLikelihood and refactor subclasses to implement core likelihood logic in _likelihood. Move parameter updates and fixed values to evaluate methods for clarity.

Expand unit tests for likelihood classes and add fixtures

coderabbitai · 2025-07-14T19:44:11Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

…parameters

thomasckng · 2025-07-15T06:47:14Z

src/jimgw/core/single_event/likelihood.py

-    ) -> None:
+    ):
+
        super().__init__(detectors, waveform, f_min, f_max, trigger_time)


The changes introduced a bug in this line. In line 93, f_min is treated as fixed_parameters and can be initialised without raising any errors. As a result, fixed_parameters ends up storing a float instead of a dict, again without triggering an error. This issue is partially addressed in #238, but further validation of fixed_parameters may still be necessary.

thomasckng · 2025-07-15T07:10:40Z

I also got an error at

jim/src/jimgw/core/single_event/likelihood.py

Line 602 in e6ae3d6

f_2D = jnp.broadcast_to(f, (f.size, gamma.size))

ValueError: Incompatible shapes for broadcasting: (259201,) and requested shape (259201, 11)

thomasckng · 2025-07-15T07:47:23Z

I also got an error at

jim/src/jimgw/core/single_event/likelihood.py

Line 602 in e6ae3d6

f_2D = jnp.broadcast_to(f, (f.size, gamma.size))
ValueError: Incompatible shapes for broadcasting: (259201,) and requested shape (259201, 11)

Found the problem. The fix is in #222.

Fix HeterodynedTransientLikelihoodFD initialization

kazewong added 14 commits July 12, 2025 09:39

Clean up formatting and remove unused import

b08e14b

Add placeholder unit test for likelihood module

Remove unused likelihood functions and refactor time marginalization

95d07ad

Add docstrings to TimeMarginalizedLikelihoodFD class and methods

e5153de

Update likelihood.py

92b7964

Add docstrings to BaseTransientLikelihoodFD class and methods

918fe9e

Add unit tests for BaseTransientLikelihoodFD class

ab782ca

Initiali refactoring of the likelihood class

e9b03c8

Update workbench.py

5eb4ffd

Refactor likelihood evaluation methods to use _likelihood

7f2bfe9

Add abstract _likelihood method to SingleEventLikelihood and refactor subclasses to implement core likelihood logic in _likelihood. Move parameter updates and fixed values to evaluate methods for clarity.

update heterodyne likelihood

85a3c15

ruff formatting

e38b8e7

update run interface

d69c0d2

Add evaluate method to HeterodynedPhaseMarginalizedLikelihoodFD

e6ae3d6

Expand unit tests for likelihood classes and add fixtures

Fix HeterodynedTransientLikelihoodFD initialization to include fixed_…

cbd7d82

…parameters

thomasckng reviewed Jul 15, 2025

View reviewed changes

kazewong added 2 commits July 15, 2025 08:47

Merge pull request #238 from kazewong/bugfix

d9cae2a

Fix HeterodynedTransientLikelihoodFD initialization

Refactor likelihood phase difference calculation and clean up code

ecd0a92

kazewong merged commit 2636d96 into jim-dev Jul 17, 2025
3 of 7 checks passed

kazewong deleted the 208-replacing-keyword-arguments-in-single_eventlikelihoodpy branch July 17, 2025 13:00

kazewong mentioned this pull request Jul 22, 2025

Bugfix and enhancement in heterodyned likelihood #222

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

208 replacing keyword arguments in single event likelihood#237

208 replacing keyword arguments in single event likelihood#237
kazewong merged 17 commits intojim-devfrom
208-replacing-keyword-arguments-in-single_eventlikelihoodpy

kazewong commented Jul 14, 2025

Uh oh!

coderabbitai bot commented Jul 14, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

thomasckng Jul 15, 2025

Uh oh!

thomasckng commented Jul 15, 2025

Uh oh!

thomasckng commented Jul 15, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

kazewong commented Jul 14, 2025

Code Refactoring and Renaming:

Reformatting for Readability:

String Formatting Consistency:

List and Code Block Formatting:

Minor Adjustments:

Uh oh!

coderabbitai bot commented Jul 14, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

thomasckng Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

thomasckng commented Jul 15, 2025

Uh oh!

thomasckng commented Jul 15, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

CodeRabbit Configuration File (`.coderabbit.yaml`)