Add ADR for ModelCollection design (PR #180) #185
Closed
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.
Documents the architectural decision to introduce
ModelCollection, a new base class combiningMutableSequencewith EasyScience features for managing collections of model objects.Structure
ADR-0001 Content
Context: No dedicated collection class existed that provided list operations while maintaining interface propagation, graph tracking, and serialization.
Decision:
ModelCollection(ModelBase, MutableSequence[T])with:Key Design Choices:
_add_item/_remove_itemhelpers for graph consistencyTrade-offs: Unified API and type safety vs. additional complexity and memory overhead for graph tracking.
Status: Proposed (PR #180 is draft/open)
Future Maintenance
Status should be updated to "Accepted" when PR #180 merges.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.