index.rst 2.34 KB
Newer Older
1
.. ---------------------------------------------------------------------------
L.S. Cook's avatar
L.S. Cook committed
2
.. Copyright 2018 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 18
###############
nGraph library
###############
19

20
Welcome to Intel® nGraph™, an open source C++ library and compiler. This 
21
project enables modern compute platforms to run and train :abbr:`Deep Neural Network (DNN)` 
22 23
models. It is framework-neutral and supports a variety of backends used by 
:abbr:`Deep Learning (DL)` frameworks. 
24

25
.. image:: graphics/ngraph-ecosys.png
26
   :width: 585px
Scott Cyphers's avatar
Scott Cyphers committed
27

28
For this early release, we've provided :doc:`framework-integration-guides` to 
29
compile and run MXNet\* and TensorFlow\*-based projects. If you already have 
30 31
a trained model, see our section on How to :doc:`howto/import` and start working 
with the nGraph APIs.  
L.S. Cook's avatar
L.S. Cook committed
32

33 34 35 36 37
.. note:: The library code is under active development as we're continually 
   adding support for more ops, more frameworks, and more backends. 

The nGraph++ library translates a framework’s representation of computations 
into an :abbr:`Intermediate Representation (IR)` that promotes computational 
38
efficiency on target hardware. Initially-supported backends include Intel 
39
Architecture CPUs (``CPU``), the Intel® Nervana Neural Network Processor™ (NNP), 
40 41
and NVIDIA\* GPUs. Currently-supported compiler optimizations include efficient 
memory management and data layout abstraction. 
L.S. Cook's avatar
L.S. Cook committed
42

Scott Cyphers's avatar
Scott Cyphers committed
43 44 45
Further project details can be found on our :doc:`project/about` page. 


L.S. Cook's avatar
L.S. Cook committed
46 47

=======
48

49 50
Contents
========
Scott Cyphers's avatar
Scott Cyphers committed
51

52 53 54
.. toctree::
   :maxdepth: 1
   :name: tocmaster
55
   :caption: Documentation
56

57
   install.rst
L.S. Cook's avatar
L.S. Cook committed
58
   graph-basics.rst
59
   howto/index.rst
Scott Cyphers's avatar
Scott Cyphers committed
60
   ops/index.rst
61
   framework-integration-guides.rst
Scott Cyphers's avatar
Scott Cyphers committed
62
   project/index.rst
63 64 65 66 67


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

68
   * :ref:`search`   
69
   * :ref:`genindex`
Scott Cyphers's avatar
Scott Cyphers committed
70

71