index.rst 2.57 KB
Newer Older
1
.. ---------------------------------------------------------------------------
2
.. Copyright 2018-2019 Intel Corporation
3 4 5 6 7 8 9 10 11 12 13 14
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
..
..      http://www.apache.org/licenses/LICENSE-2.0
..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
.. ---------------------------------------------------------------------------
15

16

17
.. This documentation is available online at
18
.. https://ngraph.nervanasys.com/docs/latest
19

20 21 22
######################
nGraph Compiler stack 
######################
23 24


25 26
.. toctree::
   :maxdepth: 1 
27

28
   project/introduction.rst
29

Scott Cyphers's avatar
Scott Cyphers committed
30

31 32 33 34 35 36 37
.. toctree::
   :maxdepth: 1
   :caption: Framework Support
   
   frameworks/index.rst
   frameworks/validated/list.rst
   frameworks/generic-configs.rst
Scott Cyphers's avatar
Scott Cyphers committed
38

39

40 41 42 43 44
.. toctree::
   :maxdepth: 1
   :caption: nGraph Core

   core/overview.rst
45
   core/fusion/index.rst
46
   nGraph Core Ops <ops/index.rst>
47 48
   core/constructing-graphs/index.rst
   core/passes/passes.rst
49
   buildlb.rst
50
   
51 52 53 54
   
.. toctree::
   :maxdepth: 1
   :caption: Backend support
L.S. Cook's avatar
L.S. Cook committed
55

56 57
   backend-support/index.rst
   backend-support/cpp-api.rst
58

Scott Cyphers's avatar
Scott Cyphers committed
59

60 61
.. toctree::
   :maxdepth: 1
62 63 64
   :caption: Distributed training

   distr/index.rst
L.S. Cook's avatar
L.S. Cook committed
65 66 67 68


.. toctree::
   :maxdepth: 1
69 70 71 72 73 74
   :caption: Diagnostics and visualization

   diagnostics/nbench.rst
   diagnostics/performance-profile.rst
   diagnostics/visualize.rst
   diagnostics/debug.rst 
75

76 77 78 79 80 81
.. toctree::
   :maxdepth: 1
   :caption: Tutorials

   tutorials/index.rst

L.S. Cook's avatar
L.S. Cook committed
82 83

.. toctree::
84
   :maxdepth: 1
L.S. Cook's avatar
L.S. Cook committed
85 86
   :caption: Project Metadata

87 88 89
   project/release-notes.rst
   project/contribution-guide.rst
   project/index.rst 
L.S. Cook's avatar
L.S. Cook committed
90
   glossary.rst
91
   project/doc-contributor-README.rst
92

93

94 95 96
Indices and tables
==================

97
   * :ref:`search`
98
   * :ref:`genindex`
Scott Cyphers's avatar
Scott Cyphers committed
99

100 101 102


.. _nGraph ONNX companion tool: https://github.com/NervanaSystems/ngraph-onnx
L.S. Cook's avatar
L.S. Cook committed
103
.. _ONNX: http://onnx.ai
104
.. _Movidius: https://www.movidius.com/
105 106
.. _contributions: https://github.com/NervanaSystems/ngraph#how-to-contribute
.. _TensorFlow bridge to nGraph: https://github.com/NervanaSystems/ngraph-tf/blob/master/README.md
107
.. _Compiling MXNet with nGraph: https://github.com/NervanaSystems/ngraph-mxnet/blob/master/README.md
L.S. Cook's avatar
L.S. Cook committed
108
.. _ecosystem: https://github.com/NervanaSystems/ngraph/blob/master/ecosystem-overview.md