Merge pull request #2747 from AI-Hypercomputer:jacoguzo/documentation_reorg

PiperOrigin-RevId: 839993035

Author: Google-ML-Automation

docs/conf.py

@@ -73,7 +73,7 @@
 
 # Remove specific documents from ToC
 exclude_patterns = [
-    "guides/run_maxtext/run_maxtext_via_multihost_job.md",
-    "guides/run_maxtext/run_maxtext_via_multihost_runner.md",
-    "explanations/llm_calculator.ipynb",
+    "run_maxtext/run_maxtext_via_multihost_job.md",
+    "run_maxtext/run_maxtext_via_multihost_runner.md",
+    "reference/core_concepts/llm_calculator.ipynb",
 ]

docs/development.md

@@ -1,7 +1,7 @@
 ```{include} ../CONTRIBUTING.md
 ```
 
-## Contributing documentation
+## Contribute to documentation
 
 The MaxText documentation website is built using [Sphinx](https://www.sphinx-doc.org) and [MyST](https://myst-parser.readthedocs.io/en/latest/). Documents are written in [MyST Markdown syntax](https://myst-parser.readthedocs.io/en/latest/syntax/typography.html#syntax-core).
 

docs/guides.md

@@ -14,25 +14,13 @@
  limitations under the License.
  -->
 
-# How-to Guides
+# How-to guides
 
 ```{toctree}
 :maxdepth: 1
 
-guides/checkpointing_solutions.md
-guides/custom_model.md
-guides/gcp_workload_observability.md
-guides/features_and_diagnostics.md
-guides/install_maxtext.md
-guides/knowledge_distillation.md
+guides/optimization.md
 guides/data_input_pipeline.md
-guides/monitor_goodput.md
-guides/megascale_hang_playbook.md
-guides/multimodal.md
-guides/pallas_kernels_performance.md
-guides/run_maxtext.md
-guides/understand_logs_and_metrics.md
-guides/update_dependencies.md
-guides/use_vertex_ai_tensorboard.md
-guides/xprof_user_guide.md
+guides/checkpointing_solutions.md
+guides/monitoring_and_debugging.md
 ```

docs/guides/checkpointing_solutions.md

@@ -1,4 +1,5 @@
-# Checkpointing solutions
+(checkpointing_solutions)=
+# Checkpointing
 
 ```{toctree}
 :maxdepth: 1

docs/guides/data_input_pipeline.md

@@ -15,7 +15,7 @@
 -->
 
 (data-input-pipeline)=
-# Manage the data input pipeline
+# Data pipelines
 
 Currently MaxText has three data input pipelines:
 

docs/guides/data_input_pipeline/data_pipeline_perf.md

@@ -14,7 +14,7 @@
  limitations under the License.
  -->
 
-# Data input pipeline performance
+# Optimizing pipeline performance
 
 This guide explains how to set and verify the performance goal for your data input pipeline to maximize accelerator utilization.
 

docs/guides/install_maxtext.md

@@ -0,0 +1,29 @@
+<!--
+ Copyright 2024 Google LLC
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+      https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+
+# Monitoring and debugging
+
+```{toctree}
+:maxdepth: 1
+monitoring_and_debugging/features_and_diagnostics.md
+monitoring_and_debugging/gcp_workload_observability.md
+monitoring_and_debugging/megascale_hang_playbook.md
+monitoring_and_debugging/monitor_goodput.md
+monitoring_and_debugging/understand_logs_and_metrics.md
+monitoring_and_debugging/use_vertex_ai_tensorboard.md
+monitoring_and_debugging/xprof_user_guide.md
+```