From 9b19e79bdeb9fe45b4602217e9d1d7991143a794 Mon Sep 17 00:00:00 2001 From: jainapurva Date: Tue, 21 Jan 2025 15:25:37 -0800 Subject: [PATCH] Index updates --- docs/source/index.rst | 105 ++++-------------------------------------- 1 file changed, 8 insertions(+), 97 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 9b3e3e50aa..3bbcd203fd 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,96 +3,23 @@ Welcome to the torchao Documentation `torchao `__ is a library for custom data types & optimizations. Quantize and sparsify weights, gradients, optimizers & activations for inference and training using native PyTorch. Please checkout torchao `README `__ for an overall introduction to the library and recent highlight and updates. The documentation here will focus on: -1. API Reference -2. Developer Contribution Guide -3. Tutorials - -.. - .. grid:: 3 - - .. grid-item-card:: :octicon:`file-code;1em` - Getting Started - :img-top: _static/img/card-background.svg - :link: getting-started.html - :link-type: url - - Learn about how to get started with torchao - and ts application in your projects. - - .. grid-item-card:: :octicon:`file-code;1em` - Concepts - :img-top: _static/img/card-background.svg - :link: dtypes.html - :link-type: url - - Learn about the key torchao concepts such - as dtypes, quantization, sparsity, among others. - - .. grid-item-card:: :octicon:`file-code;1em` - API Reference - :img-top: _static/img/card-background.svg - :link: api_ref_intro.html - :link-type: url - - A comprehensive reference for the torchao - API and its functionalities. - - Tutorials - ~~~~~~~~~ - - Ready to experiment? Check out some of the - torchao tutorials. - - .. customcardstart:: - - .. customcarditem:: - :header: Template Tutorial - :card_description: A placeholder template for demo purposes - :image: _static/img/generic-pytorch-logo.png - :link: tutorials/template_tutorial.html - :tags: template - - .. customcardend:: - - -.. ---------------------------------------------------------------------- -.. Below is the toctree i.e. it defines the content of the left sidebar. -.. Each of the entry below corresponds to a file.rst in docs/source/. -.. ---------------------------------------------------------------------- - -.. - .. toctree:: - :glob: - :maxdepth: 1 - :caption: Getting Started - :hidden: - - overview - getting-started - - .. toctree:: - :glob: - :maxdepth: 1 - :caption: Tutorials - :hidden: - - tutorials/template_tutorial +1. Getting Started +2. Developer Notes +3. API Reference +4. Tutorials .. toctree:: :glob: :maxdepth: 1 - :caption: API Reference + :caption: Getting Started - api_ref_dtypes - api_ref_quantization - api_ref_sparsity -.. - api_ref_kernel + getting-started + sparsity .. toctree:: :glob: :maxdepth: 1 - :caption: Community + :caption: Developer Notes contributor_guide @@ -104,22 +31,6 @@ Welcome to the torchao Documentation api_ref_dtypes api_ref_quantization api_ref_sparsity -.. - api_ref_kernel - -.. toctree:: - :glob: - :maxdepth: 1 - :caption: Contributor Guide - - contributor_guide - -.. toctree:: - :glob: - :maxdepth: 1 - :caption: Developer Notes - - sparsity .. toctree:: :glob: