Skip to content

Docs: add ml-diagnostic guide#2800

Merged
copybara-service[bot] merged 1 commit intoAI-Hypercomputer:mainfrom
Shuang-cnt:sharony/docs/add-mldiagno
Dec 16, 2025
Merged

Docs: add ml-diagnostic guide#2800
copybara-service[bot] merged 1 commit intoAI-Hypercomputer:mainfrom
Shuang-cnt:sharony/docs/add-mldiagno

Conversation

@Shuang-cnt
Copy link
Copy Markdown
Collaborator

@Shuang-cnt Shuang-cnt commented Dec 9, 2025

Description

MaxText has integrated the ML Diagnostics SDK in the code. This PR aims to introduce ML Diagnostic flag managed_mldiagnostics=True
This flag will be used with 3 different scenarios:

  1. Only upload configs and metrics, not profiling (managed_mldiagnostics=True)
  2. Upload configs and metrics, and do profiling on the first device (managed_mldiagnostics=True and profiler=xplane)
  3. Upload configs and metrics, and do profiling on the all devices (managed_mldiagnostics=True, profiler=xplane, and upload_all_profiler_results=True)

Tests

I manually verified the updated instructions to ensure accuracy.

Checklist

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

  • I have performed a self-review of my code. For an optional AI review, add the gemini-review label.
  • 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, including adding new documentation pages to the relevant Table of Contents (toctree directive) as explained in our documentation.

@Shuang-cnt Shuang-cnt marked this pull request as ready for review December 10, 2025 01:42
@Shuang-cnt Shuang-cnt force-pushed the sharony/docs/add-mldiagno branch 4 times, most recently from cf662a5 to 29f463b Compare December 10, 2025 15:11
Comment thread docs/guides/monitoring_and_debugging/ml_workload_diagnostics.md
Comment thread docs/guides/monitoring_and_debugging/ml_workload_diagnostics.md Outdated
@Shuang-cnt Shuang-cnt force-pushed the sharony/docs/add-mldiagno branch 3 times, most recently from f2889b9 to 0edac7e Compare December 11, 2025 01:03
Comment thread docs/guides/monitoring_and_debugging/ml_workload_diagnostics.md Outdated
Comment thread docs/guides/monitoring_and_debugging/ml_workload_diagnostics.md Outdated
Comment thread docs/guides/monitoring_and_debugging/ml_workload_diagnostics.md Outdated
Comment thread docs/guides/monitoring_and_debugging/ml_workload_diagnostics.md Outdated
@Shuang-cnt Shuang-cnt force-pushed the sharony/docs/add-mldiagno branch from 21e9186 to c619fb2 Compare December 16, 2025 21:10
@copybara-service copybara-service Bot merged commit 948fd36 into AI-Hypercomputer:main Dec 16, 2025
20 checks passed
@Shuang-cnt Shuang-cnt deleted the sharony/docs/add-mldiagno branch December 16, 2025 21:41
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.

4 participants