Add ZMQ support via GUI and CLI #1780
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughThe 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
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 progress
Possibly related issues
Poem
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #1780 +/- ##
===========================================
+ Coverage 73.30% 74.04% +0.73%
===========================================
Files 134 135 +1
Lines 24087 24500 +413
===========================================
+ Hits 17658 18140 +482
+ Misses 6429 6360 -69 ☔ View full report in Codecov by Sentry. |
2 tasks
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
Outside diff range and nitpick comments (3)
sleap/gui/widgets/monitor.py (1)
[!TIP]
Codebase VerificationThe code contains multiple instances where
self.zmq_portsis used without checking if it isNone. This could lead to potential runtime errors ifzmq_portsis not provided during initialization.
- Lines of concern:
self.zmq_ports[port] = training.select_zmq_port(zmq_context=self.ctx)controller_address = "tcp://127.0.0.1:" + str(self.zmq_ports["controller_port"])publish_address = "tcp://127.0.0.1:" + str(self.zmq_ports["publish_port"])Please ensure that
self.zmq_portsis checked forNonebefore these usages to avoid potential issues.Analysis chain
Line range hint
26-37: Ensure proper handling of defaultNonevalue forzmq_ports.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that `zmq_ports` is always checked for `None` before usage. # Test: Search for usage of `zmq_ports` without None check. Expect: No results. rg --type python 'self.zmq_ports\[' sleap/gui/widgets/monitor.pyLength of output: 97
Script:
#!/bin/bash # Description: Verify that `zmq_ports` is always checked for `None` before usage. # Test: Search for usage of `zmq_ports` without None check. Expect: No results. rg --type py 'self.zmq_ports\[' sleap/gui/widgets/monitor.pyLength of output: 268
Script:
#!/bin/bash # Description: Locate the exact lines and context where `self.zmq_ports` is used without `None` checks. # Test: Search for the lines and surrounding context where `self.zmq_ports` is used. rg --type py -C 3 'self.zmq_ports\[' sleap/gui/widgets/monitor.pyLength of output: 679
sleap/gui/learning/runners.py (1)
Line range hint
581-615: Refactor to improve clarity and robustness of ZMQ port handling.- zmq_ports = None - if gui: - from sleap.gui.widgets.monitor import LossViewer - from sleap.gui.widgets.imagedir import QtImageDirectoryWidget - if all(key in inference_params for key in ["controller_port", "publish_port"]): - zmq_ports = { - "controller_port": inference_params["controller_port"], - "publish_port": inference_params["publish_port"], - } - win = LossViewer(zmq_ports=zmq_ports) - inference_params["controller_port"] = win.zmq_ports["controller_port"] - inference_params["publish_port"] = win.zmq_ports["publish_port"] + if gui: + from sleap.gui.widgets.monitor import LossViewer + from sleap.gui.widgets.imagedir import QtImageDirectoryWidget + # Initialize ZMQ ports from inference_params or use defaults + zmq_ports = { + "controller_port": inference_params.get("controller_port", 9000), + "publish_port": inference_params.get("publish_port", 9001), + } + win = LossViewer(zmq_ports=zmq_ports) + # Update inference_params with potentially new port values + inference_params.update(win.zmq_ports)sleap/nn/training.py (1)
Line range hint
80-80: Remove unused import to clean up the code.- import sleap.nn.viz.plot_pafs
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
sleap/config/pipeline_form.yamlis excluded by!**/*.yaml
Files selected for processing (3)
- sleap/gui/learning/runners.py (6 hunks)
- sleap/gui/widgets/monitor.py (4 hunks)
- sleap/nn/training.py (4 hunks)
Additional Context Used
Ruff (27)
sleap/gui/learning/runners.py (4)
21-21:
sleap.io.video.SingleImageVideoimported but unused
307-307: Do not use bare
except
660-660: f-string without any placeholders
830-830: Local variable
successis assigned to but never usedsleap/nn/training.py (23)
17-17:
cattrimported but unused
80-80:
sleap.nn.viz.plot_pafsimported but unused
929-929: f-string without any placeholders
932-932: f-string without any placeholders
934-934: f-string without any placeholders
936-936: f-string without any placeholders
938-938: f-string without any placeholders
940-940: f-string without any placeholders
942-942: f-string without any placeholders
951-951: f-string without any placeholders
957-957: f-string without any placeholders
1137-1137: f-string without any placeholders
1145-1145: f-string without any placeholders
1241-1241: f-string without any placeholders
1249-1249: f-string without any placeholders
1495-1495: f-string without any placeholders
1503-1503: f-string without any placeholders
1513-1513: f-string without any placeholders
1521-1521: f-string without any placeholders
1633-1633: f-string without any placeholders
1641-1641: f-string without any placeholders
1650-1650: f-string without any placeholders
1660-1660: f-string without any placeholders
Additional comments not posted (2)
sleap/gui/learning/runners.py (2)
553-553: Ensureinference_paramsis properly utilized throughout the function.Verification successful
Ensure
inference_paramsis properly utilized throughout the function.The search results indicate that
inference_paramsis used in various parts of the code, including conditional checks, deletions, assignments, and accessing specific keys. This suggests thatinference_paramsis being actively utilized and manipulated within the function.
- [Lines 1-2]: Conditional check and deletion.
- [Lines 4-6]: Conditional check and assignment.
- [Line 9]: Conditional check.
- [Lines 11-12]: Accessing specific keys.
- [Lines 15-16]: Accessing specific keys.
Based on this evidence, it appears that
inference_paramsis being used correctly within the function.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that `inference_params` is used correctly in `run_learning_pipeline`. # Test: Search for usage of `inference_params`. Expect: Proper handling in all usages. rg --type python 'inference_params\[' sleap/gui/learning/runners.pyLength of output: 100
Script:
#!/bin/bash # Description: Verify that `inference_params` is used correctly in `run_learning_pipeline`. # Test: Search for usage of `inference_params`. Expect: Proper handling in all usages. rg --type py 'inference_params\[' sleap/gui/learning/runners.pyLength of output: 1133
Line range hint
822-849: Ensure consistent handling of ZMQ ports in subprocess arguments.Verification successful
The verification confirms that the ZMQ ports (
controller_portandpublish_port) are consistently handled in thetrain_subprocessfunction within thesleap/gui/learning/runners.pyfile.
- The
controller_portandpublish_portare both checked in theinference_params.- They are assigned from
win.zmq_ports.- They are included in the subprocess arguments.
Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that ZMQ ports are consistently handled in `train_subprocess`. # Test: Search for usage of ZMQ ports in subprocess arguments. Expect: Consistent handling. rg --type python '--controller_port' sleap/gui/learning/runners.pyLength of output: 521
Script:
#!/bin/bash # Description: Verify that ZMQ ports are consistently handled in `train_subprocess`. # Test: Search for usage of ZMQ ports in subprocess arguments. Expect: Consistent handling. rg --type py 'controller_port' sleap/gui/learning/runners.py rg --type py 'publish_port' sleap/gui/learning/runners.pyLength of output: 752
Comment on lines
+1966
to
+1969
| job_config.outputs.zmq.controller_address = "tcp://127.0.0.1:" + str( | ||
| args.controller_port | ||
| ) | ||
| job_config.outputs.zmq.publish_address = "tcp://127.0.0.1:" + str(args.publish_port) |
There was a problem hiding this comment.
Use f-string for better readability and consistency.
- job_config.outputs.zmq.controller_address = "tcp://127.0.0.1:" + str(args.controller_port)
- job_config.outputs.zmq.publish_address = "tcp://127.0.0.1:" + str(args.publish_port)
+ job_config.outputs.zmq.controller_address = f"tcp://127.0.0.1:{args.controller_port}"
+ job_config.outputs.zmq.publish_address = f"tcp://127.0.0.1:{args.publish_port}"Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Suggested change
| job_config.outputs.zmq.controller_address = "tcp://127.0.0.1:" + str( | |
| args.controller_port | |
| ) | |
| job_config.outputs.zmq.publish_address = "tcp://127.0.0.1:" + str(args.publish_port) | |
| job_config.outputs.zmq.controller_address = f"tcp://127.0.0.1:{args.controller_port}" | |
| job_config.outputs.zmq.publish_address = f"tcp://127.0.0.1:{args.publish_port}" |
sleap/nn/training.py
Outdated
Comment on lines
397
to
410
| def is_port_free(port: int, zmq_context: Optional[zmq.Context] = None) -> bool: | ||
| """Checks if a port is free.""" | ||
| ctx = zmq.Context.instance() if zmq_context is None else zmq_context | ||
| socket = ctx.socket(zmq.REP) | ||
| address = f"tcp://127.0.0.1:{port}" | ||
| try: | ||
| socket.bind(address) | ||
| socket.unbind(address) | ||
| return True | ||
| except zmq.ZMQError: | ||
| return False | ||
| finally: | ||
| socket.close() | ||
|
|
There was a problem hiding this comment.
Ensure proper handling of ZMQ errors during port binding.
+ except zmq.ZMQError as e:
+ logger.error(f"Failed to bind to port {port}: {str(e)}")
+ return FalseCommittable suggestion was skipped due low confidence.
Comment on lines
+1900
to
+1911
| parser.add_argument( | ||
| "--publish_port", | ||
| type=int, | ||
| default=9001, | ||
| help="Port to set up the publish address while using ZMQ, defaults to 9001.", | ||
| ) | ||
| parser.add_argument( | ||
| "--controller_port", | ||
| type=int, | ||
| default=9000, | ||
| help="Port to set up the controller address while using ZMQ, defaults to 9000.", | ||
| ) |
There was a problem hiding this comment.
Clarify the default port values in the help message for better user understanding.
- help="Port to set up the publish address while using ZMQ, defaults to 9001.",
+ help="Default ZMQ publish port is 9001. Specify a different port if needed.",
- help="Port to set up the controller address while using ZMQ, defaults to 9000.",
+ help="Default ZMQ controller port is 9000. Specify a different port if needed.",Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Suggested change
| parser.add_argument( | |
| "--publish_port", | |
| type=int, | |
| default=9001, | |
| help="Port to set up the publish address while using ZMQ, defaults to 9001.", | |
| ) | |
| parser.add_argument( | |
| "--controller_port", | |
| type=int, | |
| default=9000, | |
| help="Port to set up the controller address while using ZMQ, defaults to 9000.", | |
| ) | |
| parser.add_argument( | |
| "--publish_port", | |
| type=int, | |
| default=9001, | |
| help="Default ZMQ publish port is 9001. Specify a different port if needed.", | |
| ) | |
| parser.add_argument( | |
| "--controller_port", | |
| type=int, | |
| default=9000, | |
| help="Default ZMQ controller port is 9000. Specify a different port if needed.", | |
| ) |
sleap/gui/widgets/monitor.py
Outdated
Comment on lines
308
to
333
| # Default publish and control address | ||
| controller_address = "tcp://127.0.0.1:9000" | ||
| publish_address = "tcp://127.0.0.1:9001" | ||
|
|
||
| if self.zmq_ports: | ||
| for port, port_value in self.zmq_ports.items(): | ||
| need_port = training.is_port_free(port=port_value, zmq_context=self.ctx) | ||
| if need_port: | ||
| self.zmq_ports[port] = training.select_zmq_port( | ||
| zmq_context=self.ctx | ||
| ) | ||
| controller_address = "tcp://127.0.0.1:" + str( | ||
| self.zmq_ports["controller_port"] | ||
| ) | ||
| publish_address = "tcp://127.0.0.1:" + str(self.zmq_ports["publish_port"]) | ||
|
|
||
| # Progress monitoring, SUBSCRIBER | ||
| self.sub = self.ctx.socket(zmq.SUB) | ||
| self.sub.subscribe("") | ||
| self.sub.bind("tcp://127.0.0.1:9001") | ||
| self.sub.bind(publish_address) | ||
|
|
||
| # Controller, PUBLISHER | ||
| self.zmq_ctrl = None | ||
| if self.show_controller: | ||
| self.zmq_ctrl = self.ctx.socket(zmq.PUB) | ||
| self.zmq_ctrl.bind("tcp://127.0.0.1:9000") | ||
| self.zmq_ctrl.bind(controller_address) |
There was a problem hiding this comment.
Refactor the ZMQ setup to handle dynamic port selection more robustly.
- controller_address = "tcp://127.0.0.1:9000"
- publish_address = "tcp://127.0.0.1:9001"
- if self.zmq_ports:
- for port, port_value in self.zmq_ports.items():
- need_port = training.is_port_free(port=port_value, zmq_context=self.ctx)
- if need_port:
- self.zmq_ports[port] = training.select_zmq_port(
- zmq_context=self.ctx
- )
- controller_address = "tcp://127.0.0.1:" + str(
- self.zmq_ports["controller_port"]
- )
- publish_address = "tcp://127.0.0.1:" + str(self.zmq_ports["publish_port"])
+ # Set default addresses
+ default_ports = {"controller_port": 9000, "publish_port": 9001}
+ # Update with user-specified ports if available
+ if self.zmq_ports:
+ default_ports.update(self.zmq_ports)
+ # Ensure ports are free, or select new ones
+ for port, port_value in default_ports.items():
+ if not training.is_port_free(port=port_value, zmq_context=self.ctx):
+ default_ports[port] = training.select_zmq_port(zmq_context=self.ctx)
+ # Construct ZMQ addresses
+ controller_address = f"tcp://127.0.0.1:{default_ports['controller_port']}"
+ publish_address = f"tcp://127.0.0.1:{default_ports['publish_port']}"Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Suggested change
| # Default publish and control address | |
| controller_address = "tcp://127.0.0.1:9000" | |
| publish_address = "tcp://127.0.0.1:9001" | |
| if self.zmq_ports: | |
| for port, port_value in self.zmq_ports.items(): | |
| need_port = training.is_port_free(port=port_value, zmq_context=self.ctx) | |
| if need_port: | |
| self.zmq_ports[port] = training.select_zmq_port( | |
| zmq_context=self.ctx | |
| ) | |
| controller_address = "tcp://127.0.0.1:" + str( | |
| self.zmq_ports["controller_port"] | |
| ) | |
| publish_address = "tcp://127.0.0.1:" + str(self.zmq_ports["publish_port"]) | |
| # Progress monitoring, SUBSCRIBER | |
| self.sub = self.ctx.socket(zmq.SUB) | |
| self.sub.subscribe("") | |
| self.sub.bind("tcp://127.0.0.1:9001") | |
| self.sub.bind(publish_address) | |
| # Controller, PUBLISHER | |
| self.zmq_ctrl = None | |
| if self.show_controller: | |
| self.zmq_ctrl = self.ctx.socket(zmq.PUB) | |
| self.zmq_ctrl.bind("tcp://127.0.0.1:9000") | |
| self.zmq_ctrl.bind(controller_address) | |
| # Set default addresses | |
| default_ports = {"controller_port": 9000, "publish_port": 9001} | |
| # Update with user-specified ports if available | |
| if self.zmq_ports: | |
| default_ports.update(self.zmq_ports) | |
| # Ensure ports are free, or select new ones | |
| for port, port_value in default_ports.items(): | |
| if not training.is_port_free(port=port_value, zmq_context=self.ctx): | |
| default_ports[port] = training.select_zmq_port(zmq_context=self.ctx) | |
| # Construct ZMQ addresses | |
| controller_address = f"tcp://127.0.0.1:{default_ports['controller_port']}" | |
| publish_address = f"tcp://127.0.0.1:{default_ports['publish_port']}" | |
| # Progress monitoring, SUBSCRIBER | |
| self.sub = self.ctx.socket(zmq.SUB) | |
| self.sub.subscribe("") | |
| self.sub.bind(publish_address) | |
| # Controller, PUBLISHER | |
| self.zmq_ctrl = None | |
| if self.show_controller: | |
| self.zmq_ctrl = self.ctx.socket(zmq.PUB) | |
| self.zmq_ctrl.bind(controller_address) |
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range and nitpick comments (1)
sleap/nn/training.py (1)
Line range hint
80-80: Remove unused import to clean up the code.- import sleap.nn.viz.plot_pafs
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
sleap/config/pipeline_form.yamlis excluded by!**/*.yaml
Files selected for processing (2)
- sleap/gui/widgets/monitor.py (4 hunks)
- sleap/nn/training.py (4 hunks)
Files skipped from review as they are similar to previous changes (1)
- sleap/gui/widgets/monitor.py
Additional Context Used
Ruff (23)
sleap/nn/training.py (23)
17-17:
cattrimported but unused
80-80:
sleap.nn.viz.plot_pafsimported but unused
929-929: f-string without any placeholders
932-932: f-string without any placeholders
934-934: f-string without any placeholders
936-936: f-string without any placeholders
938-938: f-string without any placeholders
940-940: f-string without any placeholders
942-942: f-string without any placeholders
951-951: f-string without any placeholders
957-957: f-string without any placeholders
1137-1137: f-string without any placeholders
1145-1145: f-string without any placeholders
1241-1241: f-string without any placeholders
1249-1249: f-string without any placeholders
1495-1495: f-string without any placeholders
1503-1503: f-string without any placeholders
1513-1513: f-string without any placeholders
1521-1521: f-string without any placeholders
1633-1633: f-string without any placeholders
1641-1641: f-string without any placeholders
1650-1650: f-string without any placeholders
1660-1660: f-string without any placeholders
Additional comments not posted (4)
sleap/nn/training.py (4)
397-410: The implementation ofis_port_freefunction looks correct and handles potential exceptions well.
412-418: Theselect_zmq_portfunction efficiently selects a free port within the given context. Good use of ZMQ'sbind_to_random_portmethod.
1966-1969: Use f-string for better readability and consistency.- job_config.outputs.zmq.controller_address = "tcp://127.0.0.1:" + str(args.controller_port) - job_config.outputs.zmq.publish_address = "tcp://127.0.0.1:" + str(args.publish_port) + job_config.outputs.zmq.controller_address = f"tcp://127.0.0.1:{args.controller_port}" + job_config.outputs.zmq.publish_address = f"tcp://127.0.0.1:{args.publish_port}"Likely invalid or redundant comment.
1900-1911: Clarify the default port values in the help message for better user understanding.- help="Port to set up the publish address while using ZMQ, defaults to 9001.", + help="Default ZMQ publish port is 9001. Specify a different port if needed.", - help="Port to set up the controller address while using ZMQ, defaults to 9000.", + help="Default ZMQ controller port is 9000. Specify a different port if needed.",Likely invalid or redundant comment.
sleap/nn/training.py
Outdated
| @@ -11,6 +11,7 @@ | |||
| from datetime import datetime | |||
| from time import time | |||
| from typing import Callable, List, Optional, Text, TypeVar, Union | |||
| import zmq | |||
There was a problem hiding this comment.
Remove unused import to clean up the code.
- import cattrCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Suggested change
| import zmq | |
| import zmq |
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range and nitpick comments (4)
sleap/gui/learning/runners.py (4)
Line range hint
311-311: Handle exceptions more specifically.Using a bare
exceptclause can catch unexpected exceptions and obscure programming errors. Consider specifying the exception type to improve error handling and maintainability.- except: + except Exception as e: + # Handle specific exception or log error
Line range hint
664-664: Remove unnecessary f-string.This line uses an f-string without placeholders, which is unnecessary. You can use a regular string instead.
- f"Using already trained model for {config_info.head_name}: {config_info.path}" + "Using already trained model for {config_info.head_name}: {config_info.path}"
Line range hint
834-834: Remove unused local variable.The variable
successis assigned but never used, which could lead to confusion and clutter in the code. Consider removing it if it's not needed.- success = False
Line range hint
21-21: Remove unused import.The import
sleap.io.video.SingleImageVideois not used in this file. Removing unused imports can help keep the code clean and efficient.- from sleap.io.video import SingleImageVideo
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
sleap/config/pipeline_form.yamlis excluded by!**/*.yaml
Files selected for processing (1)
- sleap/gui/learning/runners.py (6 hunks)
Additional Context Used
Ruff (4)
sleap/gui/learning/runners.py (4)
21-21:
sleap.io.video.SingleImageVideoimported but unused
311-311: Do not use bare
except
664-664: f-string without any placeholders
834-834: Local variable
successis assigned to but never used
| @@ -598,13 +600,23 @@ def run_gui_training( | |||
| """ | |||
|
|
|||
| trained_job_paths = dict() | |||
|
|
|||
| zmq_ports = None | |||
There was a problem hiding this comment.
Refactor to improve the handling of ZMQ ports.
The handling of ZMQ ports can be refactored to reduce redundancy and improve clarity. Consider encapsulating the ZMQ port setup in a separate method or class to avoid repeating the same code across different functions.
+ def setup_zmq_ports(inference_params):
+ if all(key in inference_params for key in ["controller_port", "publish_port"]):
+ return {
+ "controller_port": inference_params["controller_port"],
+ "publish_port": inference_params["publish_port"],
+ }
+ return None
- if all(key in inference_params for key in ["controller_port", "publish_port"]):
- zmq_ports = {
- "controller_port": inference_params["controller_port"],
- "publish_port": inference_params["publish_port"],
- }
+ zmq_ports = setup_zmq_ports(inference_params)Also applies to: 608-608, 610-610, 611-611, 612-612, 613-613, 615-615, 616-616, 617-617, 618-618, 619-619
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Suggested change
| zmq_ports = None | |
| def setup_zmq_ports(inference_params): | |
| if all(key in inference_params for key in ["controller_port", "publish_port"]): | |
| return { | |
| "controller_port": inference_params["controller_port"], | |
| "publish_port": inference_params["publish_port"], | |
| } | |
| return None | |
| zmq_ports = setup_zmq_ports(inference_params) |
talmo
requested changes
May 28, 2024
…almolab/sleap into shrivaths/add-zmq-training-gui
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (3)
sleap/nn/training.py (3)
Line range hint
16-16: Remove unused import to clean up the code.- import cattr
Line range hint
79-79: The importsleap.nn.viz.plot_pafsis unused and should be removed unless needed for future use.- import sleap.nn.viz.plot_pafs
Line range hint
904-917: Remove unnecessary f-string usage to improve code clarity and performance.- logger.info(f" Backbone: {self.model.backbone}") + logger.info(" Backbone: " + str(self.model.backbone))Apply similar changes to other lines where f-strings are used without placeholders.
Also applies to: 926-932, 1112-1120, 1216-1224, 1470-1478, 1488-1496, 1608-1616, 1625-1635
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- sleap/gui/utils.py (1 hunks)
- sleap/gui/widgets/monitor.py (4 hunks)
- sleap/nn/training.py (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- sleap/gui/widgets/monitor.py
Additional Context Used
Ruff (23)
sleap/nn/training.py (23)
16-16:
cattrimported but unused
79-79:
sleap.nn.viz.plot_pafsimported but unused
904-904: f-string without any placeholders
907-907: f-string without any placeholders
909-909: f-string without any placeholders
911-911: f-string without any placeholders
913-913: f-string without any placeholders
915-915: f-string without any placeholders
917-917: f-string without any placeholders
926-926: f-string without any placeholders
932-932: f-string without any placeholders
1112-1112: f-string without any placeholders
1120-1120: f-string without any placeholders
1216-1216: f-string without any placeholders
1224-1224: f-string without any placeholders
1470-1470: f-string without any placeholders
1478-1478: f-string without any placeholders
1488-1488: f-string without any placeholders
1496-1496: f-string without any placeholders
1608-1608: f-string without any placeholders
1616-1616: f-string without any placeholders
1625-1625: f-string without any placeholders
1635-1635: f-string without any placeholders
Additional comments not posted (4)
sleap/gui/utils.py (2)
7-19: The implementation ofis_port_freeis robust and follows best practices for resource management with sockets.
22-28: Theselect_zmq_portfunction effectively utilizes ZeroMQ'sbind_to_random_portto ensure a free port is selected, adhering to best practices.sleap/nn/training.py (2)
1875-1886: Clarify the default port values in the help message for better user understanding.
1941-1944: Use f-string for better readability and consistency.
roomrys
approved these changes
May 29, 2024
11 tasks
talmo
approved these changes
May 29, 2024
roomrys
added a commit
that referenced
this pull request
Dec 19, 2024
* Remove no-op code from #1498 * Add options to set background color when exporting video (#1328) * implement #921 * simplified form / refractor * Add test function and update cli docs * Improve test function to check background color * Improve comments * Change background options to lowercase * Use coderabbitai suggested `fill` --------- Co-authored-by: Shrivaths Shyam <[email protected]> Co-authored-by: Liezl Maree <[email protected]> * Increase range on batch size (#1513) * Increase range on batch size * Set maximum to a factor of 2 * Set default callable for `match_lists_function` (#1520) * Set default for `match_lists_function` * Move test code to official tests * Check using expected values * Allow passing in `Labels` to `app.main` (#1524) * Allow passing in `Labels` to `app.main` * Load the labels object through command * Add warning when unable to switch back to CPU mode * Replace (broken) `--unrag` with `--ragged` (#1539) * Fix unrag always set to true in sleap-export * Replace unrag with ragged * Fix typos * Add function to create app (#1546) * Refactor `AddInstance` command (#1561) * Refactor AddInstance command * Add staticmethod wrappers * Return early from set_visible_nodes * Import DLC with uniquebodyparts, add Tracks (#1562) * Import DLC with uniquebodyparts, add Tracks * add tests * correct tests * Make the hdf5 videos store as int8 format (#1559) * make the hdf5 video dataset type as proper int8 by padding with zeros * add gzip compression * Scale new instances to new frame size (#1568) * Fix typehinting in `AddInstance` * brought over changes from my own branch * added suggestions * Ensured google style comments --------- Co-authored-by: roomrys <[email protected]> Co-authored-by: sidharth srinath <[email protected]> * Fix package export (#1619) Add check for empty videos * Add resize/scroll to training GUI (#1565) * Make resizable training GUI and add adaptive scroll bar * Set a maximum window size --------- Co-authored-by: Liezl Maree <[email protected]> * support loading slp files with non-compound types and str in metadata (#1566) Co-authored-by: Liezl Maree <[email protected]> * change inference pipeline option to tracking-only (#1666) change inference pipeline none option to tracking-only * Add ABL:AOC 2023 Workshop link (#1673) * Add ABL:AOC 2023 Workshop link * Trigger website build * Graceful failing with seeking errors (#1712) * Don't try to seek to faulty last frame on provider initialization * Catch seeking errors and pass * Lint * Fix IndexError for hdf5 file import for single instance analysis files (#1695) * Fix hdf5 read for single instance analysis files * Add test * Small test files * removing unneccessary fixtures * Replace imgaug with albumentations (#1623) What's the worst that could happen? * Initial commit * Fix augmentation * Update more deps requirements * Use pip for installing albumentations and avoid reinstalling OpenCV * Update other conda envs * Fix out of bounds albumentations issues and update dependencies (#1724) * Install albumentations using conda-forge in environment file * Conda install albumentations * Add ndx-pose to pypi requirements * Keep out of bounds points * Black * Add ndx-pose to conda install in environment file * Match environment file without cuda * Ordered dependencies * Add test * Delete comments * Add conda packages to mac environment file * Order dependencies in pypi requirements * Add tests with zeroes and NaNs for augmentation * Back * Black * Make comment one line * Add todo for later * Black * Update to new TensorFlow conda package (#1726) * Build conda package locally * Try 2.8.4 * Merge develop into branch to fix dependencies * Change tensorflow version to 2.7.4 in where conda packages are used * Make tensorflow requirements in pypi looser * Conda package has TensorFlow 2.7.0 and h5py and numpy installed via conda * Change tensorflow version in `environment_no_cuda.yml` to test using CI * Test new sleap/tensorflow package * Reset build number * Bump version * Update mac deps * Update to Arm64 Mac runners * pin `importlib-metadata` * Pin more stuff on mac * constrain `opencv` version due to new qt dependencies * Update more mac stuff * Patches to get to green * More mac skipping --------- Co-authored-by: Talmo Pereira <[email protected]> Co-authored-by: Talmo Pereira <[email protected]> * Fix CI on macosx-arm64 (#1734) * Build conda package locally * Try 2.8.4 * Merge develop into branch to fix dependencies * Change tensorflow version to 2.7.4 in where conda packages are used * Make tensorflow requirements in pypi looser * Conda package has TensorFlow 2.7.0 and h5py and numpy installed via conda * Change tensorflow version in `environment_no_cuda.yml` to test using CI * Test new sleap/tensorflow package * Reset build number * Bump version * Update mac deps * Update to Arm64 Mac runners * pin `importlib-metadata` * Pin more stuff on mac * constrain `opencv` version due to new qt dependencies * Update more mac stuff * Patches to get to green * More mac skipping * Re-enable mac tests * Handle GPU re-init * Fix mac build CI * Widen tolerance for movenet correctness test * Fix build ci * Try for manual build without upload * Try to reduce training CI time * Rework actions * Fix miniforge usage * Tweaks * Fix build ci * Disable manual build * Try merging CI coverage * GPU/CPU usage in tests * Lint * Clean up * Fix test skip condition * Remove scratch test --------- Co-authored-by: eberrigan <[email protected]> * Add option to export to CSV via sleap-convert and API (#1730) * Add csv as a format option * Add analysis to format * Add csv suffix to output path * Add condition for csv analysis file * Add export function to Labels class * delete print statement * lint * Add `analysis.csv` as parametrize input for `sleap-convert` tests * test `export_csv` method added to `Labels` class * black formatting * use `Path` to construct filename * add `analysis.csv` to cli guide for `sleap-convert` --------- Co-authored-by: Talmo Pereira <[email protected]> * Only propagate Transpose Tracks when propagate is checked (#1748) Fix always-propagate transpose tracks issue * View Hyperparameter nonetype fix (#1766) Pass config getter argument to fetch hyperparameters * Adding ragged metadata to `info.json` (#1765) Add ragged metadata to info.json file * Add batch size to GUI for inference (#1771) * Fix conda builds (#1776) * test conda packages in a test environment as part of CI * do not test sleap import using conda build * use github environment variables to define build path for each OS in the matrix and add print statements for testing * figure out paths one OS at a time * github environment variables work in subsequent steps not current step * use local builds first * print env info * try simple environment creation * try conda instead of mamba * fix windows build path * fix windows build path * add comment to reference pull request * remove test stage from conda build for macs and test instead by creating the environment in a workflow * test workflow by pushing to current branch * test conda package on macos runner * Mac build does not need nvidia channel * qudida and albumentations are conda installed now * add comment with original issue * use python 3.9 * use conda match specifications syntax * make print statements more readable for troubleshooting python versioning * clean up build file * update version for pre-release * add TODO * add tests for conda packages before uploading * update ci comments and branches * remove macos test of pip wheel since python 3.9 is not supported by setup-python action * Upgrade build actions for release (#1779) * update `build.yml` so it matches updates from `build_manual.yml` * test `build.yml` without uploading * test again using build_manual.yml * build pip wheel with Ubuntu and turn off caching so build.yml exactly matches build_manual.yml * `build.yml` on release only and upload * testing caching * `use-only-tar-bz2: true` makes environment unsolvable, change it back * Update .github/workflows/build_manual.yml Co-authored-by: Liezl Maree <[email protected]> * Update .github/workflows/build.yml Co-authored-by: Liezl Maree <[email protected]> * bump pre-release version * fix version for pre-release * run build and upload on release! * try setting `CACHE_NUMBER` to 1 with `use-only-tar-bz2` set to true * increasing the cache number to reset the cache does work when `use-only-tar-bz2` is set to true * publish and upload on release only --------- Co-authored-by: Liezl Maree <[email protected]> * Add ZMQ support via GUI and CLI (#1780) * Add ZMQ support via GUI and CLI, automatic port handler, separate utils module for the functions * Change menu name to match deleting predictions beyond max instance (#1790) Change menu and function names * Fix website build and remove build cache across workflows (#1786) * test with build_manual on push * comment out caching in build manual * remove cache step from builad manual since environment resolves when this is commented out * comment out cache in build ci * remove cache from build on release * remove cache from website build * test website build on push * add name to checkout step * update checkout to v4 * update checkout to v4 in build ci * remove cache since build ci works without it * update upload-artifact to v4 in build ci * update second chechout to v4 in build ci * update setup-python to v5 in build ci * update download-artifact to v4 in build ci * update checkout to v4 in build ci * update checkout to v4 in website build * update setup-miniconda to v3.0.3 in website build * update actions-gh-pages to v4 in website build * update actions checkout and setup-python in ci * update checkout action in ci to v4 * pip install lxml[html_clean] because of error message during action * add error message to website to explain why pip install lxml[html_clean] * remove my branch for pull request * Bump to 1.4.1a1 (#1791) * bump versions to 1.4.1a1 * we can change the version on the installation page since this will be merged into the develop branch and not main * Fix windows conda package upload and build ci (#1792) * windows OS is 2022 not 2019 on runner * upload windows conda build manually but not pypi build * remove comment and run build ci * change build manual back so that it doesn't upload * remove branch from build manual * update installation docs for 1.4.1a1 * Fix zmq inference (#1800) * Ensure that we always pass in the zmq_port dict to LossViewer * Ensure zmq_ports has correct keys inside LossViewer * Use specified controller and publish ports for first attempted addresses * Add test for ports being set in LossViewer * Add max attempts to find unused port * Fix find free port loop and add for controller port also * Improve code readablility and reuse * Improve error message when unable to find free port * Set selected instance to None after removal (#1808) * Add test that selected instance set to None after removal * Set selected instance to None after removal * Add `InstancesList` class to handle backref to `LabeledFrame` (#1807) * Add InstancesList class to handle backref to LabeledFrame * Register structure/unstructure hooks for InstancesList * Add tests for the InstanceList class * Handle case where instance are passed in but labeled_frame is None * Add tests relevant methods in LabeledFrame * Delegate setting frame to InstancesList * Add test for PredictedInstance.frame after complex merge * Add todo comment to not use Instance.frame * Add rtest for InstasnceList.remove * Use normal list for informative `merged_instances` * Add test for copy and clear * Add copy and clear methods, use normal lists in merge method * Bump to v1.4.1a2 (#1835) bump to 1.4.1a2 * Updated trail length viewing options (#1822) * updated trail length optptions * Updated trail length options in the view menu * Updated `prefs` to include length info from `preferences.yaml` * Added trail length as method of `MainWindow` * Updated trail length documentation * black formatting --------- Co-authored-by: Keya Loding <[email protected]> * Handle case when no frame selection for trail overlay (#1832) * Menu option to open preferences directory and update to util functions to pathlib (#1843) * Add menu to view preferences directory and update to pathlib * text formatting * Add `Keep visualizations` checkbox to training GUI (#1824) * Renamed save_visualizations to view_visualizations for clarity * Added Delete Visualizations button to the training pipeline gui, exposed del_viz_predictions config option to the user * Reverted view_ back to save_ and changed new training checkbox to Keep visualization images after training. * Fixed keep_viz config option state override bug and updated keep_viz doc description * Added test case for reading training CLI argument correctly * Removed unnecessary testing code * Creating test case to check for viz folder * Finished tests to check CLI argument reading and viz directory existence * Use empty string instead of None in cli args test * Use keep_viz_images false in most all test configs (except test to override config) --------- Co-authored-by: roomrys <[email protected]> * Allowing inference on multiple videos via `sleap-track` (#1784) * implementing proposed code changes from issue #1777 * comments * configuring output_path to support multiple video inputs * fixing errors from preexisting test cases * Test case / code fixes * extending test cases for mp4 folders * test case for output directory * black and code rabbit fixes * code rabbit fixes * as_posix errors resolved * syntax error * adding test data * black * output error resolved * edited for push to dev branch * black * errors fixed, test cases implemented * invalid output test and invalid input test * deleting debugging statements * deleting print statements * black * deleting unnecessary test case * implemented tmpdir * deleting extraneous file * fixing broken test case * fixing test_sleap_track_invalid_output * removing support for multiple slp files * implementing talmo's comments * adding comments * Add object keypoint similarity method (#1003) * Add object keypoint similarity method * fix max_tracking * correct off-by-one error * correct off-by-one error * Generate suggestions using max point displacement threshold (#1862) * create function max_point_displacement, _max_point_displacement_video. Add to yaml file. Create test for new function . . . will need to edit * remove unnecessary for loop, calculate proper displacement, adjusted tests accordingly * Increase range for displacement threshold * Fix frames not found bug * Return the latter frame index * Lint --------- Co-authored-by: roomrys <[email protected]> * Added Three Different Cases for Adding a New Instance (#1859) * implemented paste with offset * right click and then default will paste the new instance at the location of the cursor * modified the logics for creating new instance * refined the logic * fixed the logic for right click * refined logics for adding new instance at a specific location * Remove print statements * Comment code * Ensure that we choose a non nan reference node * Move OOB nodes to closest in-bounds position --------- Co-authored-by: roomrys <[email protected]> * Allow csv and text file support on sleap track (#1875) * initial changes * csv support and test case * increased code coverage * Error fixing, black, deletion of (self-written) unused code * final edits * black * documentation changes * documentation changes * Fix GUI crash on scroll (#1883) * Only pass wheelEvent to children that can handle it * Add test for wheelEvent * Fix typo to allow rendering videos with mp4 (Mac) (#1892) Fix typo to allow rendering videos with mp4 * Do not apply offset when double clicking a `PredictedInstance` (#1888) * Add offset argument to newInstance and AddInstance * Apply offset of 10 for Add Instance menu button (Ctrl + I) * Add offset for docks Add Instance button * Make the QtVideoPlayer context menu unit-testable * Add test for creating a new instance * Add test for "New Instance" button in `InstancesDock` * Fix typo in docstring * Add docstrings and typehinting * Remove unused imports and sort imports * Refactor video writer to use imageio instead of skvideo (#1900) * modify `VideoWriter` to use imageio with ffmpeg backend * check to see if ffmpeg is present * use the new check for ffmpeg * import imageio.v2 * add imageio-ffmpeg to environments to test * using avi format for now * remove SKvideo videowriter * test `VideoWriterImageio` minimally * add more documentation for ffmpeg * default mp4 for ffmpeg should be mp4 * print using `IMAGEIO` when using ffmpeg * mp4 for ffmpeg * use mp4 ending in test * test `VideoWriterImageio` with avi file extension * test video with odd size * remove redundant filter since imageio-ffmpeg resizes automatically * black * remove unused import * use logging instead of print statement * import cv2 is needed for resize * remove logging * Use `Video.from_filename` when structuring videos (#1905) * Use Video.from_filename when structuring videos * Modify removal_test_labels to have extension in filename * Use | instead of + in key commands (#1907) * Use | instead of + in key commands * Lint * Replace QtDesktop widget in preparation for PySide6 (#1908) * Replace to-be-depreciated QDesktopWidget * Remove unused imports and sort remaining imports * Remove unsupported |= operand to prepare for PySide6 (#1910) Fixes TypeError: unsupported operand type(s) for |=: 'int' and 'Option' * Use positional argument for exception type (#1912) traceback.format_exception has changed it's first positional argument's name from etype to exc in python 3.7 to 3.10 * Replace all Video structuring with Video.cattr() (#1911) * Remove unused AsyncVideo class (#1917) Remove unused AsyncVideo * Refactor `LossViewer` to use matplotlib (#1899) * use updated syntax for QtAgg backend of matplotlib * start add features to `MplCanvas` to replace QtCharts features in `LossViewer` (untested) * remove QtCharts imports and replace with MplCanvas * remove QtCharts imports and replace with MplCanvas * start using MplCanvas in LossViwer instead of QtCharts (untested) * use updated syntax * Uncomment all commented out QtChart * Add debug code * Refactor monitor to use LossViewer._init_series method * Add monitor only debug code * Add methods for setting up axes and legend * Add the matplotlib canvas to the widget * Resize axis with data (no log support yet) * Try using PathCollection for "batch" * Get "batch" plotting with ax.scatter (no log support yet) * Add log support * Add a _resize_axis method * Modify init_series to work for ax.plot as well * Use matplotlib to plot epoch_loss line * Add method _add_data_to_scatter * Add _add_data_to_plot method * Add docstring to _resize_axes * Add matplotlib plot for val_loss * Add matplotlib scatter for val_loss_best * Avoid errors with setting log scale before any positive values * Add x and y axes labels * Set title (removing html tags) * Add legend * Adjust positioning of plot * Lint * Leave MplCanvas unchanged * Removed unused training_monitor.LossViewer * Resize fonts * Move legend outside of plot * Add debug code for montitor aesthetics * Use latex formatting to bold parts of title * Make axes aesthetic * Add midpoint grid lines * Set initial limits on x and y axes to be 0+ * Ensure x axis minimum is always resized to 0+ * Adjust plot to account for plateau patience title * Add debug code for plateau patience title line * Lint * Set thicker line width * Remove unused import * Set log axis on initialization * Make tick labels smaller * Move plot down a smidge * Move ylabel left a bit * Lint * Add class LossPlot * Refactor LossViewer to use LossPlot * Remove QtCharts code * Remove debug codes * Allocate space for figure items based on item's size * Refactor LossPlot to use underscores for internal methods * Ensure y_min, y_max not equal Otherwise we get an unnecessary teminal message: UserWarning: Attempting to set identical bottom == top == 3.0 results in singular transformations; automatically expanding. self.axes.set_ylim(y_min, y_max) --------- Co-authored-by: roomrys <[email protected]> Co-authored-by: roomrys <[email protected]> * Refactor `LossViewer` to use underscores for internal method names (#1919) Refactor LossViewer to use underscores for internal method names * Manually handle `Instance.from_predicted` structuring when not `None` (#1930) * Use `tf.math.mod` instead of `%` (#1931) * Option for Max Stride to be 128 (#1941) Co-authored-by: Max Weinberg <[email protected]> * Add discussion comment workflow (#1945) * Add a bot to autocomment on workflow * Use github markdown warning syntax * Add a multiline warning * Change happy coding to happy SLEAPing Co-authored-by: Talmo Pereira <[email protected]> --------- Co-authored-by: roomrys <[email protected]> Co-authored-by: Talmo Pereira <[email protected]> * Add comment on issue workflow (#1946) * Add workflow to test conda packages (#1935) * Add missing imageio-ffmpeg to meta.ymls (#1943) * Update installation docs 1.4.1 (#1810) * [wip] Updated installation docs * Add tabs for different OS installations * Move installation methods to tabs * Use tabs.css * FIx styling error (line under last tab in terminal hint) * Add installation instructions before TOC * Replace mamba with conda * Lint * Find good light colors not switching when change dark/light themes * Get color scheme switching with dark/light toggle button * Upgrade website build dependencies * Remove seemingly unneeded dependencies from workflow * Add myst-nb>=0.16.0 lower bound * Trigger dev website build * Fix minor typo in css * Add miniforge and one-liner installs for package managers --------- Co-authored-by: roomrys <[email protected]> Co-authored-by: Talmo Pereira <[email protected]> * Add imageio dependencies for pypi wheel (#1950) Add imagio dependencies for pypi wheel Co-authored-by: roomrys <[email protected]> * Do not always color skeletons table black (#1952) Co-authored-by: roomrys <[email protected]> * Remove no module named work error (#1956) * Do not always color skeletons table black * Remove offending (possibly unneeded) line that causes the no module named work error to print in terminal * Remove offending (possibly unneeded) line that causes the no module named work error to print in terminal * Remove accidentally added changes * Add (failing) test to ensure menu-item updates with state change * Reconnect callback for menu-item (using lambda) * Add (failing) test to ensure menu-item updates with state change Do not assume inital state * Reconnect callback for menu-item (using lambda) --------- Co-authored-by: roomrys <[email protected]> * Add `normalized_instance_similarity` method (#1939) * Add normalize function * Expose normalization function * Fix tests * Expose object keypoint sim function * Fix tests * Handle skeleton decoding internally (#1961) * Reorganize (and add) imports * Add (and reorganize) imports * Modify decode_preview_image to return bytes if specified * Implement (minimally tested) replace_jsonpickle_decode * Add support for using idx_to_node map i.e. loading from Labels (slp file) * Ignore None items in reduce_list * Convert large function to SkeletonDecoder class * Update SkeletonDecoder.decode docstring * Move decode_preview_image to SkeletonDecoder * Use SkeletonDecoder instead of jsonpickle in tests * Remove unused imports * Add test for decoding dict vs tuple pystates * Handle skeleton encoding internally (#1970) * start class `SkeletonEncoder` * _encoded_objects need to be a dict to add to * add notebook for testing * format * fix type in docstring * finish classmethod for encoding Skeleton as a json string * test encoded Skeleton as json string by decoding it * add test for decoded encoded skeleton * update jupyter notebook for easy testing * constraining attrs in dev environment to make sure decode format is always the same locally * encode links first then encode source then target then type * save first enconding statically as an input to _get_or_assign_id so that we do not always get py/id * save first encoding statically * first encoding is passed to _get_or_assign_id * use first_encoding variable to determine if we should assign a py/id * add print statements for debugging * update notebook for easy testing * black * remove comment * adding attrs constraint to show this passes for certain attrs version only * add import * switch out jsonpickle.encode * oops remove import * can attrs be unconstrained? * forgot comma * pin attrs for testing * test Skeleton from json, template, with symmetries, and template * use SkeletonEncoder.encode * black * try removing None values in EdgeType reduced * Handle case when nodes are replaced by integer indices from caller * Remove prototyping notebook * Remove attrs pins * Remove sort keys (which flips the neccessary ordering of our py/ids) * Do not add extra indents to encoded file * Only append links after fully encoded (fat-finger) * Remove outdated comment * Lint --------- Co-authored-by: Talmo Pereira <[email protected]> Co-authored-by: roomrys <[email protected]> * Pin ndx-pose<0.2.0 (#1978) * Pin ndx-pose<0.2.0 * Typo * Sort encoded `Skeleton` dictionary for backwards compatibility (#1975) * Add failing test to check that encoded Skeleton is sorted * Sort Skeleton dictionary before encoding * Remove unused import * Disable comment bot for now * Fix COCO Dataset Loading for Invisible Keypoints (#2035) Update coco.py # Fix COCO Dataset Loading for Invisible Keypoints ## Issue When loading COCO datasets, keypoints marked as invisible (flag=0) are currently skipped and later placed randomly within the instance's bounding box. However, in COCO format, these keypoints may still have valid coordinate information that should be preserved (see toy_dataset for expected vs. current behavior). ## Changes Modified the COCO dataset loading logic to: - Check if invisible keypoints (flag=0) have non-zero coordinates - If coordinates are (0,0), skip the point (existing behavior) - If coordinates are not (0,0), create the point at those coordinates but mark it as not visible - Maintain existing behavior for visible (flag=2) and labeled * Lint * Add tracking score as seekbar header options (#2047) * Add `tracking_score` as a constructor arg for `PredictedInstance` * Add `tracking_score` to ID models * Add fixture with tracking scores * Add tracking score to seekbar header * Add bonsai guide for sleap docs (#2050) * [WIP] Add bonsai guide page * Add more information to the guide with images * add branch for website build * Typos * fix links * Include suggestions * Add more screenshots and refine the doc * Remove branch from website workflow * Completed documentation edits from PR made by reviewer + review bot. --------- Co-authored-by: Shrivaths Shyam <[email protected]> Co-authored-by: Liezl Maree <[email protected]> * Don't mark complete on instance scaling (#2049) * Add check for instances with track assigned before training ID models (#2053) * Add menu item for deleting instances beyond frame limit (#1797) * Add menu item for deleting instances beyond frame limit * Add test function to test the instances returned * typos * Update docstring * Add frame range form * Extend command to use frame range --------- Co-authored-by: Talmo Pereira <[email protected]> * Highlight instance box on hover (#2055) * Make node marker and label sizes configurable via preferences (#2057) * Make node marker and label sizes configurable via preferences * Fix test * Enable touchpad pinch to zoom (#2058) * Fix import PySide2 -> qtpy (#2065) * Fix import PySide2 -> qtpy * Remove unnecessary print statements. * Add channels for pip conda env (#2067) * Add channels for pypi conda env * Trigger dev website build * Separate the video name and its filepath columns in `VideoTablesModel` (#2052) * add option to show video names with filepath * add doc * new feature added successfully * delete unnecessary code * remove attributes from video object * Update dataviews.py * remove all properties * delete toggle option * remove video show * fix the order of the columns * remove options * Update sleap/gui/dataviews.py Co-authored-by: Liezl Maree <[email protected]> * Update sleap/gui/dataviews.py Co-authored-by: Liezl Maree <[email protected]> * use pathlib instead of substrings * Update dataviews.py Co-authored-by: Liezl Maree <[email protected]> * Use Path instead of pathlib.Path and sort imports and remove unused imports * Use item.filename instead of getattr --------- Co-authored-by: Liezl Maree <[email protected]> * Make status bar dependent on UI mode (#2063) * remove bug for dark mode * fix toggle case --------- Co-authored-by: Liezl Maree <[email protected]> * Bump version to 1.4.1 (#2062) * Bump version to 1.4.1 * Trigger conda/pypi builds (no upload) * Trigger website build * Add dev channel to installation instructions --------- Co-authored-by: Talmo Pereira <[email protected]> * Add -c sleap/label/dev channel for win/linux - also trigger website build --------- Co-authored-by: Scott Yang <[email protected]> Co-authored-by: Shrivaths Shyam <[email protected]> Co-authored-by: getzze <[email protected]> Co-authored-by: Lili Karashchuk <[email protected]> Co-authored-by: Sidharth Srinath <[email protected]> Co-authored-by: sidharth srinath <[email protected]> Co-authored-by: Talmo Pereira <[email protected]> Co-authored-by: KevinZ0217 <[email protected]> Co-authored-by: Elizabeth <[email protected]> Co-authored-by: Talmo Pereira <[email protected]> Co-authored-by: eberrigan <[email protected]> Co-authored-by: vaibhavtrip29 <[email protected]> Co-authored-by: Keya Loding <[email protected]> Co-authored-by: Keya Loding <[email protected]> Co-authored-by: Hajin Park <[email protected]> Co-authored-by: Elise Davis <[email protected]> Co-authored-by: gqcpm <[email protected]> Co-authored-by: Andrew Park <[email protected]> Co-authored-by: roomrys <[email protected]> Co-authored-by: MweinbergUmass <[email protected]> Co-authored-by: Max Weinberg <[email protected]> Co-authored-by: DivyaSesh <[email protected]> Co-authored-by: Felipe Parodi <[email protected]> Co-authored-by: croblesMed <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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!
❤️