docs: Add SDK architecture and performance documentation (DOCS-1003) #1561
+468
−1
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
- Created comprehensive guide explaining W&B SDK event-driven architecture - Covers logging performance, CPU/GPU synchronization, and best practices - Addresses user concerns about managing CPU usage for GPU data logging - Includes practical code examples and performance guidelines Resolves DOCS-1003
Deploying docs with
|
| Latest commit: |
ee6c31c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://2d62d875.docodile.pages.dev |
| Branch Preview URL: | https://docs-1003-sdk-architecture-d.docodile.pages.dev |
|
PR Preview: Changed content Base preview: https://docs-1003-sdk-architecture-d.docodile.pages.dev Added
Modified
|
ngrayluna
reviewed
Aug 22, 2025
There was a problem hiding this comment.
@johndmulhausen Can you get a tech review from the SDK Team in #platform-sdk?
- Revised section titles for consistency and improved readability - Enhanced descriptions of SDK architecture and performance, emphasizing event-driven design and non-blocking operations - Added new subsections for better organization, including detailed explanations of key components and performance guidelines - Included practical examples to illustrate data flow and logging practices Resolves DOCS-1004
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
This PR addresses DOCS-1003 by adding comprehensive documentation about W&B's SDK architecture and logging performance.
Background
An academic user requested a high-level explanation of how our event-driven architecture in the SDK handles logging in terms of CPU and processes. They were particularly concerned about managing CPU usage for GPU data logging and wanted documentation to help them understand "what to worry about and what not to worry about."
Changes
New Documentation
/content/en/guides/models/track/sdk-architecture.mdcontaining:Documentation Updates
/content/en/guides/models/track/_index.mdto link to the new SDK architecture documentationKey Features
Testing
Related Issues
📄 View preview links for changed pages