index.rst 4.85 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
Welcome
=======
23

24
See the latest :doc:`project/release-notes`.
25

26 27 28 29 30
nGraph is an open-source C++ library, compiler stack, and runtime accelerator
for software and neural network engineering within the :abbr:`Deep Learning (DL)`
ecosystem. nGraph simplifies development and makes it possible to design, write,
compile, and deploy :abbr:`Deep Neural Network (DNN)`-based solutions that can
be adapted and deployed across many frameworks and backends. See our project
L.S. Cook's avatar
L.S. Cook committed
31
:doc:`project/about` and `ecosystem`_ for more details.
32

L.S. Cook's avatar
L.S. Cook committed
33 34
.. figure:: graphics/ngcompiler-ecosystem.png
   :width: 650px
35
   :alt: ecosystem
36

37
   The Intel nGraph Compiler stack supports a broad ecosystem of frameworks and backends.
38 39 40


.. _quickstart:
41

42 43
Quick Start
===========
44

45
We have many documentation pages to help you get started.
46

47 48
* **TensorFlow or MXNet users** can get started with
  :doc:`framework-integration-guides`.
49

50
   * `TensorFlow bridge to nGraph`_
L.S. Cook's avatar
L.S. Cook committed
51
   * `Compiling MXNet with nGraph`_
52 53 54 55 56

   .. note:: Note that the ``pip`` package option works only with Ubuntu 16.04
      or greater and Intel® Xeon® CPUs. CPUs without Intel® Advanced Vector Extensions
      512 (Intel® AVX-512) will not run these packages; the alternative is to
      build from source. Wider support for other CPUs will be offered starting
L.S. Cook's avatar
L.S. Cook committed
57
      in early 2019.
58

59 60
* **Data scientists** interested in the `ONNX`_ format will find the
  `nGraph ONNX companion tool`_ of interest.
L.S. Cook's avatar
L.S. Cook committed
61

62 63 64
* **Framework authors and architects** will likely want to :doc:`buildlb`
  and learn how nGraph can be used to :doc:`howto/execute`. For examples
  of generic configurations or optimizations available when designing or
L.S. Cook's avatar
L.S. Cook committed
65
  bridging a framework directly with nGraph, see :doc:`frameworks/index`.
66

67
* To start learning about nGraph's set of **Core ops** and how they can
68 69
  be used with Ops from other frameworks, go to :doc:`ops/index`.

70
* **Optimization pass writers** will find :doc:`fusion/index` useful. Also
71 72
  look for our upcoming documentation on :term:`quantization`.

73
* For details about **PlaidML integration** and other nGraph runtime APIs,
74
  see the section :doc:`programmable/index`.
75 76

.. csv-table::
L.S. Cook's avatar
L.S. Cook committed
77
   :header: "Framework", "Bridge Available?", "ONNX Support?"
78 79 80 81
   :widths: 27, 10, 10

   TensorFlow, Yes, Yes
   MXNet, Yes, Yes
82
   PaddlePaddle, Coming Soon, Yes
L.S. Cook's avatar
L.S. Cook committed
83
   PyTorch, No, Yes
84
   Other, Write your own, Custom
85 86 87


.. csv-table::
L.S. Cook's avatar
L.S. Cook committed
88
   :header: "Backend", "Current support", "Future nGraph support"
89 90 91
   :widths: 35, 10, 10

   Intel® Architecture Processors (CPUs), Yes, Yes
L.S. Cook's avatar
L.S. Cook committed
92
   Intel® Nervana™ Neural Network Processor (NNPs), Yes, Yes
93
   Intel® Architecture GPUs, Yes, Yes
94
   AMD\* GPUs, via PlaidML, Yes
95
   :abbr:`Field Programmable Gate Arrays (FPGA)` (FPGAs), Coming soon, Yes
96
   NVIDIA\* GPUs, via PlaidML, Some
L.S. Cook's avatar
L.S. Cook committed
97
   Intel Movidius™ Myriad™ 2 (VPU), Coming soon, Yes
Scott Cyphers's avatar
Scott Cyphers committed
98 99


100 101
.. note:: The code in this repo is under active development as we're continually
   adding support for more kinds of DL models and ops, compiler optimizations,
102
   and backend optimizations.
103

L.S. Cook's avatar
L.S. Cook committed
104 105

=======
106

107 108
Contents
========
Scott Cyphers's avatar
Scott Cyphers committed
109

110 111
.. toctree::
   :maxdepth: 1
L.S. Cook's avatar
L.S. Cook committed
112 113 114 115 116 117 118
   :caption: Python Ops for ONNX

   python_api/index.rst

.. toctree::
   :maxdepth: 1
   :caption: Core Documentation
119

120
   buildlb.rst
L.S. Cook's avatar
L.S. Cook committed
121 122 123
   framework-integration-guides.rst
   frameworks/validation.rst
   frameworks/index.rst
L.S. Cook's avatar
L.S. Cook committed
124
   graph-basics.rst
125
   howto/index.rst
L.S. Cook's avatar
L.S. Cook committed
126
   ops/about.rst
Scott Cyphers's avatar
Scott Cyphers committed
127
   ops/index.rst
128
   fusion/index.rst
L.S. Cook's avatar
L.S. Cook committed
129
   programmable/index.rst
130
   distr/index.rst
L.S. Cook's avatar
L.S. Cook committed
131 132 133 134 135

.. toctree::
   :maxdepth: 2
   :caption: Project Metadata

136
   project/index.rst
L.S. Cook's avatar
L.S. Cook committed
137
   glossary.rst
138 139 140 141 142


Indices and tables
==================

143
   * :ref:`search`
144
   * :ref:`genindex`
Scott Cyphers's avatar
Scott Cyphers committed
145

146 147 148


.. _nGraph ONNX companion tool: https://github.com/NervanaSystems/ngraph-onnx
L.S. Cook's avatar
L.S. Cook committed
149
.. _ONNX: http://onnx.ai
150
.. _Movidius: https://www.movidius.com/
151 152
.. _contributions: https://github.com/NervanaSystems/ngraph#how-to-contribute
.. _TensorFlow bridge to nGraph: https://github.com/NervanaSystems/ngraph-tf/blob/master/README.md
153
.. _Compiling MXNet with nGraph: https://github.com/NervanaSystems/ngraph-mxnet/blob/master/README.md
L.S. Cook's avatar
L.S. Cook committed
154
.. _ecosystem: https://github.com/NervanaSystems/ngraph/blob/master/ecosystem-overview.md