Skip to content

Commit

Permalink
Sparsity getting started docs (#1592)
Browse files Browse the repository at this point in the history
  • Loading branch information
jainapurva authored Jan 22, 2025
1 parent 5d1444b commit 166a357
Show file tree
Hide file tree
Showing 2 changed files with 744 additions and 82 deletions.
95 changes: 15 additions & 80 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,80 +3,25 @@ Welcome to the torchao Documentation

`torchao <https://github.com/pytorch/ao>`__ 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 <https://github.com/pytorch/ao#torchao-pytorch-architecture-optimization>`__ 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
1. Getting Started
2. Developer Notes
3. API Reference
4. 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:
.. toctree::
:glob:
:maxdepth: 1
:caption: Getting Started

overview
getting-started
getting-started
sparsity

.. toctree::
:glob:
:maxdepth: 1
:caption: Tutorials
:hidden:
.. toctree::
:glob:
:maxdepth: 1
:caption: Developer Notes

tutorials/template_tutorial
contributor_guide

.. toctree::
:glob:
Expand All @@ -86,20 +31,10 @@ 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: Tutorials

serialization

Loading

0 comments on commit 166a357

Please sign in to comment.