Commit 60d39747 authored by L.S. Cook's avatar L.S. Cook Committed by Scott Cyphers

Leona/onnxdoc2 (#1013)

* Make sure that generating pyapi does not throw errors due to directory structureor linenos

* update docs

* one blank line instead of two

* blank line error resolve
parent da24b77c
...@@ -50,14 +50,14 @@ skip ahead to the next section, :ref:`install_ngonnx`. ...@@ -50,14 +50,14 @@ skip ahead to the next section, :ref:`install_ngonnx`.
.. code-block:: console .. code-block:: console
$ apt update $ apt update
$ apt install python3 python3-pip python3-dev $ apt install python3 python3-pip python3-dev python3-venv
$ apt install build-essential cmake curl clang-3.9 git zlib1g zlib1g-dev libtinfo-dev $ apt install build-essential cmake curl clang-3.9 git zlib1g zlib1g-dev libtinfo-dev
$ git clone https://github.com/NervanaSystems/ngraph.git $ git clone https://github.com/NervanaSystems/ngraph.git
$ cd ngraph && mkdir build $ cd ngraph && mkdir build
$ cd build && cmake ../ -DNGRAPH_USE_PREBUILT_LLVM=TRUE $ cd build && cmake ../ -DNGRAPH_USE_PREBUILT_LLVM=TRUE
$ make install $ make install
#. Build the Python package (binary wheel) for ngraph: #. Build the Python package (binary wheel) for ngraph and set up an env for ONNX:
.. code-block:: console .. code-block:: console
...@@ -66,24 +66,23 @@ skip ahead to the next section, :ref:`install_ngonnx`. ...@@ -66,24 +66,23 @@ skip ahead to the next section, :ref:`install_ngonnx`.
$ export PYBIND_HEADERS_PATH=$PWD/pybind11 $ export PYBIND_HEADERS_PATH=$PWD/pybind11
$ export NGRAPH_CPP_BUILD_PATH=$HOME/ngraph_dist $ export NGRAPH_CPP_BUILD_PATH=$HOME/ngraph_dist
$ python3 setup.py bdist_wheel $ python3 setup.py bdist_wheel
$ cd .. python3 -m venv onnx
$ cd onnx/
$ . bin/activate
#. Check for the binary wheel file under ``/ngraph/python/dist/`` and activate a #. Check for the binary wheel file under ``/ngraph/python/dist/`` and install it
Python3 virtual environment to work with ONNX. with pip.
.. code-block:: console .. code-block:: console
$ cd dist/ (onnx)$ pip install -U python/dist/ngraph-0.2.0-cp35-cp35m-linux_x86_64.whl
$ python3 -m venv onnx
$ cd onnx/
$ . bin/activate
(onnx)$ pip install -U ngraph-0.2.0-cp35-cp35m-linux_x86_64.whl
#. Confirm ngraph is properly installed through a Python interpreter: #. Confirm ngraph is properly installed through a Python interpreter:
.. code-block:: console .. code-block:: console
(onnx) $ python3 (onnx)$ python3
.. code-block:: python .. code-block:: python
...@@ -99,6 +98,13 @@ skip ahead to the next section, :ref:`install_ngonnx`. ...@@ -99,6 +98,13 @@ skip ahead to the next section, :ref:`install_ngonnx`.
Installing ngraph-onnx Installing ngraph-onnx
----------------------- -----------------------
Add the dependencies for ONNX:
.. code-block:: console
$ apt install protobuf-compiler libprotobuf-dev
Install the ``ngraph-onnx`` companion tool using pip: Install the ``ngraph-onnx`` companion tool using pip:
.. code-block:: console .. code-block:: console
......
...@@ -8,9 +8,9 @@ This section contains nGraph™ Python API documentation. Python API exposes ...@@ -8,9 +8,9 @@ This section contains nGraph™ Python API documentation. Python API exposes
nGraph™ C++ operations to Python users. For quick-start you can find an example nGraph™ C++ operations to Python users. For quick-start you can find an example
of the API usage below. of the API usage below.
.. literalinclude:: /../../../python/examples/basic.py .. literalinclude:: ../../../../python/examples/basic.py
:language: python :language: python
:lines: 18-48 :lines: 18-47
======= =======
......
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