Update slicing support in System
#63
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
There was a problem hiding this comment.
Pull Request Overview
This PR updates the System class to support slicing like torch.nn.Sequential, returning a new System instance rather than a list, and refines type hints and documentation.
- Added
@overloadsignatures and updated return types for__getitem__, plus type hints on__iter__and__len__. - Changed slicing (
system[i:j]) to returnSysteminstead ofList[Element]. - Enhanced docstring examples and expanded
typingimports.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| torchoptics/system.py | Introduced overloads, type hints, and updated docstring for slicing |
| tests/system/test_system.py | Added basic slicing tests for System |
Comments suppressed due to low confidence (1)
tests/system/test_system.py:166
- Consider adding tests for slicing with steps (e.g.,
system[::2]) and negative indices (e.g.,system[-2:]) to fully cover the new slicing behavior.
system_slice = system[:2]
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #63 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 37 37
Lines 1217 1223 +6
=========================================
+ Hits 1217 1223 +6 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Systemto matchtorch.nn.Sequential, returning a newSysteminstance instead of a list ofElements.Systemdocstring and dunder method type hints.