index.rst 3.25 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
nGraph is an open-source graph compiler for :abbr:`Artificial Neural Networks (ANNs)`. 
Leona C's avatar
Leona C committed
26
The nGraph Compiler stack provides an inherently efficient graph-based compilation 
27
infrastructure designed to be compatible with many upcoming 
Leona C's avatar
Leona C committed
28 29
:abbr:`Application-Specific Integrated Circuits (ASICs)`, like the Intel® Nervana™ 
Neural Network Processor (Intel® Nervana™ NNP), while also unlocking a massive 
30 31 32 33 34
performance boost on any existing hardware targets for your neural network: both 
GPUs and CPUs. Using its flexible infrastructure, you will find it becomes much 
easier to create Deep Learning (DL) models that can adhere to the "write once, 
run anywhere" mantra that enables your AI solutions to easily go from concept to 
production to scale.
35

Leona C's avatar
Leona C committed
36 37
Frameworks using nGraph to execute workloads have shown `up to 45X`_ performance 
boost compared to native implementations. For a high-level overview, see the 
38
:doc:`project/introduction` and our latest :doc:`project/release-notes`.
Scott Cyphers's avatar
Scott Cyphers committed
39

40 41
.. toctree::
   :maxdepth: 1
Leona C's avatar
Leona C committed
42
   :caption: Connecting Frameworks
43 44 45 46
   
   frameworks/index.rst
   frameworks/validated/list.rst
   frameworks/generic-configs.rst
Scott Cyphers's avatar
Scott Cyphers committed
47

48

49 50 51 52
.. toctree::
   :maxdepth: 1
   :caption: nGraph Core

Leona C's avatar
Leona C committed
53
   buildlb.rst
54
   core/overview.rst
55
   core/fusion/index.rst
56
   nGraph Core Ops <ops/index.rst>
57 58
   core/constructing-graphs/index.rst
   core/passes/passes.rst
59
   
harryskim's avatar
harryskim committed
60 61
.. toctree::
   :maxdepth: 1
Leona C's avatar
Leona C committed
62
   :caption: nGraph Python API
harryskim's avatar
harryskim committed
63 64 65

   python_api/index.rst

66 67 68
   
.. toctree::
   :maxdepth: 1
69
   :caption: Backend Support
L.S. Cook's avatar
L.S. Cook committed
70

71 72
   backend-support/index.rst
   backend-support/cpp-api.rst
73

Scott Cyphers's avatar
Scott Cyphers committed
74

75 76
.. toctree::
   :maxdepth: 1
Leona C's avatar
Leona C committed
77
   :caption: Distributed Training
78 79

   distr/index.rst
L.S. Cook's avatar
L.S. Cook committed
80 81 82 83


.. toctree::
   :maxdepth: 1
84
   :caption: Diagnostics and Visualization
85 86 87 88 89

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

91 92 93 94
.. toctree::
   :maxdepth: 1
   :caption: Tutorials

Leona C's avatar
Leona C committed
95
   nGraph.ai Tutorials <https://www.ngraph.ai/tutorials>   
96

L.S. Cook's avatar
L.S. Cook committed
97 98

.. toctree::
99
   :maxdepth: 1
L.S. Cook's avatar
L.S. Cook committed
100 101
   :caption: Project Metadata

Leona C's avatar
Leona C committed
102
   project/introduction.rst
103 104
   project/release-notes.rst
   project/contribution-guide.rst
105 106
   project/governance.rst
   project/doc-contributor-README.rst
107
   project/index.rst 
L.S. Cook's avatar
L.S. Cook committed
108
   glossary.rst
109

110 111 112
Indices and tables
==================

113
   * :ref:`search`
114
   * :ref:`genindex`
Leona C's avatar
Leona C committed
115 116 117 118




119
.. nGraph: https://www.ngraph.ai
Leona C's avatar
Leona C committed
120
.. _up to 45X: https://ai.intel.com/ngraph-compiler-stack-beta-release/