index.rst 2.53 KB
Newer Older
1
.. Copyright 2017-2019 Intel Corporation
2 3 4 5 6 7 8 9 10 11 12 13
.. 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.
.. ---------------------------------------------------------------------------
14

15 16 17
######################
nGraph Compiler stack 
######################
18 19


20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
.. _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`_ 
38 39
(found in the LICENSE file in the project's `repo`_). It may also import or reference 
packages, scripts, and other files that use licensing.
40 41

.. _Apache 2.0 license: https://github.com/NervanaSystems/ngraph/blob/master/LICENSE
42
.. _repo: https://github.com/NervanaSystems/ngraph
43

Scott Cyphers's avatar
Scott Cyphers committed
44

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

53

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

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

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

   python_api/index.rst

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

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

Scott Cyphers's avatar
Scott Cyphers committed
80

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

   inspection/index.rst
86

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

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

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

100 101
.. only:: html

102 103 104
Indices and tables
==================

105
   * :ref:`search`
106
   * :ref:`genindex`