index.rst 6.34 KB
Newer Older
1
2
:orphan:

3
4
Tutorials
=========
5
6
7



8
.. raw:: html
9

10
    <div class="sphx-glr-thumbnails">
11
12


J-shang's avatar
J-shang committed
13
14
15
16
17
18
.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Introduction ------------">

.. only:: html

19
20
  .. image:: /tutorials/images/thumb/sphx_glr_pruning_speedup_thumb.png
    :alt: Speedup Model with Mask
J-shang's avatar
J-shang committed
21

22
  :ref:`sphx_glr_tutorials_pruning_speedup.py`
J-shang's avatar
J-shang committed
23
24
25

.. raw:: html

26
      <div class="sphx-glr-thumbnail-title">Speedup Model with Mask</div>
J-shang's avatar
J-shang committed
27
28
29
30
31
    </div>


.. raw:: html

32
    <div class="sphx-glr-thumbcontainer" tooltip=" Introduction ------------">
J-shang's avatar
J-shang committed
33
34
35

.. only:: html

36
37
  .. image:: /tutorials/images/thumb/sphx_glr_quantization_speedup_thumb.png
    :alt: SpeedUp Model with Calibration Config
J-shang's avatar
J-shang committed
38

39
  :ref:`sphx_glr_tutorials_quantization_speedup.py`
J-shang's avatar
J-shang committed
40
41
42

.. raw:: html

43
      <div class="sphx-glr-thumbnail-title">SpeedUp Model with Calibration Config</div>
J-shang's avatar
J-shang committed
44
45
46
47
48
    </div>


.. raw:: html

49
    <div class="sphx-glr-thumbcontainer" tooltip="Here is a four-minute video to get you started with model quantization.">
J-shang's avatar
J-shang committed
50
51
52

.. only:: html

53
54
  .. image:: /tutorials/images/thumb/sphx_glr_quantization_quick_start_mnist_thumb.png
    :alt: Quantization Quickstart
J-shang's avatar
J-shang committed
55

56
  :ref:`sphx_glr_tutorials_quantization_quick_start_mnist.py`
J-shang's avatar
J-shang committed
57
58
59

.. raw:: html

60
      <div class="sphx-glr-thumbnail-title">Quantization Quickstart</div>
J-shang's avatar
J-shang committed
61
62
63
64
65
    </div>


.. raw:: html

66
    <div class="sphx-glr-thumbcontainer" tooltip="Here is a three-minute video to get you started with model pruning.">
J-shang's avatar
J-shang committed
67
68
69

.. only:: html

70
71
  .. image:: /tutorials/images/thumb/sphx_glr_pruning_quick_start_mnist_thumb.png
    :alt: Pruning Quickstart
J-shang's avatar
J-shang committed
72

73
  :ref:`sphx_glr_tutorials_pruning_quick_start_mnist.py`
J-shang's avatar
J-shang committed
74
75
76

.. raw:: html

77
      <div class="sphx-glr-thumbnail-title">Pruning Quickstart</div>
J-shang's avatar
J-shang committed
78
79
80
    </div>


J-shang's avatar
J-shang committed
81
82
83
84
85
86
.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="To write a new quantization algorithm, you can write a class that inherits nni.compression.pyto...">

.. only:: html

87
88
  .. image:: /tutorials/images/thumb/sphx_glr_quantization_customize_thumb.png
    :alt: Customize a new quantization algorithm
J-shang's avatar
J-shang committed
89

90
  :ref:`sphx_glr_tutorials_quantization_customize.py`
J-shang's avatar
J-shang committed
91
92
93

.. raw:: html

94
      <div class="sphx-glr-thumbnail-title">Customize a new quantization algorithm</div>
J-shang's avatar
J-shang committed
95
96
97
    </div>


98
99
.. raw:: html

Yuge Zhang's avatar
Yuge Zhang committed
100
    <div class="sphx-glr-thumbcontainer" tooltip="In this tutorial, we show how to use NAS Benchmarks as datasets. For research purposes we somet...">
101
102
103

.. only:: html

104
105
  .. image:: /tutorials/images/thumb/sphx_glr_nasbench_as_dataset_thumb.png
    :alt: Use NAS Benchmarks as Datasets
106

107
  :ref:`sphx_glr_tutorials_nasbench_as_dataset.py`
108
109
110

.. raw:: html

111
      <div class="sphx-glr-thumbnail-title">Use NAS Benchmarks as Datasets</div>
112
113
114
    </div>


J-shang's avatar
J-shang committed
115
116
117
118
119
120
.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Users can easily customize a basic pruner in NNI. A large number of basic modules have been pro...">

.. only:: html

121
122
  .. image:: /tutorials/images/thumb/sphx_glr_pruning_customize_thumb.png
    :alt: Customize Basic Pruner
J-shang's avatar
J-shang committed
123

124
  :ref:`sphx_glr_tutorials_pruning_customize.py`
J-shang's avatar
J-shang committed
125
126
127

.. raw:: html

128
      <div class="sphx-glr-thumbnail-title">Customize Basic Pruner</div>
J-shang's avatar
J-shang committed
129
130
131
    </div>


132
.. raw:: html
J-shang's avatar
J-shang committed
133

134
135
136
137
138
139
140
141
    <div class="sphx-glr-thumbcontainer" tooltip="This is the 101 tutorial of Neural Architecture Search (NAS) on NNI. In this tutorial, we will ...">

.. only:: html

  .. image:: /tutorials/images/thumb/sphx_glr_hello_nas_thumb.png
    :alt: Hello, NAS!

  :ref:`sphx_glr_tutorials_hello_nas.py`
J-shang's avatar
J-shang committed
142

Yuge Zhang's avatar
Yuge Zhang committed
143
144
.. raw:: html

145
146
147
148
149
150
151
      <div class="sphx-glr-thumbnail-title">Hello, NAS!</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Workable Pruning Process ------------------------">
Yuge Zhang's avatar
Yuge Zhang committed
152
153
154

.. only:: html

155
156
157
158
159
160
161
162
163
  .. image:: /tutorials/images/thumb/sphx_glr_pruning_bert_glue_thumb.png
    :alt: Pruning Transformer with NNI

  :ref:`sphx_glr_tutorials_pruning_bert_glue.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Pruning Transformer with NNI</div>
    </div>
Yuge Zhang's avatar
Yuge Zhang committed
164
165
166
167
168
169
170
171
172
173


.. raw:: html

    </div>


.. toctree::
   :hidden:

174
175
176
177
178
179
180
   /tutorials/pruning_speedup
   /tutorials/quantization_speedup
   /tutorials/quantization_quick_start_mnist
   /tutorials/pruning_quick_start_mnist
   /tutorials/quantization_customize
   /tutorials/nasbench_as_dataset
   /tutorials/pruning_customize
Yuge Zhang's avatar
Yuge Zhang committed
181
   /tutorials/hello_nas
182
   /tutorials/pruning_bert_glue
183
184
185



liuzhe-lz's avatar
liuzhe-lz committed
186

187
.. raw:: html
liuzhe-lz's avatar
liuzhe-lz committed
188

189
    <div class="sphx-glr-thumbnails">
liuzhe-lz's avatar
liuzhe-lz committed
190
191
192
193


.. raw:: html

liuzhe-lz's avatar
liuzhe-lz committed
194
    <div class="sphx-glr-thumbcontainer" tooltip="The tutorial consists of 4 steps: ">
liuzhe-lz's avatar
liuzhe-lz committed
195
196
197

.. only:: html

198
199
  .. image:: /tutorials/hpo_quickstart_pytorch/images/thumb/sphx_glr_main_thumb.png
    :alt: HPO Quickstart with PyTorch
liuzhe-lz's avatar
liuzhe-lz committed
200

201
  :ref:`sphx_glr_tutorials_hpo_quickstart_pytorch_main.py`
liuzhe-lz's avatar
liuzhe-lz committed
202
203
204

.. raw:: html

205
      <div class="sphx-glr-thumbnail-title">HPO Quickstart with PyTorch</div>
liuzhe-lz's avatar
liuzhe-lz committed
206
207
208
209
210
211
212
213
214
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="It can be run directly and will have the exact same result as original version.">

.. only:: html

215
216
  .. image:: /tutorials/hpo_quickstart_pytorch/images/thumb/sphx_glr_model_thumb.png
    :alt: Port PyTorch Quickstart to NNI
liuzhe-lz's avatar
liuzhe-lz committed
217

218
  :ref:`sphx_glr_tutorials_hpo_quickstart_pytorch_model.py`
liuzhe-lz's avatar
liuzhe-lz committed
219
220
221

.. raw:: html

222
      <div class="sphx-glr-thumbnail-title">Port PyTorch Quickstart to NNI</div>
liuzhe-lz's avatar
liuzhe-lz committed
223
224
225
226
227
    </div>


.. raw:: html

228
    </div>
liuzhe-lz's avatar
liuzhe-lz committed
229
230
231



liuzhe-lz's avatar
liuzhe-lz committed
232

233
.. raw:: html
liuzhe-lz's avatar
liuzhe-lz committed
234

235
    <div class="sphx-glr-thumbnails">
liuzhe-lz's avatar
liuzhe-lz committed
236
237
238
239
240
241
242
243


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The tutorial consists of 4 steps: ">

.. only:: html

244
245
  .. image:: /tutorials/hpo_quickstart_tensorflow/images/thumb/sphx_glr_main_thumb.png
    :alt: HPO Quickstart with TensorFlow
liuzhe-lz's avatar
liuzhe-lz committed
246

247
  :ref:`sphx_glr_tutorials_hpo_quickstart_tensorflow_main.py`
liuzhe-lz's avatar
liuzhe-lz committed
248
249
250

.. raw:: html

251
      <div class="sphx-glr-thumbnail-title">HPO Quickstart with TensorFlow</div>
liuzhe-lz's avatar
liuzhe-lz committed
252
253
254
255
256
257
258
259
260
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="It can be run directly and will have the exact same result as original version.">

.. only:: html

261
262
263
264
265
266
267
268
269
  .. image:: /tutorials/hpo_quickstart_tensorflow/images/thumb/sphx_glr_model_thumb.png
    :alt: Port TensorFlow Quickstart to NNI

  :ref:`sphx_glr_tutorials_hpo_quickstart_tensorflow_model.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Port TensorFlow Quickstart to NNI</div>
    </div>
liuzhe-lz's avatar
liuzhe-lz committed
270
271
272
273
274
275
276
277
278


.. raw:: html

    </div>


.. toctree::
   :hidden:
279
   :includehidden:
liuzhe-lz's avatar
liuzhe-lz committed
280

281
282
   /tutorials/hpo_quickstart_pytorch/index.rst
   /tutorials/hpo_quickstart_tensorflow/index.rst
liuzhe-lz's avatar
liuzhe-lz committed
283
284
285



286
287
288
289
290
.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_