Refactor `LossViewer` to use matplotlib

eberrigan commented 3 months ago

Description

In a downstream branch #1841, we upgrade all of the dependencies to use Python 3.10. However, QtCharts is problematic--it is missing libraries in updated PySide6

We are only using QtCharts in the LossViewer, so, in this PR, we replace QtCharts with matplotlib. A LossPlot class that subclasses MplCanvas is added to handle the plotting functionality previously mixed into LossViewer. The unused duplicate of the LossViewer in training_monitor.py is removed. To maintain scope, the refactored LossViewer re-uses same logic and only replaces QtCharts with matplotlib.

⚠️ In testing the refactored LossViewer, we came across a "leaked semaphore" error that seemed to occur only for (a?) bottom-up model(s?) on (a?) Mac M2(s?). This issue will be further investigated, but has been deemed unrelated to the refactoring in this PR as it was replicated on the base develop branch as well (and seems more likely to be model/configuration related).

Types of changes

[ ] Bugfix
[ ] New feature
[X] Refactor / Code style update (no logical changes)
[ ] Build / CI changes
[ ] Documentation Update
[ ] Other (explain)

Does this address any currently open issues?

1841

Outside contributors checklist

[ ] Review the guidelines for contributing to this repository
[ ] Read and sign the CLA and add yourself to the authors list
[ ] Make sure you are making a pull request against the develop branch (not main). Also you should start your branch off develop
[ ] Add tests that prove your fix is effective or that your feature works
[ ] Add necessary documentation (if appropriate)

Thank you for contributing to SLEAP!

:heart:

Summary by CodeRabbit

New Features
- Introduced Matplotlib-based charting functionality for improved graph rendering in the GUI.
- Added methods for better management of scatter and line plots within the visualization canvas.
- Enhanced visual representation of training metrics with a new plotting mechanism.
- Integrated log-scale functionality for the y-axis to improve data visualization.
Bug Fixes
- Resolved issues related to the previous charting library (QtCharts) not functioning properly.
Refactor
- Enhanced plotting capabilities and streamlined the visualization process by switching to Matplotlib.
- Improved initialization and management of chart series for training and validation losses.

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent changes enhance the Sleap application's graphical representation by integrating Matplotlib as the primary plotting framework while retaining QtCharts functionality. This transition includes the introduction of a new LossPlot class and updates to the LossViewer for improved management and visualization of training metrics.

Changes

Files	Change Summary
`sleap/gui/widgets/monitor.py`	Introduced `LossPlot` class for plotting training/validation loss with Matplotlib; refactored `LossViewer` methods for better data handling and visualization.
`sleap/nn/training.py`, `sleap/gui/widgets/mpl.py`	Changed Matplotlib backend from `"Qt5Agg"` to `"QtAgg"` in both `setup_visualization` and `mpl.py`, enhancing compatibility.
`sleap/gui/app.py`	Removed a blank line; no functional changes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant LossViewer
    participant LossPlot

    User->>LossViewer: Request to visualize loss data
    LossViewer->>LossPlot: Create LossPlot instance
    LossPlot-->>LossViewer: Return plot
    LossViewer->>LossPlot: Add training/validation loss data
    LossPlot-->>LossViewer: Update visualization
    LossViewer->>User: Display updated loss chart

Poem

In the garden, data blooms bright,
With LossPlot, a new delight!
From Qt's grasp, we've set it free,
Now plots dance in harmony.
Hoppity hop, let graphs take flight,
Visual magic, pure and bright! 🐇✨

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 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](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.

roomrys commented 3 months ago

Still need TODOs:

[x] Remove QtChart
[x] Add linewidth parameter
[x] Use latex formatting to bold parts of title
[x] Add grid lines?
[x] Move legend to better spot?
[x] Remove border around plot
[x] Remove debug codes
[x] Better font?

codecov[bot] commented 3 months ago

Codecov Report

Attention: Patch coverage is 71.96653% with 67 lines in your changes missing coverage. Please review.

Project coverage is 75.48%. Comparing base (7ed1229) to head (a4c2905). Report is 38 commits behind head on develop.

Files	Patch %	Lines
sleap/gui/widgets/monitor.py	71.61%	67 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## develop #1899 +/- ## =========================================== + Coverage 73.30% 75.48% +2.17% =========================================== Files 134 134 Lines 24087 24576 +489 =========================================== + Hits 17658 18550 +892 + Misses 6429 6026 -403 ```

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

talmolab / sleap