Skip to content

Commit 166a357

Browse files
authored
Sparsity getting started docs (#1592)
1 parent 5d1444b commit 166a357

File tree

2 files changed

+744
-82
lines changed

2 files changed

+744
-82
lines changed

docs/source/index.rst

+15-80
Original file line numberDiff line numberDiff line change
@@ -3,80 +3,25 @@ Welcome to the torchao Documentation
33

44
`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:
55

6-
1. API Reference
7-
2. Developer Contribution Guide
8-
3. Tutorials
6+
1. Getting Started
7+
2. Developer Notes
8+
3. API Reference
9+
4. Tutorials
910

10-
..
11-
.. grid:: 3
12-
13-
.. grid-item-card:: :octicon:`file-code;1em`
14-
Getting Started
15-
:img-top: _static/img/card-background.svg
16-
:link: getting-started.html
17-
:link-type: url
18-
19-
Learn about how to get started with torchao
20-
and ts application in your projects.
21-
22-
.. grid-item-card:: :octicon:`file-code;1em`
23-
Concepts
24-
:img-top: _static/img/card-background.svg
25-
:link: dtypes.html
26-
:link-type: url
27-
28-
Learn about the key torchao concepts such
29-
as dtypes, quantization, sparsity, among others.
30-
31-
.. grid-item-card:: :octicon:`file-code;1em`
32-
API Reference
33-
:img-top: _static/img/card-background.svg
34-
:link: api_ref_intro.html
35-
:link-type: url
36-
37-
A comprehensive reference for the torchao
38-
API and its functionalities.
39-
40-
Tutorials
41-
~~~~~~~~~
42-
43-
Ready to experiment? Check out some of the
44-
torchao tutorials.
45-
46-
.. customcardstart::
47-
48-
.. customcarditem::
49-
:header: Template Tutorial
50-
:card_description: A placeholder template for demo purposes
51-
:image: _static/img/generic-pytorch-logo.png
52-
:link: tutorials/template_tutorial.html
53-
:tags: template
54-
55-
.. customcardend::
56-
57-
58-
.. ----------------------------------------------------------------------
59-
.. Below is the toctree i.e. it defines the content of the left sidebar.
60-
.. Each of the entry below corresponds to a file.rst in docs/source/.
61-
.. ----------------------------------------------------------------------
62-
63-
..
64-
.. toctree::
65-
:glob:
66-
:maxdepth: 1
67-
:caption: Getting Started
68-
:hidden:
11+
.. toctree::
12+
:glob:
13+
:maxdepth: 1
14+
:caption: Getting Started
6915

70-
overview
71-
getting-started
16+
getting-started
17+
sparsity
7218

73-
.. toctree::
74-
:glob:
75-
:maxdepth: 1
76-
:caption: Tutorials
77-
:hidden:
19+
.. toctree::
20+
:glob:
21+
:maxdepth: 1
22+
:caption: Developer Notes
7823

79-
tutorials/template_tutorial
24+
contributor_guide
8025

8126
.. toctree::
8227
:glob:
@@ -86,20 +31,10 @@ Welcome to the torchao Documentation
8631
api_ref_dtypes
8732
api_ref_quantization
8833
api_ref_sparsity
89-
..
90-
api_ref_kernel
91-
92-
.. toctree::
93-
:glob:
94-
:maxdepth: 1
95-
:caption: Contributor Guide
96-
97-
contributor_guide
9834

9935
.. toctree::
10036
:glob:
10137
:maxdepth: 1
10238
:caption: Tutorials
10339

10440
serialization
105-

0 commit comments

Comments
 (0)