Commit 4431d2a3 authored by Leona C's avatar Leona C

Add doc update for 0.26

parent 9294b027
......@@ -5,7 +5,7 @@ Build and Test
###############
* :ref:`default_ngflags`
.. :ref:`ngraph_plaidml_backend`
* :ref:`ngraph_plaidml_backend`
There are a few common paths to take when manually building the |project|
from source code. Today nGraph supports various developers working on all
......@@ -161,17 +161,17 @@ The process documented here will work on CentOS 7.4.
$ make && sudo make install
.. .. _ngraph_plaidml_backend: hide this until announcement is official
.. _ngraph_plaidml_backend:
.. Building nGraph-PlaidML from source
.. ===================================
Building nGraph-PlaidML from source
===================================
.. The following instructions will create the ``~/ngraph_plaidml_dist``
.. locally:
The following instructions will create the ``~/ngraph_plaidml_dist``
locally:
.. #. Ensure you have installed the :ref:`prerequisites` for your OS.
#. Ensure you have installed the :ref:`prerequisites` for your OS.
.. #. Install the prerequisites for the backend. Our hybrid ``NGRAPH_PLAIDML``
#. Install the prerequisites for the backend. Our hybrid ``NGRAPH_PLAIDML``
backend works best with Python3 versions. We recommend that you use a
virtual environment, due to some of the difficulties that users have
seen when trying to install outside of a venv.
......@@ -182,20 +182,20 @@ The process documented here will work on CentOS 7.4.
$ pip install plaidml
$ plaidml-setup
.. #. Clone the source code, create and enter your build directory:
#. Clone the source code, create and enter your build directory:
.. code-block:: console
$ git clone https://github.com/NervanaSystems/ngraph.git
$ cd ngraph && mkdir build && cd build
.. #. Prepare the CMake files as follows:
#. Prepare the CMake files as follows:
.. code-block:: console
$ cmake .. -DCMAKE_INSTALL_PREFIX=~/ngraph_plaidml_dist -DNGRAPH_CPU_ENABLE=OFF -DNGRAPH_PLAIDML_ENABLE=ON
.. #. Run :command:`make` and ``make install``. Note that if you are building
#. Run :command:`make` and ``make install``. Note that if you are building
outside a local or user path, you may need to run ``make install`` as the
root user.
......@@ -210,8 +210,8 @@ The process documented here will work on CentOS 7.4.
tests can be run when PlaidML devices are available at the machine
level.
.. For more about working with the PlaidML backend from nGraph, see our
.. API documentation :doc:`backends/plaidml-ng-api/index`.
For more about working with the PlaidML backend from nGraph, see our
API documentation :doc:`backends/plaidml-ng-api/index`.
macOS\* development
......
......@@ -69,7 +69,7 @@ See also nGraph's :doc:`../python_api/index`.
PlaidML
=======
See :ref:`ngraph_plaidml_backend` section on how to build the
See the :ref:`ngraph_plaidml_backend` section on how to build the
nGraph-PlaidML.
......
.. project/release-notes.rst:
:orphan:
Release Notes
#############
......@@ -15,31 +17,35 @@ We are pleased to announce the release of version |version|-doc.
Core updates for |version|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
--------------------------
+ Better PlaidML support
+ Double-buffering support
+ Constant folding
+ Support for static linking
+ Additional ops
+ Preliminary static linking support
Known issues
~~~~~~~~~~~~
.. Latest doc updates
.. ~~~~~~~~~~~~~~~~~~
• No training support
• 5 functional TensorFlow models and 4 functional ONNX models may experience performance degradations if upgraded from a previous version.
.. + Add instructions how to build ``NGRAPH_PLAIDML`` backend.
Latest doc updates |version|-doc
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. important:: Pre-releases (``-rc-0.*``) have newer features, and are less stable.
+ Instructions how to build ``NGRAPH_PLAIDML`` backend added to :doc:`../buildlb`.
+ Publishing interim version of doc navigation for updates at ngraph.ai
Changelog on Previous Releases
==============================
0.25
----
.. important:: Pre-releases (``-rc-0.*``) have newer features, and are less stable.
+ Better PlaidML support
+ Double-buffering support
+ Constant folding
+ Support for static linking
+ Additional ops
Changelog on Previous Releases
==============================
0.24
----
......@@ -51,7 +57,6 @@ Changelog on Previous Releases
+ Graph visualization improvements
+ Preserve control dependencies in more places
+ GetOutputElement has single input
.. + Add instructions how to build ``NGRAPH_PLAIDML`` backend.
0.23
......@@ -96,7 +101,7 @@ Changelog on Previous Releases
+ offset arg for tensor creation is deprecated
+ static linking support
+ Initial test of 0.21-doc
+ Updated :doc:`doc-contributor-README` for new community-based contributions.
+ Updated ``doc-contributor-README`` for new community-based contributions.
+ Added instructions on how to test or display the installed nGraph version.
+ Added instructions on building nGraph bridge (ngraph-bridge).
+ Updated Backend Developer Guides and ToC structure.
......
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