talmolab / sleap

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

Fix zmq inference #1800

Closed roomrys closed 5 months ago

roomrys commented 5 months ago

Description

After the changes added in:

when running inference, the zmq ports are not on the inference GUI and so were not being passed into the LossViewer. Because of this, when trying to run inference, we would get this error:

Traceback (most recent call last):
  File "d:\social-leap-estimates-animal-poses\source\sleap\sleap\gui\learning\dialog.py", line 731, in run
    items_for_inference=items_for_inference,
  File "d:\social-leap-estimates-animal-poses\source\sleap\sleap\gui\learning\runners.py", line 559, in run_learning_pipeline
    save_viz=save_viz,
  File "d:\social-leap-estimates-animal-poses\source\sleap\sleap\gui\learning\runners.py", line 618, in run_gui_training
    inference_params["controller_port"] = win.zmq_ports["controller_port"]
TypeError: 'NoneType' object is not subscriptable

This PR does not add the ZMQ ports to the inference GUI, but instead makes changes so that even if ZMQ ports were not found in the GUI params, default values will be used.

Types of changes

Does this address any currently open issues?

[list open issues here]

Outside contributors checklist

Thank you for contributing to SLEAP!

:heart:

Summary by CodeRabbit

coderabbitai[bot] commented 5 months ago

[!WARNING]

Rate limit exceeded

@roomrys has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 32 minutes and 13 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 0053cda7f8ef1dcf50004554b50a70b8850716e7 and a5a47c52eaf3224b884294df796133032f21c045.

Walkthrough

The recent changes focus on enhancing the initialization and handling of ZeroMQ (ZMQ) ports within the SLEAP GUI. This involves refactoring the logic to set default port values, find free ports, and handle errors when ports are unavailable. These updates ensure smoother communication setup and improve the robustness of the SLEAP GUI's port configuration.

Changes

File Change Summary
sleap/gui/learning/runners.py Refactored zmq_ports initialization using inference_params to ensure default port values if not explicitly provided.
sleap/gui/widgets/monitor.py Introduced logic to set up ZMQ ports for communication if not provided, including setting default ports, finding free ports, and adding error handling for cases where ports cannot be found after attempts.
tests/gui/test_monitor.py Added assertions and tests to ensure correct ZMQ port settings in LossViewer instances and tested behavior related to ZMQ ports and batch showing.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MonitorWidget
    participant ZMQ
    User ->> MonitorWidget: Initialize
    MonitorWidget ->> MonitorWidget: Check provided ZMQ ports
    alt Ports provided
        MonitorWidget ->> ZMQ: Bind to provided ports
    else No ports provided
        MonitorWidget ->> MonitorWidget: Set default ports
        MonitorWidget ->> ZMQ: Find free ports
        alt Free ports found
            MonitorWidget ->> ZMQ: Bind to free ports
        else No free ports found
            MonitorWidget ->> User: Raise error
        end
    end

Poem

In the land of SLEAP, where ports do bind,
A rabbit hops with code refined.
Default ports set, free ones sought,
Errors handled, no battles fought.
Communication flows, smooth and clear,
With ZMQ, there's naught to fear.
🐇✨


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.
codecov[bot] commented 5 months ago

Codecov Report

Attention: Patch coverage is 63.15789% with 7 lines in your changes missing coverage. Please review.

Project coverage is 74.09%. Comparing base (7ed1229) to head (a5a47c5). Report is 13 commits behind head on develop.

Files Patch % Lines
sleap/gui/widgets/monitor.py 75.00% 4 Missing :warning:
sleap/gui/learning/runners.py 0.00% 3 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #1800 +/- ## =========================================== + Coverage 73.30% 74.09% +0.79% =========================================== Files 134 135 +1 Lines 24087 24509 +422 =========================================== + Hits 17658 18161 +503 + Misses 6429 6348 -81 ```

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