quickstart.rst 2.27 KB
Newer Older
1
.. frameworks/quickstart.rst
2

3 4 5 6
.. _fw_quickstart:

Quick start
===========
7 8 9 10 11

No matter what your level of experience with :abbr:`Deep Learning (DL)` systems 
may be, nGraph provides a path to start working with the DL stack. Let's begin 
with the easiest and most straightforward options.

12 13
TensorFlow
----------
14 15

The easiest way to get started is to use the latest PyPI `ngraph-tensorflow-bridge`_,
16
which has instructions for Linux\* systems, and tips for users of Mac OS X. 
17

18
You can install TensorFlow and nGraph in a virtual environment; otherwise, the code 
19 20 21 22
will install to a system location.

.. code-block:: console
   
23
   pip install --upgrade pip==19.3.1
24 25 26
   pip install tensorflow
   pip install ngraph-tensorflow-bridge

27
.. note:: You may need to use the latest versions of ``tensorflow`` and the bridge
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
   to get pip installs to work.  See the :doc:`tensorflow_connect` file for more
   detail about working with TensorFlow\*.

That's it! Now you can test the installation by running the following command:

.. code-block:: console

   python -c "import tensorflow as tf; print('TensorFlow version: ',tf.__version__);import ngraph_bridge; print(ngraph_bridge.__version__)"


Output will look something like:

:: 

    TensorFlow version:  [version]
    nGraph bridge version: b'[version]'
    nGraph version used for this build: b'[version-rc-hash]'
    TensorFlow version used for this build: v[version-hash]
    CXX11_ABI flag used for this build: boolean

48 49 50
More detail in the `ngraph_bridge examples`_ directory.

See also the `diagnostic tools`_.
51 52 53


ONNX
54
----
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74

Another easy way to get started working with the :abbr:`DL (Deep Learning)`
stack is to try the examples available via `nGraph ONNX`_.


To prepare your environment to use nGraph and ONNX, install the Python packages
for nGraph, ONNX and NumPy:

::

    $ pip install ngraph-core onnx numpy

Now you can start exploring some of the :doc:`onnx_integ` examples.

See also nGraph's :doc:`../python_api/index`.


.. _ngraph-tensorflow-bridge: https://pypi.org/project/ngraph-tensorflow-bridge
.. _ngraph ONNX: https://github.com/NervanaSystems/ngraph-onnx
.. _ngraph_bridge examples: https://github.com/tensorflow/ngraph-bridge/blob/master/examples/README.md
75
.. _diagnostic tools: https://github.com/tensorflow/ngraph-bridge/blob/master/diagnostics/README.md