diff --git a/docs/source/index.md b/docs/source/index.md index b65139319a7..5cfce3eefd7 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -1,4 +1,3 @@ -(home)= # Welcome to the ExecuTorch Documentation **ExecuTorch** is PyTorch's solution for efficient AI inference on edge devices — from mobile phones to embedded systems. @@ -29,31 +28,31 @@ ::::{grid} 2 :::{grid-item-card} **Get Started** -:link: quick-start-section -:link-type: doc New to ExecuTorch? Start here for installation and your first model deployment. + +[**Get Started**](quick-start-section) ::: :::{grid-item-card} **Deploy on Edge Platforms** -:link: edge-platforms-section -:link-type: doc Deploy on Android, iOS, Laptops / Desktops and embedded platforms with optimized backends. + +[**Deploy on Edge Platforms**](edge-platforms-section) ::: :::{grid-item-card} **Work with LLMs** -:link: llm/working-with-llms -:link-type: doc Export, optimize, and deploy Large Language Models on edge devices. + +[**Work with LLMs**](llm/working-with-llms) ::: :::{grid-item-card} 🔧 **Developer Tools** -:link: tools-section -:link-type: doc Profile, debug, and inspect your models with comprehensive tooling. + +[**Developer Tools**](tools-section) ::: :::: @@ -64,82 +63,82 @@ Profile, debug, and inspect your models with comprehensive tooling. ::::{grid} 1 :::{grid-item-card} **Intro** -:link: intro-section -:link-type: doc **Overview, architecture, and core concepts** — Understand how ExecuTorch works and its benefits + +[:doc:`Intro`](intro-section) ::: :::: ::::{grid} 1 :::{grid-item-card} **Quick Start** -:link: quick-start-section -:link-type: doc **Get started with ExecuTorch** — Install, export your first model, and run inference + +[:doc:`Quick Start`](quick-start-section) ::: :::: ::::{grid} 1 :::{grid-item-card} **Edge** -:link: edge-platforms-section -:link-type: doc **Android, iOS, Desktop, Embedded** — Platform-specific deployment guides and examples + +[:doc:`Edge`](edge-platforms-section) ::: :::: ::::{grid} 1 :::{grid-item-card} **Backends** -:link: backends-section -:link-type: doc **CPU, GPU, NPU/Accelerator backends** — Hardware acceleration and backend selection + +[:doc:`Backends`](backends-section) ::: :::: ::::{grid} 1 :::{grid-item-card} **LLMs** -:link: llm/working-with-llms -:link-type: doc **LLM export, optimization, and deployment** — Complete LLM workflow for edge devices + +[:doc:`LLMs`](llm/working-with-llms) ::: :::: ::::{grid} 1 :::{grid-item-card} **Advanced** -:link: advanced-topics-section -:link-type: doc **Quantization, memory planning, custom passes** — Deep customization and optimization + +[:doc:`Advanced`](advanced-topics-section) ::: :::: ::::{grid} 1 :::{grid-item-card} **Tools** -:link: tools-section -:link-type: doc **Developer tools, profiling, debugging** — Comprehensive development and debugging suite + +[:doc:`Tools`](tools-section) ::: :::: ::::{grid} 1 :::{grid-item-card} **API** -:link: api-section -:link-type: doc **API Reference Usages & Examples** — Detailed Python, C++, and Java API references + +[:doc:`API`](api-section) ::: :::: ::::{grid} 1 :::{grid-item-card} **💬 Support** -:link: support-section -:link-type: doc **FAQ, troubleshooting, contributing** — Get help and contribute to the project + +[:doc:`💬 Support`](support-section) ::: :::: @@ -165,7 +164,7 @@ Profile, debug, and inspect your models with comprehensive tooling. - Android & iOS - Linux, macOS, Windows - Embedded & MCUs -- Go **→ {doc}`edge-platforms-section`** +- Go **→ [:doc:`edge-platforms-section`](edge-platforms-section)** ::: :::{grid-item} @@ -175,7 +174,7 @@ Profile, debug, and inspect your models with comprehensive tooling. - GPU - NPU - DSP -- Go **→ {doc}`backends-section`** +- Go **→ [:doc:`backends-section`](backends-section)** ::: ::::