aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar Martin Wicke <wicke@google.com>2016-01-14 07:30:07 -0800
committerGravatar Vijay Vasudevan <vrv@google.com>2016-01-14 07:30:07 -0800
commitd45ed5c9387e64be8d35a41bcaa7f752f6f3eba5 (patch)
treedc6f2f75981de8919474ee335af85d56691d8b5a
parent916776a1744d78d65e7c4f52df3bcaa8cf466872 (diff)
Add instructions to set up development without reinstallation (fixes #413)
Change: 112120905
-rw-r--r--tensorflow/g3doc/get_started/os_setup.md35
1 files changed, 29 insertions, 6 deletions
diff --git a/tensorflow/g3doc/get_started/os_setup.md b/tensorflow/g3doc/get_started/os_setup.md
index 4484486ff8..323359f3dc 100644
--- a/tensorflow/g3doc/get_started/os_setup.md
+++ b/tensorflow/g3doc/get_started/os_setup.md
@@ -80,7 +80,7 @@ $ sudo pip3 install --upgrade https://storage.googleapis.com/tensorflow/mac/tens
You can now [test your installation](#test-the-tensorflow-installation).
-## Virtualenv installation
+## Virtualenv installation
[Virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/) is a tool
to keep the dependencies required by different Python projects in separate
@@ -170,7 +170,7 @@ $ source ~/tensorflow/bin/activate.csh # If using csh.
(tensorflow)$ deactivate
```
-## Docker installation
+## Docker installation
[Docker](http://docker.com/) is a system to build self contained versions of a
Linux operating system running on your machine. When you install and run
@@ -290,7 +290,7 @@ $ python /usr/local/lib/python2.7/dist-packages/tensorflow/models/image/mnist/co
...
```
-## Installing from sources
+## Installing from sources
When installing from source you will build a pip wheel that you then install
using pip. You'll need pip for that, so install it as described
@@ -491,7 +491,7 @@ best install that too:
$ sudo easy_install ipython
```
-#### Configure the installation
+#### Configure the installation
Run the `configure` script at the root of the tree. The configure script
asks you for the path to your python interpreter.
@@ -504,7 +504,7 @@ Please specify the location of python. [Default is /usr/bin/python]:
Do you wish to build TensorFlow with GPU support? [y/N]
```
-### Create the pip package and install
+### Create the pip package and install
```bash
$ bazel build -c opt //tensorflow/tools/pip_package:build_pip_package
@@ -546,7 +546,30 @@ Validation error: 7.0%
...
```
-## Common Problems
+## Setting up TensorFlow for Development
+
+If you're working on TensorFlow itself, it is useful to be able to test your
+changes in an interactive python shell without having to reinstall TensorFlow.
+
+To set up TensorFlow such that all files are linked (instead of copied) from the
+system directories, run the following commands inside the TensorFlow root
+directory:
+
+```bash
+bazel build -c opt //tensorflow/tools/pip_package:build_pip_package
+mkdir _python_build
+cd _python_build
+ln -s ../bazel-bin/tensorflow/tools/pip_package/build_pip_package.runfiles/* .
+ln -s ../tensorflow/tools/pip_package/* .
+python setup.py develop
+```
+
+Note that this setup still requires you to rebuild the
+`//tensorflow/tools/pip_package:build_pip_package` target every time you change
+a C++ file; add, delete, or move any python file; or if you change bazel build
+rules.
+
+## Common Problems
### GPU-related issues