search

talmolab / sleap

A deep learning framework for multi-animal pose tracking.
https://sleap.ai
Other
436 stars 97 forks source link

Add `Keep visualizations` checkbox to training GUI #1824

Closed hajin-park closed 4 months ago

hajin-park commented 5 months ago

Description

This PR clarifies the use of the Visualize Predictions During Training checkbox by adding a new Keep Prediction Visualization Images After Training checkbox to the training config GUI. If training visualization images are enabled, the images are deleted after training by default unless the new checkbox is enabled (checked).

Types of changes

Does this address any currently open issues?

Outside contributors checklist

Thank you for contributing to SLEAP!

:heart:

Summary by CodeRabbit

codecov[bot] commented 5 months ago

Codecov Report

Attention: Patch coverage is 42.85714% with 4 lines in your changes missing coverage. Please review.

Project coverage is 74.13%. Comparing base (7ed1229) to head (33c9d62). Report is 20 commits behind head on develop.

Files Patch % Lines
sleap/gui/learning/runners.py 0.00% 3 Missing :warning:
sleap/nn/training.py 66.66% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #1824 +/- ## =========================================== + Coverage 73.30% 74.13% +0.82% =========================================== Files 134 135 +1 Lines 24087 24577 +490 =========================================== + Hits 17658 18221 +563 + Misses 6429 6356 -73 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

coderabbitai[bot] commented 5 months ago

Walkthrough

The recent updates introduce several enhancements to visualization management in the SLEAP project. Key changes include renaming the save_viz argument to view_viz, adding new arguments delete_viz and keep_viz, and updating configuration settings across various files. These modifications improve user control over the retention and deletion of prediction visualization images during training and inference processes.

Changes

File(s) Change Summary
docs/guides/cli.md, docs/notebooks/Training_and_inference_on_an_example_dataset.ipynb Renamed save_viz to view_viz, added delete_viz, introduced keep_viz argument
sleap/config/pipeline_form.yaml, sleap/gui/learning/runners.py, sleap/nn/config/outputs.py, sleap/nn/training.py Added keep_viz, renamed save_visualizations to view_visualizations, added delete_viz, updated logic for saving/deleting visualization images
sleap/training_profiles/... Renamed save_visualizations to view_visualizations, added delete_viz_images, introduced keep_viz_images parameter
tests/data/models/... Added keep_viz_images parameter to various model configuration files
tests/gui/test_dialogs.py Removed import of os
tests/nn/test_training.py Updated test functions to include tmp_path for temp directories, added test_keep_viz_cli for testing the --keep_viz CLI option

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant TrainingModule
    participant ConfigHandler
    participant VizHandler

    User->>CLI: Run training with --view_viz and --keep_viz
    CLI->>ConfigHandler: Load configuration
    ConfigHandler-->>CLI: Configuration loaded
    CLI->>TrainingModule: Start training
    TrainingModule->>VizHandler: Generate visualizations
    VizHandler-->>TrainingModule: Visualizations generated
    TrainingModule-->>CLI: Training completed
    CLI-->>User: Training results with visualizations retained

Poem

In the code, we made a change,
Visualization rules rearrange.
View or keep, it's up to you,
Delete the old, display the new.
A rabbit's touch, small yet bright,
Enhances tools for clearer sight.

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.
gitttt-1234 commented 4 months ago

From subgroup:

hajin-park commented 4 months ago

@coderabbitai review

coderabbitai[bot] commented 4 months ago
Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.