feat: allow user set hardwrare interval #1050
Merged
Conversation
This file contains hidden or 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
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
0ff126d to
3d45c1c
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR enables users to configure the hardware monitoring interval (minimum 5 seconds) via the Settings object and integrates that value into the runtime monitor logic.
- Added a new
hardware_intervalfield toSettingswith validation (integer ≥ 5 orNoneby default). - Updated
MonitorCroninswanlab/data/run/helper.pyto use the user-defined interval when sleeping. - Added unit tests for the new
hardware_intervalbehavior intest_swanlab_settings.py.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| test/unit/test_swanlab_settings.py | Added tests to verify default, too-small, and non-integer hardware_interval |
| swanlab/swanlab_settings.py | Introduced hardware_interval: Optional[PositiveInt] with ge=5 validation |
| swanlab/data/run/helper.py | Pulled hardware_interval from settings into MonitorCron and updated sleep_time logic |
Comments suppressed due to low confidence (3)
test/unit/test_swanlab_settings.py:172
- Add a positive test case to confirm that
Settings(hardware_interval=5)(and other integers ≥ 5) is accepted without raising aValidationError.
with pytest.raises(ValidationError):
swanlab/data/run/helper.py:170
- Include unit tests for
MonitorCron.sleep_timeto verify it returns the customhardware_intervalwhen set and falls back to the default timing logic otherwise.
if self.monitor_interval is not None:
swanlab/swanlab_settings.py:16
- The fallback
except ImportErrorblock only importsAnnotatedandLiteral, soOptionalwill be undefined in Python <3.9 environments. AddOptionalto the fallback import fromtyping_extensionsas well.
from typing import Annotated, Literal, Optional # Python 3.9+
3d45c1c to
c21c705
Compare
Zeyi-Lin
approved these changes
Jun 7, 2025
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
Allow users to set hardware monitoring frequency(greater than 5s), use case: