Skip to content

Architectural overview doc - #2271

Merged
copybara-service[bot] merged 1 commit into
mainfrom
arch_overview
Sep 16, 2025
Merged

Architectural overview doc#2271
copybara-service[bot] merged 1 commit into
mainfrom
arch_overview

Conversation

@richjames0

Copy link
Copy Markdown
Collaborator

Description

Architectural overview doc

Tests

N/A

Checklist

Before submitting this PR, please make sure (put X in square brackets):

  • I have performed a self-review of my code.
  • I have necessary comments in my code, particularly in hard-to-understand areas.
  • I have run end-to-end tests tests and provided workload links above if applicable.
  • I have made or will make corresponding changes to the doc if needed.

@steph-morton steph-morton left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 and instead 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

Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md
Comment thread docs/reference/architecture_overview.md

@gobbleturk gobbleturk left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
richjames0 force-pushed the arch_overview branch 2 times, most recently from eb86b76 to 718e1ac Compare September 9, 2025 00:05

@gobbleturk gobbleturk left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Rich!

Comment thread docs/reference/architecture_overview.md

@melissawm melissawm left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated
Comment thread docs/reference/architecture_overview.md Outdated

@tianshub tianshub left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@copybara-service
copybara-service Bot merged commit 4ec4c72 into main Sep 16, 2025
19 of 23 checks passed
@copybara-service
copybara-service Bot deleted the arch_overview branch September 16, 2025 21:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants