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

Added test case for #73 and a fix #110

Merged
merged 5 commits into from
Aug 24, 2024
Merged

Added test case for #73 and a fix #110

merged 5 commits into from
Aug 24, 2024

Conversation

mmcdermott
Copy link
Collaborator

@mmcdermott mmcdermott commented Aug 22, 2024

Closes #73 as not reproducible.

Summary by CodeRabbit

  • Documentation
    • Improved clarity of the query function documentation.
    • Added new examples demonstrating valid usage of the query function, including configuration setups and sample outputs.
    • Enhanced documentation for the check_constraints function with a sample DataFrame and usage example.
    • Improved formatting and readability of the extract_subtree function documentation with updated examples.

Copy link
Contributor

coderabbitai bot commented Aug 22, 2024

Walkthrough

The changes involve enhancements to the docstring of the query function in src/aces/query.py, improving clarity and adding new examples to demonstrate valid usage. A new code block showcasing the check_constraints function with a sample DataFrame has been introduced in src/aces/constraints.py. Minor formatting adjustments were made in the extract_subtree function to improve code readability and ensure output uniqueness.

Changes

Files Change Summary
src/aces/query.py Updated docstring for the query function for clarity and added new usage examples.
src/aces/constraints.py Added usage example for the check_constraints function with a sample DataFrame.
src/aces/extract_subtree.py Reformatted method calls in the extract_subtree function for improved readability and ensured unique output.

Assessment against linked issues

Objective Addressed Explanation
Duplication of rows when using _ANY_EVENT (73) The changes do not address the duplication issue.

Poem

In the code where queries play,
A rabbit hops and guides the way.
With clearer docs, the path's now bright,
New examples shared, a joyful sight!
No more confusion, just pure delight! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @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.

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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

@mmcdermott mmcdermott mentioned this pull request Aug 22, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7c2c5cf and 418637e.

Files selected for processing (1)
  • src/aces/query.py (2 hunks)
Additional comments not posted (2)
src/aces/query.py (2)

34-34: Improved docstring clarity.

The modification to the docstring enhances clarity by indicating that the examples are limited.


45-71: Comprehensive examples added to docstring.

The addition of examples in the docstring significantly improves the usability and comprehensiveness of the documentation. These examples provide a clear demonstration of how to use the query function with valid input.

Copy link

codecov bot commented Aug 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Files Coverage Δ
src/aces/constraints.py 100.00% <ø> (ø)
src/aces/extract_subtree.py 94.59% <ø> (ø)
src/aces/query.py 93.61% <ø> (+4.25%) ⬆️

... and 2 files with indirect coverage changes

Copy link
Owner

@justin13601 justin13601 left a comment

Choose a reason for hiding this comment

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

So I think the config does capture @Oufattole's example, but the difference is in the predicates_df - his example has multiple rows with the same subject_id but different timestamp.

Changing it to:

predicates_df = pl.DataFrame({
    "subject_id": [1, 1, 3], # instead of [1, 2, 3]
    "timestamp": [datetime(1980, 12, 28), datetime(2010, 6, 20), datetime(2010, 5, 11)],
    "A": [False, False, False],
    "_ANY_EVENT": [True, True, True],
})

leads to the following with some duplicate rows:

    shape: (5, 2)
    ┌────────────┬─────────────────────┐
    │ subject_id ┆ trigger             │
    │ ---        ┆ ---                 │
    │ i64        ┆ datetime[μs]        │
    ╞════════════╪═════════════════════╡
    │ 1          ┆ 1980-12-28 00:00:00 │
    │ 1          ┆ 2010-06-20 00:00:00 │
    │ 1          ┆ 1980-12-28 00:00:00 │
    │ 1          ┆ 2010-06-20 00:00:00 │
    │ 3          ┆ 2010-05-11 00:00:00 │
    └────────────┴─────────────────────┘

I think that is where I got confused

@mmcdermott
Copy link
Collaborator Author

Ahh, I see, makes sense. I'll update the code.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 418637e and 3f4dbf8.

Files selected for processing (1)
  • src/aces/query.py (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/aces/query.py

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3f4dbf8 and 931a1af.

Files selected for processing (2)
  • src/aces/constraints.py (1 hunks)
  • src/aces/extract_subtree.py (2 hunks)
Files skipped from review due to trivial changes (1)
  • src/aces/extract_subtree.py
Additional comments not posted (3)
src/aces/constraints.py (3)

74-90: Example addition looks good!

The added example for check_constraints is clear and aligns well with the existing examples. It provides a useful demonstration of the function's usage.


Line range hint 10-72: Function implementation is solid.

The check_constraints function is well-implemented with clear logic and appropriate error handling. The logging provides useful insights into the filtering process.


Line range hint 93-149: Function implementation is solid.

The check_static_variables function is well-structured with efficient filtering logic using Polars expressions. The error handling and logging are appropriate.

@mmcdermott mmcdermott changed the title Added test case for #73 that fails to reproduce the issue. Added test case for #73 and a fix Aug 24, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 931a1af and 46690b4.

Files selected for processing (1)
  • src/aces/extract_subtree.py (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/aces/extract_subtree.py

@mmcdermott
Copy link
Collaborator Author

So I just pushed what I think is a fix in 46690b4

Basically, the fix takes the line:

        child_anchor_realizations = window_summary_df.select(
            "subject_id",
            pl.col("child_anchor_timestamp").alias("subtree_anchor_timestamp"),
        )

and adds

        child_anchor_realizations = window_summary_df.select(
            "subject_id",
            pl.col("child_anchor_timestamp").alias("subtree_anchor_timestamp"),
        ).unique()

Why is this appropriate? Because, there is literally no point to recursing on a dataframe where multiple rows are identical. If everything else is working appropriately, such an action should just likewise return a set of duplicate outputs. If two cases of possible child anchors are the same event in a patient's record, then we can stremaline subsequent window criteria checks by just analyzing those windows only once, instead of multiple times.

In any event bound window case, it is totally possible that multiple input windows with different subtree anchors will end at the same event in a patient's record. This means they'd have the same child_anchor_timestamp for subsequent iterations, even though they have different subtree_anchor_timestamps. In that case, it is appropriate to determine if the subtrees from that shared child anchor are valid only once, then join it back to all possible subtree anchors in one one-to-many join, rather than doing a bunch of duplicate calculations and using a many-to-many join in the output, which is what we're doing now and what results in duplication.

@mmcdermott mmcdermott merged commit 3ec94ea into main Aug 24, 2024
7 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.

Duplication of rows when using _ANY_EVENT as a predicate for windows.
2 participants