Architectural overview doc - #2271
Merged
Merged
Conversation
richjames0
requested review from
A9isha,
NuojCheng,
RissyRan,
SurbhiJainUSC,
aireenmei,
bvandermoon,
gagika,
gobbleturk,
hengtaoguo,
khatwanimohit,
shralex,
vipannalla and
yangyuwei
as code owners
September 2, 2025 00:23
steph-morton
reviewed
Sep 4, 2025
steph-morton
left a comment
Collaborator
There was a problem hiding this comment.
Really excellent architecture topic. It is super clear and helpful. I've left some specific editorial recommendations inline and here is some editorial feedback that applies to the whole PR:
- Capitalization of titles, headings, and bullet list subheads: we are working to standardize to sentence case (first word cap, proper nouns cap, all others lowercase).
- In headings and subheads, I recommend to spell out
andinstead of using ampersand - You might want to mark all inline param names with code ticks as you did with filenames.
- You may want to more directly address the audience as
you; it helps make the content more active to address directly to the reader. I left a specific comment inline where this becomes logical - GCS should be "Cloud Storage" throughout
kyle-meggs
reviewed
Sep 5, 2025
kyle-meggs
reviewed
Sep 5, 2025
kyle-meggs
reviewed
Sep 5, 2025
kyle-meggs
reviewed
Sep 5, 2025
kyle-meggs
reviewed
Sep 5, 2025
kyle-meggs
reviewed
Sep 5, 2025
kyle-meggs
reviewed
Sep 5, 2025
kyle-meggs
reviewed
Sep 5, 2025
kyle-meggs
reviewed
Sep 5, 2025
gobbleturk
reviewed
Sep 8, 2025
gobbleturk
reviewed
Sep 8, 2025
gobbleturk
reviewed
Sep 8, 2025
gobbleturk
reviewed
Sep 8, 2025
gobbleturk
reviewed
Sep 8, 2025
gobbleturk
reviewed
Sep 8, 2025
gobbleturk
reviewed
Sep 8, 2025
gobbleturk
reviewed
Sep 8, 2025
gobbleturk
left a comment
Collaborator
There was a problem hiding this comment.
Very readable doc! This doc seems to by very ambitious - both explaining all of our features, how to run and how we achieve high performance / use the jax stack? Is this the docs purpose?
richjames0
force-pushed
the
arch_overview
branch
2 times, most recently
from
September 9, 2025 00:05
eb86b76 to
718e1ac
Compare
richjames0
force-pushed
the
arch_overview
branch
from
September 9, 2025 00:21
718e1ac to
f8e9942
Compare
bvandermoon
approved these changes
Sep 10, 2025
melissawm
reviewed
Sep 10, 2025
melissawm
left a comment
Collaborator
There was a problem hiding this comment.
I only left a few formatting suggestions and added some links where I thought appropriate. Overall this was quite nice to read 😄
Final suggestion is that this should be added to the docs/reference.md toctree.
richjames0
force-pushed
the
arch_overview
branch
from
September 16, 2025 18:02
f8e9942 to
6868b96
Compare
richjames0
force-pushed
the
arch_overview
branch
from
September 16, 2025 18:12
6868b96 to
881a8ac
Compare
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.
Description
Architectural overview doc
Tests
N/A
Checklist
Before submitting this PR, please make sure (put X in square brackets):