Add a usage guide for the checkpoint benchmark framework#3333
Open
mridul-sahu wants to merge 1 commit into
Open
Add a usage guide for the checkpoint benchmark framework#3333mridul-sahu wants to merge 1 commit into
mridul-sahu wants to merge 1 commit into
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
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
Adds
GUIDE.mdundercheckpoint/orbax/checkpoint/_src/testing/benchmarks/: astructured usage guide for the checkpoint benchmark framework.
It documents:
test_fnruns themeasured code) plus a YAML config that selects and parametrizes it;
measure()block (including nested per-step measurement), and how to reuse the built-in
generators;
checkpoint_config,mesh_config,benchmarks,baselines) and the metrics reference (collectors + the TensorBoard tag
namespaces, with units);
capture/compare, profiler traces / HLO dumps, TensorBoard output;
load dispatcher (
load_with_colocated_python), and the XPK launcher;GitHub.
Docs only — no code changes.
Type of change
Checklist
CHANGELOG.md