Commit 4d161477 authored by L.S. Cook's avatar L.S. Cook Committed by Scott Cyphers

cleanup neon integration documentation (#691)

* Implement PR review changes

* cleanup neon integration documentation
parent bb831262
...@@ -89,3 +89,12 @@ doc/doxygen/man/* ...@@ -89,3 +89,12 @@ doc/doxygen/man/*
doc/doxygen/latex/* doc/doxygen/latex/*
doc/doxygen/xml/* doc/doxygen/xml/*
doc/doxygen/html/* doc/doxygen/html/*
# python venv things that might get added accidentally
../
python-wheels/
.whl
*.whl
.venv
...@@ -40,61 +40,39 @@ system that already has an ``ngraph_dist`` installed. ...@@ -40,61 +40,39 @@ system that already has an ``ngraph_dist`` installed.
export LD_LIBRARY_PATH=$HOME/ngraph_dist/lib/ export LD_LIBRARY_PATH=$HOME/ngraph_dist/lib/
#. neon uses the :command:`pip` package manager during installation; install it #. The neon framework uses the :command:`pip` package manager during installation;
with Python version 3.5 or higher: install it with Python version 3.5 or higher:
.. code-block:: console .. code-block:: console
$ sudo apt-get install python3-pip python3-venv $ sudo apt-get install python3-pip python3-venv
$ python3 -m venv frameworks
$ cd frameworks
$ . bin/activate
(frameworks) ~/frameworks$
#. Go to the "python" subdirectory of the ``ngraph`` repo we cloned during the
#. Clone the ngraph-neon integration repo somewhere you can find it easily. The previous :doc:`install`, and complete these actions:
install configuration we'll document here places it under a directory we'll
create named ``frameworks``
* This section is optional, but it is the configuration we'll assume for the
``ngraph-neon`` documenation:
.. code-block:: console
$ sudo mkdir -p /opt/frameworks
$ sudo chown -R username:username /opt/frameworks
$ cd /opt/frameworks
* This section is required:
.. code-block:: console
$ git clone git@github.com:NervanaSystems/ngraph-neon
$ cd ngraph-neon
#. *Optional* Activate a virtualenv if you prefer working with virtualenvs:
.. code-block:: console .. code-block:: console
$ python3 -m venv . (frameworks)$ cd /opt/libraries/ngraph/python
$ . bin/activate (frameworks)$ git clone --recursive -b allow-nonconstructible-holders https://github.com/jagerman/pybind11.git
(frameworks)$ pip install -U .
#. Clone the ngraph-neon repo and install the neon dependencies via ``pip`` #. Finally we're ready to install the `neon` integration:
if you are using a ``.venv`` and pip3 otherwise:
* For neon via virtual env:
.. code-block:: console .. code-block:: console
(.venv)$ pip install -U . (frameworks)$ git clone git@github.com:NervanaSystems/ngraph-neon
Running setup.py install for neon ... done (frameworks)$ cd ngraph-neon
Successfully installed neon-3.0 (frameworks)$ make install
* For a system install of neon-ngraph: #. To test a training example, you can run the following from ``ngraph-neon/examples/cifar10``
.. code-block:: console .. code-block:: console
$ pip3 install -U . (frameworks)$ python cifar10_conv.py
Running setup.py install for neon ... done
Successfully installed neon-3.0
......
...@@ -25,6 +25,7 @@ parts/ ...@@ -25,6 +25,7 @@ parts/
sdist/ sdist/
var/ var/
wheels/ wheels/
python-wheels/
*.egg-info/ *.egg-info/
.installed.cfg .installed.cfg
*.egg *.egg
......
lib
\ No newline at end of file
{"last_check":"2018-03-18T15:26:14Z","pypi_version":"9.0.2"}
\ No newline at end of file
home = /usr/bin
include-system-site-packages = false
version = 3.5.2
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