Installation
============

Let's get started using TFUtils to train deep learning models!

Requirements
~~~~~~~~~~~~

.. csv-table::
   :header: "Ubuntu", "OSX", "Description"
   :widths: 20, 20, 40
   :escape: ~

   python-pip, pip, Tool to install python dependencies
   python-virtualenv (*), virtualenv (*), Allows creation of isolated environments ((*): This is required only for Python 2.7 installs. With Python3: test for presence of ``venv`` with ``python3 -m venv -h``)
   pymongo, pymongo, Python interface to MongoDB.

Installation
~~~~~~~~~~~~

We recommend installing tfutils within a `virtual
environment <http://docs.python-guide.org/en/latest/dev/virtualenvs/>`__
to ensure a self-contained environment. To install tfutils within an
already existing virtual environment, see the System-wide Install section.

.. code-block:: bash

    git clone https://github.com/neuroailab/tfutils.git
    cd tfutils;
    python setup.py install

Or, if you would prefer to install using pip:

.. code-block:: bash

    pip install git+https://github.com/neuroailab/tfutils.git

To activate the virtual environment, type

.. code-block:: bash

    . .venv/bin/activate

You will see the prompt change to reflect the activated environment. When you are finished, remember to deactivate the environment

.. code-block:: bash

    deactivate

Congratulations, you have installed tfutils! Next, we recommend you learn
how to run models using tfutils and walk through the MNIST multilayer
perceptron tutorial.