Merge pull request #200 from Bihaqo/troubleshooting_docs

Troubleshooting docs
Bihaqo · Dec 9, 2019 · 0361b80 · 0361b80
2 parents a7c25c1 + fc987e8
commit 0361b80
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 3 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -19,6 +19,7 @@ t3f is implemented on top of TensorFlow which gives it a few nice properties:
     api
     comparison
     benchmark
+    troubleshooting
 
 .. toctree::
     :maxdepth: 1

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -22,6 +22,3 @@ To install the latest version, run
    git clone https://github.com/Bihaqo/t3f.git
    cd t3f
    pip install .
-
-Note that using the neural module (`t3f.nn`) may require additional dependencies
-such as Keras.
diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst
@@ -0,0 +1,22 @@
+.. _TroubleshootingInstructions:
+
+Troubleshooting
+===============
+
+If something does not work, try
+
+* Installing the latest version of the library (see :ref:`InstallationInstructions`)
+
+* Importing TensorFlow in the following way:
+
+.. code-block:: python
+
+  import tensorflow.compat.v1 as tf
+  tf.disable_v2_behavior()
+  tf.enable_resource_variables()
+  tf.enable_eager_execution()
+
+
+* Creating an issue_ on GitHub
+
+.. _issue: https://github.com/Bihaqo/t3f/issues/new