Skip to content

N
ngraph
Commit deb4baef authored by Leona C's avatar Leona C Committed by Scott Cyphers
Browse files
Options

Theme updates for nGraph theme in Sphinx (#3597) 

* latest PlaidML-GPU updates for 0.26

* More theme updates

* Cleaner theme to match site

* Update ngraph_theme

* Update Release Notes page for 0.26

* update theme WIP

* Update theme w/feedback

* Add top navigation menu

* more theme customization and cleanup

* Refine more details on new ngraph theme

* Refine some xsys font-kerning

* Theme updates

* Add latest release notes

* Update HE transformer doc

* Fix rendering

* Resolve doc build warnings

* Add doc versions

* test code removed

* remove test code
parent 9a8d3c7c
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 80 additions and 59 deletions
doc/sphinx/ngraph.doxyfile
View file @ deb4baef
......@@ -27,7 +27,7 @@ USE_MATHJAX = YES
GENERATE_XML = YES
WARN_IF_UNDOCUMENTED = @DOXYGEN_WARN_IF_UNDOCUMENTED@
WARN_IF_UNDOCUMENTED = NO
QUIET = @DOXYGEN_QUIET@
......
doc/sphinx/ngraph_theme/footer.html
View file @ deb4baef
......@@ -47,6 +47,6 @@
{%- endif %}</span></span>
{%- block extrafooter %} {% endblock %}
</p>
</footer>
doc/sphinx/ngraph_theme/layout.html
View file @ deb4baef
......@@ -37,6 +37,8 @@
{% if not READTHEDOCS %}
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
{% endif %}
<link href="https://fonts.googleapis.com/css?family=Nunito:300,300i,400&display=swap&subset=latin-ext" rel="stylesheet">
{% for cssfile in css_files %}
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
......@@ -79,6 +81,19 @@
</head>
<body>
<div id="menu-float" class="menu-float">
<a href="https://www.ngraph.ai">Home</a>
<a href="https://www.youtube.com/embed/C9S0nmNS8bQ">Video</a>
<a href="https://www.ngraph.ai/ecosystem">Ecosystem</a>
<a href="https://ngraph.nervanasys.com/docs/latest">Docs</a>
<a href="https://www.ngraph.ai/tutorials">Tutorials</a>
<a href="https://ngraph.slack.com/"><img src="https://cdn.brandfolder.io/5H442O3W/as/pl546j-7le8zk-5h439l/Slack_Mark_Monochrome_White.png?width=35&height=35"></a>
<a href="https://github.com/NervanaSystems/ngraph/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
<a href="https://www.github.com/NervanaSystems/ngraph"><img src="https://travis-ci.org/NervanaSystems/ngraph.svg?branch=master"></a>&nbsp;&nbsp;&nbsp;</div></body>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
......@@ -97,7 +112,7 @@
{% if logo %}
{# Not strictly valid HTML, but it's the only way to display/scale it properly, without weird scripting or heaps of work #}
<img src="{{ pathto('_static/' + logo, 1) }}" class="logo" />
<br/><img src="{{ pathto('_static/' + logo, 1) }}" class="logo" />
{{ project }}
{% endif %}
</a>
......
doc/sphinx/ngraph_theme/static/theme.css deleted 100644 → 0
View file @ 9a8d3c7c
This diff is collapsed.
doc/sphinx/source/backends/index.rst
View file @ deb4baef
......@@ -6,7 +6,8 @@ Working with Backends
* :ref:`what_is_backend`
* :ref:`how_to_use`
* :ref:`miscellaneous_resources`
* :ref:`ngraph_bridge`
* :ref:`opencl`
.. _what_is_backend:
......@@ -70,34 +71,10 @@ interface; each backend implements the following five functions:
against a particular set of tensors.
.. _miscellaneous_resources:
.. _ngraph_bridge:
Miscellaneous resources
=======================
Additional resources for device or framework-specific configurations:
OpenCL
------
OpenCL is needed for the :doc:`plaidml-ng-api/index`; this is not needed if
you have only a CPU backend.
#. Install the latest Linux driver for your system. You can find a list
of drivers at https://software.intel.com/en-us/articles/opencl-drivers;
You may need to install `OpenCL SDK`_ in case of an ``libOpenCL.so`` absence.
#. Any user added to "video" group:
.. code-block:: console
sudo usermod –a –G video <user_id>
may, for example, be able to find details at the ``/sys/module/[system]/parameters/`` location.
nGraph Bridge from TensorFlow\*
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
nGraph bridge
-------------
When specified as the generic backend -- either manually or automatically
from a framework -- ``NGRAPH`` defaults to CPU, and it also allows for
......@@ -119,6 +96,26 @@ depending on the parameters specified.
* ``NGRAPH_INTELGPU_DUMP_FUNCTION`` -- dumps nGraph’s functions
in dot format.
.. _opencl:
OpenCL
------
OpenCL is only needed for the :doc:`plaidml-ng-api/index`; if you have only
a CPU backend, it is not needed.
#. Install the latest Linux driver for your system. You can find a list
of drivers at https://software.intel.com/en-us/articles/opencl-drivers;
You may need to install `OpenCL SDK`_ in case of an ``libOpenCL.so`` absence.
#. Any user added to "video" group:
.. code-block:: console
sudo usermod –a –G video <user_id>
may, for example, be able to find details at the ``/sys/module/[system]/parameters/``
location.
.. _axpy.py example: https://github.com/tensorflow/ngraph-bridge/blob/master/examples/axpy.py
.. _OpenCL SDK: https://software.intel.com/en-us/opencl-sdk
doc/sphinx/source/frameworks/getting_started.rst
View file @ deb4baef
......@@ -22,7 +22,7 @@ will install to a system location.
pip install tensorflow
pip install ngraph-tensorflow-bridge
.. note:: You may need to use the latest versions of ```tensorflow``` and the bridge
.. note:: You may need to use the latest versions of ``tensorflow`` and the bridge
to get pip installs to work. See the :doc:`tensorflow_connect` file for more
detail about working with TensorFlow\*.
......
doc/sphinx/source/index.rst
View file @ deb4baef
......@@ -32,7 +32,6 @@ nGraph Compiler stack
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 `repo`_). It may also import or reference
......@@ -41,10 +40,14 @@ packages, scripts, and other files that use licensing.
.. _Apache 2.0 license: https://github.com/NervanaSystems/ngraph/blob/master/LICENSE
.. _repo: https://github.com/NervanaSystems/ngraph
.. toctree::
:name: mastertoctree
:titlesonly:
.. toctree::
:maxdepth: 1
:caption: Getting Started
:titlesonly:
frameworks/index.rst
frameworks/validated/list.rst
......@@ -97,6 +100,8 @@ packages, scripts, and other files that use licensing.
project/extras/index.rst
glossary.rst
.. only:: html
Indices and tables
......
doc/sphinx/source/ops/pad.rst
View file @ deb4baef
......@@ -101,6 +101,6 @@ new rows and columns with 42.
C++ Interface
=============
.. doxygenclass:: ngraph::op::Pad
.. doxygenclass:: ngraph::op::v0::Pad
:project: ngraph
:members:
doc/sphinx/source/ops/product.rst
View file @ deb4baef
......@@ -70,6 +70,6 @@ Mathematical Definition
C++ Interface
=============
.. doxygenclass:: ngraph::op::Product
.. doxygenclass:: ngraph::op::v0::Product
:project: ngraph
:members:
doc/sphinx/source/ops/softmax.rst
View file @ deb4baef
......@@ -55,6 +55,6 @@ Mathematical Definition
C++ Interface
=============
.. doxygenclass:: ngraph::op::Softmax
.. doxygenclass:: ngraph::op::v0::Softmax
:project: ngraph
:members: m_axes
doc/sphinx/source/project/contribution-guide.rst
View file @ deb4baef
.. project/contribution-guide.rst:
.._contribution_guide:
.. contribution_guide:
##################
Contribution guide
......
doc/sphinx/source/project/extras/homomorphic_encryption.rst
View file @ deb4baef
......@@ -5,19 +5,21 @@ Homomorphic Encryption (HE)
* **Encryption with Intel® HE transformer for nGraph™**
* The `Intel HE_transformer`_ is an experimental nGraph backend
which enables deep learning on encrypted data using homomorphic
encryption.
* `Blog post`_ with `examples`_
* `Blog post`_
* `Examples`_
.. note:: Some implementations using TensorFlow* may also work with the
`nGraph Bridge repo`_ if older versions of ``ngraph-tf`` are not
available.
.. _Intel HE_transformer: https://github.com/NervanaSystems/he-transformer
.. figure:: ../../graphics/nGraph_mask_1-1.png
:alt: nGraph HE logo
:width: 200px
The Intel Homomorphic Encryption (HE) transformer for nGraph
enables deep learning on encrypted data using homomorphic
encryption.
.. _Blog post: https://www.intel.ai/he-transformer-for-ngraph-enabling-deep-learning-on-encrypted-data/
.. _examples: https://github.com/NervanaSystems/he-transformer#examples
.. _nGraph Bridge repo: https://github.com/tensorflow/ngraph-bridge
doc/sphinx/source/project/release-notes.rst
View file @ deb4baef
......@@ -20,11 +20,10 @@ Core updates for |version|
--------------------------
+ All ops support ``Output<Node>`` arguments
+ Additional ops
+ ONNX handling unknown domains
Latest documentation updates for |version|
------------------------------------------
+ Note the only support for nGPU is now through PlaidML; nGraph support for nGPU
(via cuDNN) has been deprecated.
+ iGPU works only with nGraph version `0.24`.
......@@ -41,6 +40,8 @@ Changelog on Previous Releases
+ Allow DLLs that link nGraph statically to load backends
+ Add rank id to trace file name
+ Allow provenance merging to be disabled
+ Remove some white-listed compiler warnings
+ Provenance on builders and fused op expansions
0.25.0
......
doc/sphinx/source/python_api/_autosummary/ngraph.rst
View file @ deb4baef
......@@ -2,9 +2,9 @@ ngraph package
==============
.. automodule:: ngraph
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
......@@ -13,23 +13,24 @@ ngraph.exceptions module
------------------------
.. automodule:: ngraph.exceptions
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
ngraph.ops module
-----------------
.. automodule:: ngraph.ops
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
ngraph.runtime module
---------------------
.. automodule:: ngraph.runtime
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment