docs: expand terminology glossary from 6 to 30+ profiling terms#2859
Open
Ashutosh0x wants to merge 1 commit into
Open
docs: expand terminology glossary from 6 to 30+ profiling terms#2859Ashutosh0x wants to merge 1 commit into
Ashutosh0x wants to merge 1 commit into
Conversation
The existing terminology page only defined 6 basic terms (Profile, Session, Run, Host, Device, Step). Expand it with comprehensive definitions organized into logical categories: - General Terms (4): Profile, Session, Run, Step - Hardware Terms (7): Host, Device, HBM, VMEM, TensorCore, MXU, SXM/PCIe - Performance Metrics (4): FLOPS Utilization, Duty Cycle, Memory BW, Goodput - XLA/Compilation Terms (5): HLO, Op, Fusion, Kernel, Custom Call - Communication Terms (5): DCN, ICI, All-Reduce, All-Gather, Collective Permute - Profiling Tools (6): Trace Viewer, Op Profile, Memory Viewer, Roofline, Graph Viewer, Kernel Profiling These terms appear throughout XProf documentation and UI but were previously undefined, creating a barrier for new users.
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
1 participant
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
Expand the erminology.md glossary from 6 basic terms to 30+ comprehensive definitions, organized into logical categories.
Problem
The existing terminology page only defined 6 terms: Profile, Session, Run, Host, Device, Step. However, XProf documentation and UI heavily use terms like FLOPS Utilization, HBM, TensorCore, Duty Cycle, All-Reduce, Roofline Model, HLO, Fusion, etc. — none of which were defined. This creates a barrier for new users trying to understand profiling output.
Changes
Expanded from 6 → 30+ terms across 6 categories:
All definitions are derived from existing XProf documentation pages (overview_page.md, roofline_model.md, trace_viewer.md, etc.) to ensure consistency.
No behavioral changes
Documentation-only change.