coderabbitai[bot]
commented
4 months ago Walkthrough
The recent changes introduce configurable ZeroMQ ports for the SLEAP GUI, allowing users to specify ports for controller and publish addresses. This flexibility helps avoid conflicts when running multiple instances of SLEAP. Enhancements include new utility functions for port management, updated class constructors, and command-line argument modifications to support this feature.
Changes
| File | Summary of Changes |
|---|---|
sleap/gui/learning/runners.py |
Added inference_params parameter to several functions, introduced zmq_ports for handling ports, and updated LossViewer instantiation. |
sleap/gui/utils.py |
Introduced utility functions is_port_free and select_zmq_port for port management. |
sleap/gui/widgets/monitor.py |
Modified LossViewer class to accept zmq_ports and updated setup_zmq method to use these ports. |
sleap/nn/training.py |
Added command-line arguments --publish_port and --controller_port for ZeroMQ port customization. |
Sequence Diagram(s) (Beta)
sequenceDiagram
participant User
participant GUI
participant LossViewer
participant TrainingProcess
User->>GUI: Launch SLEAP GUI
GUI->>GUI: Select free ports using `select_zmq_port`
GUI->>LossViewer: Instantiate with `zmq_ports`
User->>GUI: Start training
GUI->>TrainingProcess: Pass `controller_port` and `publish_port`
TrainingProcess->>LossViewer: Send updates via ZeroMQ
LossViewer->>User: Display training progressPossibly related issues
- talmolab/sleap#1774: The changes address the issue of hardcoded ZMQ ports by allowing users to specify ports via the GUI, preventing conflicts when multiple instances are running.
Poem
In the realm of SLEAP, where data flows, Ports now dance, as the user knows. No more conflicts, no more fight, ZeroMQ ports set just right. Training runs smooth, a joyous sight, Thanks to changes, coding 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?
codecov[bot]
Description
Adding ZMQ port options in the GUI and CLI for having ease of specifying the ports. Previously, if a port was occupied users had to change it each time by manually editing the training config each time. This feature saves time by specifying the ports in the GUI.
Types of changes
Does this address any currently open issues?
[list open issues here]
Outside contributors checklist
Thank you for contributing to SLEAP!
:heart: