Conversation
Member
|
Do we have an architecture description, ideally even Architecture Decision Records? That would help me a lot with evaluting the concept and design decisions compared to just looking at the implementation. |
Member
|
I only skimmed this. A couple of super high level comments:
|
This branch has not been deployed
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
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.
PR summary
This is the first PR towards the Data container project.
Reviewer Guide:
I would suggest starting with the architecture guide in users_explain. This provides an overview of each of the parts that are included and a sense of how they all fit together. (also please do tell me if there is a better place for it, this was alongside some of the other architectural descriptions I thought, but very willing to move it)
From there, I would suggest reviewing the code implementing the core pieces:
__init__does some precomputations which separate out subgraphs that are independant, this may be mildly confusing at first, but prevents a lot of looping through large lists of edges that have nothing to do with what you are computingevaluatoris the primary method ofGraph, ultimately it is Djikstra's algorithm with a few tweaks on the input/output sideFinally, reviewing the implementation within
Line2D, my rough outline for points to particularly focus on for review:_x, _y, _xorig, _yorig_, _xy)set_dataand related functionality should work as existing users expect, but is not available if you provide your own container, as once you opt in to using a new container, that container becomes responsible for updating the datadrawfunctionalityI would include the functionality of
_helpers.pyas it comes up, there are only two things in there though:_get_graph- Builds a minimal Graph from a given Axes, which consists of onlyTransformEdgescheck_container- helper validation for backwards compatibility operationsAI Disclosure
None
PR quality check