justin13601 / ACES

ACES: Automatic Cohort Extraction System for Event-Streams
https://eventstreamaces.readthedocs.io/en/latest/
MIT License
13 stars 0 forks source link

Changes to the usage page on docs #39

Closed justin13601 closed 3 weeks ago

justin13601 commented 3 weeks ago

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago

[!WARNING]

Review failed

The pull request is closed.

Walkthrough

The recent updates enhance the clarity, functionality, and flexibility of the ACES system. Notable changes include clarifications on the index_timestamp field, expanded support for arbitrary dataset schemas, updated installation and usage instructions, and refined task configurations. Additionally, new examples and detailed explanations for mortality prediction tasks have been added, along with improvements to predicates and window definitions in configuration files.

Changes

File(s) Change Summary
README.md Clarified usage of index_timestamp and expanded support for arbitrary dataset schemas.
docs/source/index.md Reordered information for better clarity.
docs/source/notebooks/examples.ipynb Renamed sections, updated descriptions, added new examples and configurations for mortality prediction tasks.
docs/source/usage.md Updated installation instructions, task configuration examples, CLI usage, results output, and Hydra configuration details.
sample_configs/abnormal_lab.yaml Updated predicates section to use lab_name instead of lab for SpO2 values.
sample_configs/imminent_mortality.yaml Split target window into gap and target windows with adjusted inclusivity.
sample_configs/inhospital_mortality.yaml Modified gap section timing logic.
sample_configs/long-term-incidence.yaml Renamed diagnosis fields and updated myocardial_infarction expression. Adjusted windows section start field.
sample_configs/long_term_recurrence.yaml Introduced configuration for Long-term MI Recurrence Prediction.
src/aces/query.py Modified query function to dynamically construct columns based on configuration.
tests/test_e2e.py Updated task identifiers from inhospital-mortality to inhospital_mortality.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant CLI
    participant ACES
    participant Dataset

    User->>CLI: Run ACES command
    CLI->>ACES: Parse task configuration
    ACES->>Dataset: Extract data based on predicates
    Dataset-->>ACES: Return extracted data
    ACES->>ACES: Dynamically construct columns
    ACES-->>CLI: Return results
    CLI-->>User: Display results

Poem

In fields of code where data streams flow,
A rabbit hops with knowledge to bestow.
With timestamps set and schemas wide,
Predictions clear, no need to hide.
Mortality tasks now well-defined,
In ACES' realm, new insights you'll find.
🐇✨


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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.