index.rst 2.62 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 18
######################
nGraph Compiler stack 
######################
19 20


21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
.. _ngraph_home:

.. only:: release

  nGraph Compiler stack documentation for version |version|.

   Documentation for the latest (master) development branch can be found 
   at https://ngraph.nervanasys.com/docs/latest 
   .. https://docs.ngraph.ai/

.. only:: (development or daily)

   nGraph Compiler stack documentation for the master tree under development 
   (version |version|).

For information about the releases, see the :doc:`../project/release-notes`. 

The nGraph Library and Compiler stack are provided under the `Apache 2.0 license`_ 
(found in the LICENSE file in the project's `GitHub repo`_). It may also import 
or reference packages, scripts, and other files that use licensing.

.. _Apache 2.0 license: https://github.com/NervanaSystems/ngraph/blob/master/LICENSE
.. _GitHub repo: https://github.com/NervanaSystems/ngraph
44

Scott Cyphers's avatar
Scott Cyphers committed
45

46 47
.. toctree::
   :maxdepth: 1
48
   :caption: Getting Started
49 50 51 52
   
   frameworks/index.rst
   frameworks/validated/list.rst
   frameworks/generic-configs.rst
Scott Cyphers's avatar
Scott Cyphers committed
53

54

55 56 57 58
.. toctree::
   :maxdepth: 1
   :caption: nGraph Core

Leona C's avatar
Leona C committed
59
   buildlb.rst
60
   core/overview.rst
61
   core/fusion/index.rst
62
   nGraph Core Ops <ops/index.rst>
63 64
   core/constructing-graphs/index.rst
   core/passes/passes.rst
65

66
   
harryskim's avatar
harryskim committed
67 68
.. toctree::
   :maxdepth: 1
Leona C's avatar
Leona C committed
69
   :caption: nGraph Python API
harryskim's avatar
harryskim committed
70 71 72

   python_api/index.rst

73 74 75
   
.. toctree::
   :maxdepth: 1
76
   :caption: Backend Developers
L.S. Cook's avatar
L.S. Cook committed
77

78 79
   backends/index.rst
   backends/cpp-api.rst
80

Scott Cyphers's avatar
Scott Cyphers committed
81

L.S. Cook's avatar
L.S. Cook committed
82 83
.. toctree::
   :maxdepth: 1
84 85 86
   :caption: Inspecting Graphs

   inspection/index.rst
87

L.S. Cook's avatar
L.S. Cook committed
88 89

.. toctree::
90
   :maxdepth: 1
L.S. Cook's avatar
L.S. Cook committed
91 92
   :caption: Project Metadata

93
   project/release-notes.rst
94
   project/introduction.rst
95
   project/contribution-guide.rst
96
   project/doc-contributor-README.rst
97 98
   project/index.rst
   project/extras.rst 
L.S. Cook's avatar
L.S. Cook committed
99
   glossary.rst
100

101 102
.. only:: html

103 104 105
Indices and tables
==================

106
   * :ref:`search`
107
   * :ref:`genindex`