index.rst 2.23 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
Intel nGraph++ library
18
######################
19

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

Scott Cyphers's avatar
Scott Cyphers committed
25 26
.. figure:: graphics/ngraph-hub.png  

27 28
For this early release, we've provided :doc:`framework-integration-guides` to 
compile and run MXNet\* and TensorFlow\*-based projects.
L.S. Cook's avatar
L.S. Cook committed
29

30 31 32 33 34
.. 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 
35
efficiency on target hardware. Initially-supported backends include Intel 
36
Architecture CPUs (``CPU``), the Intel® Nervana Neural Network Processor™ (NNP), 
37 38
and NVIDIA\* GPUs. Currently-supported compiler optimizations include efficient 
memory management and data layout abstraction. 
L.S. Cook's avatar
L.S. Cook committed
39

Scott Cyphers's avatar
Scott Cyphers committed
40 41 42
Further project details can be found on our :doc:`project/about` page. 


L.S. Cook's avatar
L.S. Cook committed
43 44

=======
45

Scott Cyphers's avatar
Scott Cyphers committed
46 47 48
Sections
=========

49 50 51
.. toctree::
   :maxdepth: 1
   :name: tocmaster
Scott Cyphers's avatar
Scott Cyphers committed
52
   :caption: Table of Contents
53

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


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

65
   * :ref:`search`   
66
   * :ref:`genindex`
Scott Cyphers's avatar
Scott Cyphers committed
67

68