Add release notes and improve rendering of changes.md (#2117)

Author: indie

README.md

@@ -103,7 +103,7 @@ to improve it:
 [Pip package]: https://github.com/NervanaSystems/ngraph-onnx#installing-ngraph-onnx
 [Build from source]: https://github.com/NervanaSystems/ngraph-tf
 [Enable the module]: https://github.com/NervanaSystems/ngraph/blob/mbrookhart/mxnet_tutorial/doc/sphinx/source/shared/mxnet_tutorial.rst
-[Source compile]: https://github.com/NervanaSystems/ngraph-mxnet/blob/master/NGRAPH_README.md
+[Source compile]: https://github.com/NervanaSystems/ngraph-mxnet/blob/master/README.md
 [nGraph-ONNX]: https://github.com/NervanaSystems/ngraph-onnx/blob/master/README.md
 [nGraph-ONNX adaptable]: https://ai.intel.com/adaptable-deep-learning-solutions-with-ngraph-compiler-and-onnx/
 [nGraph for PyTorch developers]: https://ai.intel.com/investing-in-the-pytorch-developer-community

contrib/docker/Dockerfile.ngraph

@@ -38,4 +38,7 @@ RUN pip install breathe
 # need numpy to successfully build docs for python_api
 RUN pip install numpy
 
+# release notes need this markdown extension 
+# RUN python3 -m pip install m2r
+
 WORKDIR /home

contrib/docker/Dockerfile.ngraph.centos74

@@ -46,6 +46,7 @@ RUN c++ --version
 RUN easy_install pip
 RUN pip install virtualenv
 
+
 # Install some pip packages
 
 # need to use sphinx version 1.6 to build docs
@@ -61,4 +62,8 @@ RUN pip install breathe
 # need numpy to successfully build docs for python_api
 RUN pip install numpy
 
+# release notes need this markdown extension 
+# RUN python3 -m pip install m2r
+
+
 WORKDIR /home

contrib/docker/Dockerfile.ngraph.centos74_gpu

@@ -43,4 +43,6 @@ RUN pip install breathe
 # need numpy to successfully build docs for python_api
 RUN pip install numpy
 
+# RUN python3 -m pip install m2r
+
 WORKDIR /home

contrib/docker/Dockerfile.ngraph.ubuntu1604

@@ -41,4 +41,7 @@ RUN pip install breathe
 # need numpy to successfully build docs for python_api
 RUN pip install numpy
 
+# release notes need this markdown extension 
+# RUN python3 -m pip install m2r
+
 WORKDIR /home

contrib/docker/Dockerfile.ngraph.ubuntu1604_gpu

@@ -58,4 +58,6 @@ RUN pip install breathe
 # need numpy to successfully build docs for python_api
 RUN pip install numpy
 
+# RUN python3 -m pip install m2r
+
 WORKDIR /home

doc/sphinx/source/conf.py

@@ -1,3 +1,5 @@
+
+
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 #
@@ -42,6 +44,10 @@
     'breathe',
     ]
 
+
+# source_suffix = '.rst'
+source_suffix = ['.rst', '.md']
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 static_path = ['static']
@@ -60,8 +66,7 @@
 copyright = '2018, Intel Corporation'
 author = 'Intel Corporation'
 
-# License specifics
-# TBD
+# License specifics see LICENSE of component
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

doc/sphinx/source/framework-integration-guides.rst

@@ -46,7 +46,7 @@ nGraph-TensorFlow bridge.
 
 
 
-.. _nGraph-MXNet: https://github.com/NervanaSystems/ngraph-mxnet/blob/master/NGRAPH_README.md
+.. _nGraph-MXNet: https://github.com/NervanaSystems/ngraph-mxnet/blob/master/README.md
 .. _MXNet: http://mxnet.incubator.apache.org
 .. _DSO: http://csweb.cs.wfu.edu/%7Etorgerse/Kokua/More_SGI/007-2360-010/sgi_html/ch03.html
 .. _being the fastest: https://github.com/soumith/convnet-benchmarks

doc/sphinx/source/index.rst

@@ -21,6 +21,9 @@
 Welcome
 =======
 
+See the latest :doc:`project/release-notes`. 
+
+
 .. figure:: graphics/599px-Intel-ngraph-ecosystem.png
    :width: 599px
 
@@ -127,4 +130,4 @@ Indices and tables
 .. _Movidius: https://www.movidius.com/
 .. _contributions: https://github.com/NervanaSystems/ngraph#how-to-contribute
 .. _TensorFlow bridge to nGraph: https://github.com/NervanaSystems/ngraph-tf/blob/master/README.md
-.. _Compiling MXNet with nGraph: https://github.com/NervanaSystems/ngraph-mxnet/blob/master/NGRAPH_README.md
+.. _Compiling MXNet with nGraph: https://github.com/NervanaSystems/ngraph-mxnet/blob/master/README.md

doc/sphinx/source/project/release-notes.rst

@@ -3,12 +3,37 @@
 Release Notes
 #############
 
-This is release |release|.
+|release|
 
 
+This release focuses on accelerating deep learning inference workloads on 
+Intel® Xeon® (CPU processor) and has the following key features: 
 
-API Changes
-===========
+* Out-of-box installation experience for TensorFlow*, MXNet*, and ONNX.
+* Validated optimizations for 17 workloads each on both TensorFlow and MXNet, 
+  as well as 14 for ONNX.
+* Support for Ubuntu 16.04 (TensorFlow, MXNet and ONNX).
+* Support for OSX 10.13.x (buildable for TensorFlow and MXNet).
 
-.. literalinclude:: ../../../../changes.md
+This |version| release includes optimizations built for popular workloads 
+already widely deployed in production environments. These workloads cover 
+the following categories:
 
+* ``image recognition & segmentation`` 
+* ``object detection`` 
+* ``language translation`` 
+* ``speech generation & recognition``
+* ``recommender systems`` 
+* ``Generative Adversarial Networks (GAN)``
+* ``reinforcement learning`` 
+
+In our tests, the optimized workloads can perform up to 45X faster than native 
+frameworks, and we expect performance gains for other workloads due to our 
+powerful :doc:`../fusion/index` feature.
+
+
+See also our recent `API changes`_
+
+
+
+.. _API changes: https://github.com/NervanaSystems/ngraph/blob/master/changes.md