Full Code of astorfi/TensorFlow-Roadmap for AI

Repository: astorfi/TensorFlow-Roadmap
Branch: master
Commit: 65336ad14e24
Files: 27
Total size: 102.8 KB

Directory structure:
gitextract_3nq1pc4u/

├── .gitattributes
├── .gitignore
├── .travis.yml
├── CODE_OF_CONDUCT.rst
├── CONTRIBUTING.rst
├── LICENSE
├── README.rst
├── conf.py
├── docs/
│   ├── Makefile
│   ├── make.bat
│   └── source/
│       ├── _ext/
│       │   └── djangodocs.py
│       ├── conf.py
│       ├── content/
│       │   ├── books.rst
│       │   ├── howtocode.rst
│       │   ├── projects.rst
│       │   ├── tutorials.rst
│       │   └── warmup.rst
│       ├── credentials/
│       │   ├── CODE_OF_CONDUCT.rst
│       │   ├── CONTRIBUTING.rst
│       │   └── LICENSE.rst
│       ├── index.rst
│       ├── intro/
│       │   └── intro.rst
│       └── saved/
│           ├── conf (another copy).py
│           ├── conf (copy).py
│           ├── conf-2.py
│           └── conf.py
└── requirements.txt

================================================
FILE CONTENTS
================================================

================================================
FILE: .gitattributes
================================================

docs/* linguist-documentation
_img/* linguist-vendored



================================================
FILE: .gitignore
================================================
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# Numerous always-ignore extensions
*.pyc
*.diff
*.err
*.orig
*.log
*.rej
*.swo
*.swp
*.vi
*.cache
*.egg-info
*~
*#

# C extensions
*.so

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg

# PyInstaller
#  Usually these files are written by a python script from a template
#  before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
.hypothesis/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/
docs/_static/
docs/_templates/


# PyBuilder
target/

# IPython Notebook
.ipynb_checkpoints

# pyenv
.python-version

# celery beat schedule file
celerybeat-schedule

# dotenv
.env

# virtualenv
venv/
ENV/

# Spyder project settings
.spyderproject

# Rope project settings
.ropeproject




================================================
FILE: .travis.yml
================================================
language: python
python:
  - "2.7"
  - "3.4"
  - "3.5"
  - "3.6"

# command to install dependencies
install:
  - pip install -r requirements.txt
  - pip install coveralls flake8

before_script:
  # stop the build if there are Python syntax errors or undefined names
  - flake8 . --count --select=E901,E999,F821,F822,F823 --show-source --statistics
  # exit-zero treats all errors as warnings.  The GitHub editor is 127 chars wide
  - flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics

script:
  - coverage run --omit=*.virtualenvs*,*virtualenv* docs/source/conf.py test


after_success:
  coveralls

sudo: enabled
dist: trusty


================================================
FILE: CODE_OF_CONDUCT.rst
================================================
Contributor Covenant Code of Conduct
====================================

Our Pledge
----------

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards
-------------

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities
--------------------

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope
-----

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement
-----------

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at amirsina.torfi@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Attribution
------------

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/


================================================
FILE: CONTRIBUTING.rst
================================================

*************
Contributing
*************

*For typos, please do not create a pull request. Instead, declare them in issues or email the repository owner*. Please note we have a code of conduct, please follow it in all your interactions with the project.

====================
Pull Request Process
====================

Please consider the following criterions in order to help us in a better way:

1. The pull request is mainly expected to be a link suggestion.
2. Please make sure your suggested resources are not obsolete or broken.
3. Ensure any install or build dependencies are removed before the end of the layer when doing a
   build and creating a pull request.
4. Add comments with details of changes to the interface, this includes new environment
   variables, exposed ports, useful file locations and container parameters.
5. You may merge the Pull Request in once you have the sign-off of at least one other developer, or if you
   do not have permission to do that, you may request the owner to merge it for you if you believe all checks are passed.

============
Final Note
============

We are looking forward to your kind feedback. Please help us to improve this open source project and make our work better.
For contribution, please create a pull request and we will investigate it promptly. Once again, we appreciate
your kind feedback and elaborate code inspections.


================================================
FILE: LICENSE
================================================
LICENSE
========

MIT License

Copyright (c) 2017 Amirsina Torfi

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


================================================
FILE: README.rst
================================================
.. figure:: _img/mainpage/subscribe.gif
  :target: https://machinelearningmindset.com/subscription/

********************************************
TensorFlow-World-Resources - `Project Page`_
********************************************
.. _Project Page: http://tensorflow-world-resources.readthedocs.io/en/latest/

.. .. image:: https://travis-ci.org/astorfi/TensorFlow-World-Resources.svg?branch=master
..     :target: https://travis-ci.org/astorfi/TensorFlow-World-Resources
.. image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
    :target: https://github.com/astorfi/TensorFlow-World-Resources/pulls
.. image:: https://badges.frapsoft.com/os/v2/open-source.svg?v=102
    :target: https://github.com/ellerbrock/open-source-badge/
.. image:: https://coveralls.io/repos/github/astorfi/TensorFlow-World-Resources/badge.svg?branch=master
    :target: https://coveralls.io/github/astorfi/TensorFlow-World-Resources?branch=master
.. image:: https://img.shields.io/twitter/follow/amirsinatorfi.svg?label=Follow&style=social
      :target: https://twitter.com/amirsinatorfi

.. image:: _img/mainpage/TensorFlow_World.gif

#################
Table of Contents
#################
.. contents::
  :local:
  :depth: 3

============
Introduction
============

The purpose of this project is to introduce a shortcut to developers and researcher
for finding useful resources about TensorFlow.



-----------
Motivation
-----------

There are different motivations for this open source project.

~~~~~~~~~~~~~~~~~~~~~
Why using TensorFlow?
~~~~~~~~~~~~~~~~~~~~~

A deep learning is of great interest these days, the crucial necessity for rapid and optimized implementation of the algorithms
and designing architectures is the software environment. TensorFlow is designed to facilitate this goal. The strong advantage of
TensorFlow is it flexibility is designing highly modular model which also can be a disadvantage too for beginners since lots of
the pieces must be considered together for creating the model. This issue has been facilitated as well by developing high-level APIs
such as `Keras <https://keras.io/>`_ and `Slim <https://github.com/tensorflow/models/blob/master/inception/inception/slim/README.md//>`_
which gather lots of the design puzzle pieces. The interesting point about TensorFlow is that **its trace can be found anywhere these days**.
Lots of the researchers and developers are using it and *its community is growing with the speed of light*! So the possible issues can
be overcame easily since they might be the issues of lots of other people considering a large number of people involved in TensorFlow community.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
What's the point of this open source project?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

There other similar repositories similar to this repository and are very
comprehensive and useful and to be honest they made me ponder if there is
a necessity for this repository! A great example is `awesome-tensorflow <https://github.com/jtoy/awesome-tensorflow>`_
repository which is a curated list of different TensorFlow resources.

**The point of this repository is that the resources are being targeted**. The organization
of the resources is such that the user can easily find the things he/she is looking for.
We divided the resources to a large number of categories that in the beginning one may
have a headache!!! However, if someone knows what is being located, it is very easy to find the most related resources.
Even if someone doesn't know what to look for, in the beginning, the general resources have
been provided.


------------------------------------
How to make the most of this effort
------------------------------------

The written and visual resources have been split. Moreover, As one can search
in the documentation, the number of categories might look to be too much. For
finding the most relevant resources, please at first look through the general resources.

============================
Entrance to TensorFlow World
============================

In this section, different TensorFlow topics and their associated
resources will be addressed.

-------------
Installation
-------------

.. image:: _img/mainpage/installation.gif

First of all, the TensorFlow must be installed!


* `Installing TensorFlow`_: Official TensorFLow installation
* `Install TensorFlow from the source`_: A comprehensive guide on how to install TensorFlow from the source using python/anaconda
* `TensorFlow Installation`_: A short TensorFlow installation guide powered by NVIDIA
* `7 SIMPLE STEPS TO INSTALL TENSORFLOW ON WINDOWS`_: A concise tutorial for installing TensorFlow on Windows

.. _Installing TensorFlow: https://www.tensorflow.org/install/
.. _Install TensorFlow from the source: https://github.com/astorfi/TensorFlow-World/tree/master/docs/tutorials/installation
.. _TensorFlow Installation: http://www.nvidia.com/object/gpu-accelerated-applications-tensorflow-installation.html
.. _7 SIMPLE STEPS TO INSTALL TENSORFLOW ON WINDOWS: http://saintlad.com/install-tensorflow-on-windows/


* `Install TensorFlow on Ubuntu`_: A comprehensive tutorial on how to install TensorFlow on Ubuntu
* `Installation of TensorFlow`_: The video covers how to setup TensorFlow
* `Installing CPU and GPU TensorFlow on Windows`_: A tutorial on TensorFlow installation for Windows
* `Installing the GPU version of TensorFlow for making use of your CUDA GPU`_: A GPU-targeted TensoFlow installation


.. _Install TensorFlow on Ubuntu: https://www.youtube.com/watch?v=_3JFEPk4qQY&t=3s
.. _Installation of TensorFlow: https://www.youtube.com/watch?v=CvspEt8kSIg
.. _Installing CPU and GPU TensorFlow on Windows: https://www.youtube.com/watch?v=r7-WPbx8VuY
.. _Installing the GPU version of TensorFlow for making use of your CUDA GPU: https://www.youtube.com/watch?v=io6Ajf5XkaM

---------------
Getting Started
---------------

.. image:: _img/mainpage/gettingstarted.gif

This part points to resources on how to start to code with TensorFLow


* `Getting Started With TensorFlow Framework`_: This guide gets you started programming in TensorFlow
* `learning TensorFlow Deep Learning`_:A great resource to start
* `Welcome to TensorFlow World`_: A simple and concise start to TensorFLow

.. _learning TensorFlow Deep Learning: http://learningtensorflow.com/getting_started/
.. _Getting Started With TensorFlow Framework: https://www.tensorflow.org/get_started/get_started
.. _Welcome to TensorFlow World: https://github.com/astorfi/TensorFlow-World/tree/master/docs/tutorials/0-welcome


* `Gentlest Introduction to Tensorflow  <https://www.youtube.com/watch?v=dYhrCUFN0eM>`_
* `TensorFlow in 5 Minutes  <https://www.youtube.com/watch?v=2FmcHiLCwTU/>`_
* `Deep Learning with TensorFlow - Introduction to TensorFlow  <https://www.youtube.com/watch?v=MotG3XI2qSs>`_
* `TensorFlow Tutorial (Sherry Moore, Google Brain)  <https://www.youtube.com/watch?v=Ejec3ID_h0w>`_
* `Deep Learning with Neural Networks and TensorFlow Introduction  <https://www.youtube.com/watch?v=oYbVFhK_olY>`_
* `A fast with TensorFlow <https:/www.youtube.com/watch?v=Q-FF_0NAT3s>`_

--------------------------
Going Deeper in TensorFLow
--------------------------

.. image:: _img/mainpage/goingdeep.gif

Advanced machine learning users can go deeper in TensorFlow in order to
*hit the root*. Scratching the surface may never take us too further!


* `TensorFlow Mechanics`_: More experienced machine learning users can dig more in TensorFlow
* `Advanced TensorFlow`_: Advanced Tutorials in TensorFlow
* `We Need to Go Deeper`_: A Practical Guide to Tensorflow and Inception
* `Wide and Deep Learning - Better Together with TensorFlow`_: A tutorial by Google Research Blog

.. _TensorFlow Mechanics: https://www.tensorflow.org/get_started/mnist/mechanics
.. _Advanced TensorFlow: https://github.com/sjchoi86/advanced-tensorflow
.. _We Need to Go Deeper: https://medium.com/initialized-capital/we-need-to-go-deeper-a-practical-guide-to-tensorflow-and-inception-50e66281804f
.. _Wide and Deep Learning - Better Together with TensorFlow: https://research.googleblog.com/2016/06/wide-deep-learning-better-together-with.html


* `TensorFlow DeepDive`_: More experienced machine learning users can dig more in TensorFlow
* `Go Deeper - Transfer Learning`_: TensorFlow and Deep Learning
* `Distributed TensorFlow - Design Patterns and Best Practices`_: A talk that was given at the Advanced Spark and TensorFlow Meetup
* `Distributed TensorFlow Guide`_
* `Fundamentals of TensorFlow`_
* `TensorFlow Wide and Deep - Advanced Classification the easy way`_
* `Tensorflow and deep learning - without a PhD`_: A great tutorial on TensoFLow workflow



.. _TensorFlow DeepDive: https://www.youtube.com/watch?v=T0H6zF3K1mc
.. _Go Deeper - Transfer Learning: https://www.youtube.com/watch?v=iu3MOQ-Z3b4
.. _Distributed TensorFlow - Design Patterns and Best Practices: https://www.youtube.com/watch?v=YAkdydqUE2c
.. _Distributed TensorFlow Guide: https://github.com/tmulc18/Distributed-TensorFlow-Guide
.. _Fundamentals of TensorFlow: https://www.youtube.com/watch?v=EM6SU8QVSlY
.. _TensorFlow Wide and Deep - Advanced Classification the easy way: https://www.youtube.com/watch?v=WKgNNC0VLhM
.. _Tensorflow and deep learning - without a PhD: https://www.youtube.com/watch?v=vq2nnJ4g6N0


============================
Programming with TensorFlow
============================

The references here, deal with the details of programming and writing TensorFlow code.

--------------------------------
Reading data and input pipeline
--------------------------------

.. image:: _img/mainpage/readingdata.gif

The first part is always how to prepare data and how to provide the pipeline to feed it to TensorFlow.
Usually providing the input pipeline can be complicated, even more than the structure design!

* `Dataset API for TensorFlow Input Pipelines`_: A TensorFlow official documentation on *Using the Dataset API for TensorFlow Input Pipelines*
* `TesnowFlow input pipeline`_: Input pipeline provided by Stanford.
* `TensorFlow input pipeline example`_: A working example.
* `TensorFlow Data Input`_: TensorFlow Data Input: Placeholders, Protobufs & Queues
* `Reading data`_: The official documentation by the TensorFLow on how to read data
* `basics of reading a CSV file`_: A tutorial on reading a CSV file
* `Custom Data Readers`_: Official documentation on this how to define a reader.

.. _Dataset API for TensorFlow Input Pipelines: https://github.com/tensorflow/tensorflow/tree/v1.2.0-rc1/tensorflow/contrib/data
.. _TesnowFlow input pipeline: http://web.stanford.edu/class/cs20si/lectures/slides_09.pdf
.. _TensorFlow input pipeline example: http://ischlag.github.io/2016/06/19/tensorflow-input-pipeline-example/
.. _TensorFlow Data Input: https://indico.io/blog/tensorflow-data-inputs-part1-placeholders-protobufs-queues/
.. _Reading data: https://www.tensorflow.org/programmers_guide/reading_data
.. _basics of reading a CSV file: http://learningtensorflow.com/ReadingFilesBasic/
.. _Custom Data Readers: https://www.tensorflow.org/extend/new_data_formats

* `Tensorflow tutorial on TFRecords`_: A tutorial on how to transform data into TFRecords

.. _Tensorflow tutorial on TFRecords: https://www.youtube.com/watch?v=F503abjanHA

* `An introduction to TensorFlow queuing and threading`_: A tutorial on how to understand and create queues an efficient pipelines

.. _An introduction to TensorFlow queuing and threading: http://adventuresinmachinelearning.com/introduction-tensorflow-queuing/

----------
Variables
----------

.. image:: _img/mainpage/variables.gif

Variables are supposed to hold the parameters and supersede by new values as the parameters are updated.
Variables must be clearly set and initialized.


~~~~~~~~~~~~~~~~~~~~~~~~
Creation, Initialization
~~~~~~~~~~~~~~~~~~~~~~~~

* `Variables Creation and Initialization`_: An official documentation on setting up variables
* `Introduction to TensorFlow Variables - Creation and Initialization`_: This tutorial deals with defining and initializing TensorFlow variables
* `Variables`_: An introduction to variables

.. _Variables Creation and Initialization: https://www.tensorflow.org/programmers_guide/variables
.. _Introduction to TensorFlow Variables - Creation and Initialization: http://machinelearninguru.com/deep_learning/tensorflow/basics/variables/variables.html
.. _Variables: http://learningtensorflow.com/lesson2/

~~~~~~~~~~~~~~~~~~~~~~
Saving and restoring
~~~~~~~~~~~~~~~~~~~~~~

* `Saving and Loading Variables`_: The official documentation on saving and restoring variables
* `save and restore Tensorflow models`_: A quick tutorial to save and restore Tensorflow models

.. _Saving and Loading Variables: https://www.tensorflow.org/programmers_guide/variables
.. _save and restore Tensorflow models: http://cv-tricks.com/tensorflow-tutorial/save-restore-tensorflow-models-quick-complete-tutorial/

~~~~~~~~~~~~~~~~~
Sharing Variables
~~~~~~~~~~~~~~~~~

* `Sharing Variables`_: The official documentation on how to share variables

.. _Sharing Variables: https://www.tensorflow.org/programmers_guide/variable_scope

* `Deep Learning with Tensorflow - Tensors and Variables`_: A Tensorflow tutorial for introducing Tensors, Variables and Placeholders
* `Tensorflow Variables`_: A quick introduction to TensorFlow variables
* `Save and Restore in TensorFlow`_: TensorFlow Tutorial on Save and Restore variables

.. _Deep Learning with Tensorflow - Tensors and Variables: https://www.youtube.com/watch?v=zgV-WzLyrYE
.. _Tensorflow Variables: https://www.youtube.com/watch?v=UYyqNH3r4lk
.. _Save and Restore in TensorFlow: https://www.tensorflow.org/programmers_guide/variable_scope

--------------------
TensorFlow Utilities
--------------------

.. image:: _img/mainpage/utility.png

.. .. figure:: _img/mainpage/utility.png
..    :scale: 20 %
..    :alt: map to buried treasure
..
.. .. raw:: html
..
..     <p style="height:22px">
..       <a href="https://github.com/astorfi/TensorFlow-World-Resources/blob/master/_img/mainpage/utility.png" >
..         <img src="https://github.com/astorfi/TensorFlow-World-Resources/blob/master/_img/mainpage/utility.png"/>
..       </a>
..     </p>

Different utilities empower TensorFlow for faster computation in a more monitored manner.


~~~~~~~~~~
Supervisor
~~~~~~~~~~

* `Supervisor - Training Helper for Days-Long Trainings`_: The official documentation for TensorFLow Supervisor.
* `Using TensorFlow Supervisor with TensorBoard summary groups`_: Using both TensorBoard and the Supervisor for profit
* `Tensorflow example`_: A TensorFlow example using Supervisor.


.. _Supervisor - Training Helper for Days-Long Trainings: https://www.tensorflow.org/programmers_guide/supervisor
.. _Using TensorFlow Supervisor with TensorBoard summary groups: https://dev.widemeadows.de/2017/01/21/using-tensorflows-supervisor-with-tensorboard-summary-groups/
.. _Tensorflow example: http://codata.colorado.edu/notebooks/tutorials/tensorflow_example_davis_yoshida/

~~~~~~~~~~~~~~~~~~~
TensorFlow Debugger
~~~~~~~~~~~~~~~~~~~

* `TensorFlow Debugger (tfdbg) Command-Line-Interface Tutorial`_: Official documentation for using debugger for MNIST
* `How to Use TensorFlow Debugger with tf.contrib.learn`_: A more high-level method to use the debugger.
* `Debugging TensorFlow Codes`_: A Practical Guide for Debugging TensorFlow Codes
* `Debug TensorFlow Models with tfdbg`_:  A tutorial by Google Developers Blog


.. _TensorFlow Debugger (tfdbg) Command-Line-Interface Tutorial: https://www.tensorflow.org/programmers_guide/debugger
.. _How to Use TensorFlow Debugger with tf.contrib.learn: https://www.tensorflow.org/programmers_guide/tfdbg-tflearn
.. _Debugging TensorFlow Codes: https://github.com/wookayin/tensorflow-talk-debugging
.. _Debug TensorFlow Models with tfdbg: https://developers.googleblog.com/2017/02/debug-tensorflow-models-with-tfdbg.html

~~~~~~~~~~
MetaGraphs
~~~~~~~~~~

* `Exporting and Importing a MetaGraph`_: Official TensorFlow documentation
* `Model checkpointing using meta-graphs in TensorFlow`_: A working example

.. _Exporting and Importing a MetaGraph: https://www.tensorflow.org/programmers_guide/meta_graph
.. _Model checkpointing using meta-graphs in TensorFlow: http://www.seaandsailor.com/tensorflow-checkpointing.html

~~~~~~~~~~~
Tensorboard
~~~~~~~~~~~

* `TensorBoard - Visualizing Learning`_: Official documentation by TensorFlow.
* `TensorFlow Ops`_: Provided by Stanford
* `Visualisation with TensorBoard`_: A tutorial on how to create and visualize a graph using TensorBoard
* `Tensorboard`_: A brief tutorial on Tensorboard

.. _TensorBoard - Visualizing Learning: https://www.tensorflow.org/get_started/summaries_and_tensorboard
.. _TensorFlow Ops: http://web.stanford.edu/class/cs20si/lectures/notes_02.pdf
.. _Visualisation with TensorBoard: http://learningtensorflow.com/Visualisation/
.. _Tensorboard: http://edwardlib.org/tutorials/tensorboard


* `Hands-on TensorBoard (TensorFlow Dev Summit 2017)`_: An introduction to the amazing things you can do with TensorBoard
* `Tensorboard Explained in 5 Min`_: Providing the code for a simple handwritten character classifier in Python and visualizing it in Tensorboard
* `How to Use Tensorboard`_: Going through a bunch of different features in Tensorboard


.. _Hands-on TensorBoard (TensorFlow Dev Summit 2017): https://www.youtube.com/watch?v=eBbEDRsCmv4
.. _Tensorboard Explained in 5 Min: https://www.youtube.com/watch?v=3bownM3L5zM
.. _How to Use Tensorboard: https://www.youtube.com/watch?v=fBVEXKp4DIc

====================
TensorFlow Tutorials
====================

This section is dedicated to provide tutorial resources on the implementation of
different models with TensorFlow.

------------------------------
Linear and Logistic Regression
------------------------------

.. image:: _img/mainpage/logisticregression.png


* `TensorFlow Linear Model Tutorial`_: Using TF.Learn API in TensorFlow to solve a binary classification problem
* `Linear Regression in Tensorflow`_: Predicting house prices in Boston area
* `Linear regression with Tensorflow`_: Make use of tensorflow for numeric computation using data flow graphs
* `Logistic Regression in Tensorflow with SMOTE`_: Implementation of Logistic Regression in TensorFlow
* `A TensorFlow Tutorial - Email Classification`_: Using a simple logistic regression classifier
* `Linear Regression using TensorFlow`_: Training a linear model by TensorFlow
* `Logistic Regression using TensorFlow`_: Training a logistic regression by TensorFlow for binary classification


.. _TensorFlow Linear Model Tutorial: https://www.tensorflow.org/tutorials/wide
.. _Linear Regression in Tensorflow: https://aqibsaeed.github.io/2016-07-07-TensorflowLR/
.. _Linear regression with Tensorflow: https://www.linkedin.com/pulse/linear-regression-tensorflow-iv%C3%A1n-corrales-solera
.. _Logistic Regression in Tensorflow with SMOTE: https://aqibsaeed.github.io/2016-08-10-logistic-regression-tf/
.. _A TensorFlow Tutorial - Email Classification: http://jrmeyer.github.io/tutorial/2016/02/01/TensorFlow-Tutorial.html
.. _Linear Regression using TensorFlow: https://github.com/astorfi/TensorFlow-World/tree/master/docs/tutorials/2-basics_in_machine_learning/linear_regression
.. _Logistic Regression using TensorFlow: https://github.com/astorfi/TensorFlow-World/tree/master/docs/tutorials/2-basics_in_machine_learning/logistic_regression

* `Deep Learning with Tensorflow - Logistic Regression`_: A tutorial on Logistic Regression
* `Deep Learning with Tensorflow - Linear Regression with TensorFlow`_: A tutorial on Linear Regression

.. _Deep Learning with Tensorflow - Logistic Regression: https://www.youtube.com/watch?v=4cBRxZavvTo&t=1s
.. _Deep Learning with Tensorflow - Linear Regression with TensorFlow: https://www.youtube.com/watch?v=zNalsMIB3NE


------------------------------
Convolutional Neural Networks
------------------------------

.. image:: _img/mainpage/CNNs.png


* `Convolutional Neural Networks`_: Official TensorFlow documentation
* `Convolutional Neural Networks using TensorFlow`_: Training a classifier using convolutional neural networks
* `Image classifier using convolutional neural network`_: Building a convolutional neural network based image classifier
* `Convolutional Neural Network CNN with TensorFlow tutorial`_: It covers how to write a basic convolutional neural network within TensorFlow with Python
* `Deep Learning CNNs in Tensorflow with GPUs`_: Designing the architecture of a convolutional neural network (CNN)


.. _Convolutional Neural Networks: https://www.tensorflow.org/tutorials/deep_cnn
.. _Convolutional Neural Networks using TensorFlow: https://github.com/astorfi/TensorFlow-World/tree/master/docs/tutorials/3-neural_network/convolutiona_neural_network
.. _Image classifier using convolutional neural network: http://cv-tricks.com/tensorflow-tutorial/training-convolutional-neural-network-for-image-classification/
.. _Convolutional Neural Network CNN with TensorFlow tutorial: https://pythonprogramming.net/cnn-tensorflow-convolutional-nerual-network-machine-learning-tutorial/
.. _Deep Learning CNNs in Tensorflow with GPUs: https://hackernoon.com/deep-learning-cnns-in-tensorflow-with-gpus-cba6efe0acc2

* `Deep Learning with Neural Networks`_: Convolutional Neural Networks with TensorFlow
* `TensorFlow Tutorial`_: Convolutional Neural Network
* `Understanding Convolution with TensorFlow`_: A tutorial on Convolution operation with TensorFlow
* `CNN - Deep Learning with Tensorflow`_: Convolutional Network with TensorFlow

.. _Deep Learning with Neural Networks: https://www.youtube.com/watch?v=mynJtLhhcXk
.. _TensorFlow Tutorial: https://www.youtube.com/watch?v=HMcx-zY8JSg
.. _Understanding Convolution with TensorFlow: https://www.youtube.com/watch?v=ETdaP_bBNWc
.. _CNN - Deep Learning with Tensorflow: https://www.youtube.com/watch?v=yL-MkBSv18c

-------------------------
Recurrent Neural Networks
-------------------------

.. image:: _img/mainpage/RNN.png



* `Recurrent Neural Networks`_: TensorFlow official documentation
* `How to build a Recurrent Neural Network in TensorFlow`_: How to build a simple working Recurrent Neural Network in TensorFlow
* `Recurrent Neural Networks in Tensorflow`_: Building a vanilla recurrent neural network (RNN) from the ground up in Tensorflow
* `RNNs in Tensorflow - a Practical Guide and Undocumented Features`_: Going over some of the best practices for working with RNNs in Tensorflow
* `RNN / LSTM cell example in TensorFlow and Python`_: Covering how to code a Recurrent Neural Network model with an LSTM in TensorFlow
* `Sequence prediction using recurrent neural networks(LSTM) with TensorFlow`_: How to approximate a sequence of vectors using a recurrent neural networks
* `TensorFlow RNN Tutorial`_: Recurrent Neural Networks for exploring time series and developing speech recognition capabilities

.. _Recurrent Neural Networks: https://www.tensorflow.org/tutorials/recurrent
.. _How to build a Recurrent Neural Network in TensorFlow: https://medium.com/@erikhallstrm/hello-world-rnn-83cd7105b767
.. _Recurrent Neural Networks in Tensorflow: https://r2rt.com/recurrent-neural-networks-in-tensorflow-i.html
.. _RNNs in Tensorflow - a Practical Guide and Undocumented Features: http://www.wildml.com/2016/08/rnns-in-tensorflow-a-practical-guide-and-undocumented-features/
.. _RNN / LSTM cell example in TensorFlow and Python: https://pythonprogramming.net/rnn-tensorflow-python-machine-learning-tutorial/
.. _Sequence prediction using recurrent neural networks(LSTM) with TensorFlow: http://mourafiq.com/2016/05/15/predicting-sequences-using-rnn-in-tensorflow.html
.. _TensorFlow RNN Tutorial: https://svds.com/tensorflow-rnn-tutorial/


* `Deep Learning with Neural Networks and TensorFlow`_: Recurrent Neural Networks (RNN)
* `An Introduction to LSTMs in Tensorflow`_: A brief tutorial
* `Deep Learning with Tensorflow - The Recurrent Neural Network Model`_: A tutorial on the Recurrent Neural Network Models
* `Sequence Models and the RNN API`_: TensorFlow Dev Summit 2017
* `RNN Example in Tensorflow`_: A quick tutorial

.. _Deep Learning with Neural Networks and TensorFlow: https://www.youtube.com/watch?v=hWgGJeAvLws
.. _An Introduction to LSTMs in Tensorflow: https://www.youtube.com/watch?v=l4X-kZjl1gs
.. _Deep Learning with Tensorflow - The Recurrent Neural Network Model: https://www.youtube.com/watch?v=C0xoB8L8ms0&t=89s
.. _Sequence Models and the RNN API: https://www.youtube.com/watch?v=RIR_-Xlbp7s
.. _RNN Example in Tensorflow: https://www.youtube.com/watch?v=dFARw8Pm0Gk

-------------
Autoencoders
-------------

.. image:: _img/mainpage/autoencoder.png

* `Deep Autoencoder with TensorFlow`_: An open source project
* `Variational Autoencoder in TensorFlow`_: A tutorial on Variational Autoencoder
* `Diving Into TensorFlow With Stacked Autoencoders`_: A nice brief tutorials
* `Convolutional Autoencoders in Tensorflow`_: Implementing a single layer CAE
* `Variational Autoencoder using Tensorflow`_: Facial expression low dimensional embedding

.. _Deep Autoencoder with TensorFlow: https://github.com/cmgreen210/TensorFlowDeepAutoencoder
.. _Variational Autoencoder in TensorFlow: https://jmetzen.github.io/2015-11-27/vae.html
.. _Diving Into TensorFlow With Stacked Autoencoders: http://cmgreen.io/2016/01/04/tensorflow_deep_autoencoder.html
.. _Convolutional Autoencoders in Tensorflow: https://pgaleone.eu/neural-networks/deep-learning/2016/12/13/convolutional-autoencoders-in-tensorflow/
.. _Variational Autoencoder using Tensorflow: http://int8.io/variational-autoencoder-in-tensorflow/


* `Deep Learning with Tensorflow - Autoencoder Structure`_: Tutorial on Autoencoder models
* `Deep Learning with Tensorflow - RBMs and Autoencoders`_: Tutorial on Restricted Boltzmann machines and AEs

.. _Deep Learning with Tensorflow - Autoencoder Structure: https://www.youtube.com/watch?v=H_Bi_PQWJJc
.. _Deep Learning with Tensorflow - RBMs and Autoencoders: https://www.youtube.com/watch?v=FsAvo0E5Pmw

-----------------
Generative models
-----------------

.. image:: _img/mainpage/generative_model.png



* `Generative Adversarial Nets in TensorFlow`_: Implementing GAN using TensorFlow, with MNIST data
* `Generative Adversarial Networks`_: A working example of Generative Adversarial Networks

.. _Generative Adversarial Nets in TensorFlow: http://wiseodd.github.io/techblog/2016/09/17/gan-tensorflow/
.. _Generative Adversarial Networks: http://edwardlib.org/tutorials/gan

* `TensorFlow Tutorial - Adversarial Examples`_: A tutorial on a working example for generative models

.. _TensorFlow Tutorial - Adversarial Examples: link

-------------
Multiple GPUs
-------------

.. image:: _img/mainpage/multiple_gpu.png

* `Using GPUs`_: Official TensorFlow documentation
* `Deep Learning with Multiple GPUs on Rescale`_: TensorFlow Tutorial

.. _Using GPUs: https://www.tensorflow.org/tutorials/using_gpu
.. _Deep Learning with Multiple GPUs on Rescale: https://blog.rescale.com/deep-learning-with-multiple-gpus-on-rescale-tensorflow/

===================
TensorFlow Projects
===================

This section is dedicated to provide resources that are mainly open source projects developed by TensorFlow.
Those might be comprehensive tutorials on working example.

-----------------------
Comprehensive Tutorials
-----------------------

.. image:: _img/mainpage/tutorial.png

* `TensorFlow-World`_: Concise and ready-to-use TensorFlow tutorials with detailed documentation
* `TensorFlow-Tutorials`_: Introduction to deep learning based on Google's TensorFlow framework
* `TensorFlow Tutorials`_: Organized tutorials in TensorFlow
* `TensorFlow-Examples`_: Providing working examples in TensorFlow
* `Tensorflow Tutorials using Jupyter Notebook`_: TensorFlow tutorials written in Python plus Jupyter Notebook

.. _TensorFlow-World: https://github.com/astorfi/TensorFlow-World
.. _TensorFlow-Tutorials: https://github.com/nlintz/TensorFlow-Tutorials
.. _TensorFlow Tutorials: https://github.com/Hvass-Labs/TensorFlow-Tutorials
.. _TensorFlow-Examples: https://github.com/aymericdamien/TensorFlow-Examples
.. _Tensorflow Tutorials using Jupyter Notebook: https://github.com/sjchoi86/Tensorflow-101

------
Models
------

.. image:: _img/mainpage/models.png

* `TensorFlow Models`_: Machine learning models implemented in TensorFlow
* `Tensorflow VGG16 and VGG19`_: Implementation of VGG 16 and VGG 19 based on tensorflow-vgg16 and Caffe to Tensorflow
* `ResNet in TensorFlow`_: Implementation of `Deep Residual Learning for Image Recognition <https://arxiv.org/abs/1512.03385>`_
* `Inception in TensorFlow`_: Train the Inception v3 architecture
* `A TensorFlow implementation of DeepMind WaveNet paper`_: TensorFlow implementation of the `WaveNet generative neural network architecture <https://deepmind.com/blog/wavenet-generative-model-raw-audio/>`_ for audio generation
* `3D Convolutional Neural Networks for Speaker Verification`_: Implementation of `3D Convolutional Neural Networks for Speaker Verification application <https://arxiv.org/abs/1705.09422>`_ in TensorFlow.
* `Domain Transfer Network (DTN)`_: The implementation of `Unsupervised Cross-Domain Image Generation <https://arxiv.org/abs/1611.02200>`_ in TensorFlow
* `Neural Style`_: The Neural Style algorithm implementation that synthesizes a pastiche
* `SqueezeNet in TensorFlow`_: Tensorflow implementation of SqueezeNet


.. _TensorFlow Models: https://github.com/tensorflow/models
.. _Tensorflow VGG16 and VGG19: https://github.com/machrisaa/tensorflow-vgg
.. _ResNet in TensorFlow: https://github.com/ry/tensorflow-resnet
.. _Inception in TensorFlow: https://github.com/tensorflow/models/tree/master/inception
.. _A TensorFlow implementation of DeepMind WaveNet paper: https://github.com/ibab/tensorflow-wavenet
.. _3D Convolutional Neural Networks for Speaker Verification: https://github.com/astorfi/3D-convolutional-speaker-recognition
.. _Domain Transfer Network (DTN): https://github.com/yunjey/domain-transfer-network
.. _Neural Style: https://github.com/cysmith/neural-style-tf
.. _SqueezeNet in TensorFlow: https://github.com/vonclites/squeezenet


===================
Published Resources
===================

This section is dedicated to provide published resources on TensorFlow, Such as websites, blogs, and books.



---------------------------------
Online Courses and Documentations
---------------------------------

.. image:: _img/mainpage/online.png

* `LearningTensorFlow`_: Beginner-level tutorials for a TensorFlow
* `Deep Learning by Google`_: A free online course developed by Google and Udacity
* `Tensorflow for Deep Learning Research`_: A comprehensive course by Stanford
* `Creative Applications of Deep Learning with TensorFlow`_: A free online course on TensorFlow from Kadenze
* `Deep Learning with TensorFlow Tutorial`_: In this TensorFlow course, you will be able to learn the basic concepts of TensorFlow

.. _LearningTensorFlow: https://learningtensorflow.com/
.. _Deep Learning by Google: https://www.udacity.com/course/deep-learning--ud730
.. _Tensorflow for Deep Learning Research: https://web.stanford.edu/class/cs20si/
.. _Creative Applications of Deep Learning with TensorFlow: https://www.kadenze.com/courses/creative-applications-of-deep-learning-with-tensorflow/info
.. _Deep Learning with TensorFlow Tutorial: https://cognitiveclass.ai/courses/deep-learning-tensorflow/


------
Books
------

.. image:: _img/mainpage/books.jpg

* `TensorFlow Machine Learning Cookbook`_: Quick guide to implementing TensorFlow in your day-to-day machine learning activities
* `Deep Learning with TensorFlow`_: Throughout the book, you’ll learn how to implement deep learning algorithms for machine learning systems
* `First contact with TensorFlow`_: An online book on TensorFlow
* `Building Machine Learning Projects with TensorFlow`_: Learn how to implement TensorFlow in production
* `Learning TensorFlow`_: This book is an end-to-end guide to TensorFlow
* `Machine Learning with TensorFlow`_: Tackle common commercial machine learning problems with Google’s TensorFlow library
* `Getting Started with TensorFlow`_: An easy-to-understand book on TensorFlow
* `Hands-On Machine Learning with Scikit-Learn and TensorFlow`_: By using examples, theory, the book help to gain an understanding of the machine learning concepts
* `Machine Learning with TensorFlow (MEAP)`_: An introduction to the concepts of TensorFlow

.. _TensorFlow Machine Learning Cookbook: https://www.amazon.com/dp/B01HY3TC54/ref=dp-kindle-redirect?_encoding=UTF8&btkr=1
.. _Deep Learning with TensorFlow: https://www.packtpub.com/big-data-and-business-intelligence/deep-learning-tensorflow
.. _First contact with TensorFlow: http://jorditorres.org/first-contact-with-tensorflow/
.. _Building Machine Learning Projects with TensorFlow: https://www.amazon.com/dp/B01M2Z8FS4/ref=dp-kindle-redirect?_encoding=UTF8&btkr=1
.. _Learning TensorFlow: http://shop.oreilly.com/product/0636920063698.do
.. _Machine Learning with TensorFlow: https://www.packtpub.com/big-data-and-business-intelligence/machine-learning-tensorflow
.. _Getting Started with TensorFlow: https://www.amazon.com/Getting-Started-TensorFlow-Giancarlo-Zaccone-ebook/dp/B01H1JD6JO
.. _Hands-On Machine Learning with Scikit-Learn and TensorFlow: http://shop.oreilly.com/product/0636920052289.do
.. _Machine Learning with TensorFlow (MEAP): https://www.manning.com/books/machine-learning-with-tensorflow


============
Contributing
============

*For typos, please do not create a pull request. Instead, declare them in issues or email the repository owner*. Please note we have a code of conduct, please follow it in all your interactions with the project.

--------------------
Pull Request Process
--------------------

Please consider the following criterions in order to help us in a better way:

1. The pull request is mainly expected to be a link suggestion.
2. Please make sure your suggested resources are not obsolete or broken.
3. Ensure any install or build dependencies are removed before the end of the layer when doing a
   build and creating a pull request.
4. Add comments with details of changes to the interface, this includes new environment
   variables, exposed ports, useful file locations and container parameters.
5. You may merge the Pull Request in once you have the sign-off of at least one other developer, or if you
   do not have permission to do that, you may request the owner to merge it for you if you believe all checks are passed.

----------
Final Note
----------

We are looking forward to your kind feedback. Please help us to improve this open source project and make our work better.
For contribution, please create a pull request and we will investigate it promptly. Once again, we appreciate
your kind feedback and support.


================================================
FILE: conf.py
================================================
import os
import sys

import sphinx_rtd_theme
sys.path.insert(0, os.path.abspath('_ext'))
# from recommonmark.parser import CommonMarkParser

sys.path.insert(0, os.path.abspath('..'))
sys.path.append(os.path.dirname(__file__))
# os.environ.setdefault("DJANGO_SETTINGS_MODULE", "readthedocs.settings.dev")

# from django.conf import settings

# import django
# django.setup()


sys.path.append(os.path.abspath('_ext'))
extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.intersphinx',
]
templates_path = ['_templates']

edit_on_github_project = 'astorfi/TensorFlow-Roadmap'
edit_on_github_branch = 'master'

source_suffix = ['.rst', '.md']
# source_parsers = {
#     '.md': CommonMarkParser,
# }

master_doc = 'index'
project = u'TensorFlow-Roadmap'
copyright = u'2019, Amirsina Torfi'
author = u'Amirsina Torfi'
version = '1.0'
release = '1.0'
exclude_patterns = ['_build']
default_role = 'obj'
pygments_style = 'sphinx'
# intersphinx_mapping = {
#     'TensorFlow-World': ('https://github.com/astorfi/TensorFlow-World', None),
# }
htmlhelp_basename = 'ReadTheDocsdoc'
latex_documents = [
    (master_doc, 'TensorFlow-Roadmap.tex', u'TensorFlow-Roadmap Documentation',
     u'Amirsina Torfi', 'manual'),
]
man_pages = [
    (master_doc, 'tensorFlow-roadmap', u'TensorFlow-Roadmap Documentation',
     [author], 1)
]
exclude_patterns = [
    # 'api' # needed for ``make gettext`` to not die.
]

language = 'en'

locale_dirs = [
    'locale/',
]
gettext_compact = False

html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_logo = '_img/tflogo.gif'
html_theme_options = {
    'logo_only': True,
    'display_version': False,
}

github_url='https://github.com/astorfi/TensorFlow-Roadmap'

html_context = {
"display_github": True, # Add 'Edit on Github' link instead of 'View page source'
"last_updated": True,
"commit": False,
 'github_url': 'https://github.com/astorfi/TensorFlow-Roadmap'
}


#def setup(app):
#     app.add_stylesheet('custom.css')


================================================
FILE: docs/Makefile
================================================
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS    =
SPHINXBUILD   = sphinx-build
SPHINXPROJ    = TensoFlow-World-Resources
SOURCEDIR     = source
BUILDDIR      = build

# Put it first so that "make" without argument is like "make help".
help:
	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

================================================
FILE: docs/make.bat
================================================
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
	set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
set SPHINXPROJ=TensoFlow-World-Resources

if "%1" == "" goto help

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
	echo.
	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
	echo.installed, then set the SPHINXBUILD environment variable to point
	echo.to the full path of the 'sphinx-build' executable. Alternatively you
	echo.may add the Sphinx directory to PATH.
	echo.
	echo.If you don't have Sphinx installed, grab it from
	echo.http://sphinx-doc.org/
	exit /b 1
)

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%

:end
popd


================================================
FILE: docs/source/_ext/djangodocs.py
================================================
def setup(app):
    app.add_crossref_type(
        directivename="setting",
        rolename="setting",
        indextemplate="pair: %s; setting",
    )


================================================
FILE: docs/source/conf.py
================================================
import os
import sys

import sphinx_rtd_theme
sys.path.insert(0, os.path.abspath('_ext'))
# from recommonmark.parser import CommonMarkParser

sys.path.insert(0, os.path.abspath('..'))
sys.path.append(os.path.dirname(__file__))
# os.environ.setdefault("DJANGO_SETTINGS_MODULE", "readthedocs.settings.dev")

# from django.conf import settings

# import django
# django.setup()


sys.path.append(os.path.abspath('_ext'))
extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.intersphinx',
]
templates_path = ['_templates']

edit_on_github_project = 'astorfi/TensorFlow-Roadmap'
edit_on_github_branch = 'master'

source_suffix = ['.rst', '.md']
# source_parsers = {
#     '.md': CommonMarkParser,
# }

master_doc = 'index'
project = u'TensorFlow-Roadmap'
copyright = u'2019, Amirsina Torfi'
author = u'Amirsina Torfi'
version = '1.0'
release = '1.0'
exclude_patterns = ['_build']
default_role = 'obj'
pygments_style = 'sphinx'
# intersphinx_mapping = {
#     'TensorFlow-World': ('https://github.com/astorfi/TensorFlow-World', None),
# }
htmlhelp_basename = 'ReadTheDocsdoc'
latex_documents = [
    (master_doc, 'TensorFlow-Roadmap.tex', u'TensorFlow-Roadmap Documentation',
     u'Amirsina Torfi', 'manual'),
]
man_pages = [
    (master_doc, 'tensoflow-roadmap', u'TensorFlow-Roadmap Documentation',
     [author], 1)
]
exclude_patterns = [
    # 'api' # needed for ``make gettext`` to not die.
]

language = 'en'

locale_dirs = [
    'locale/',
]
gettext_compact = False

html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_logo = '_img/tflogo.gif'
html_theme_options = {
    'logo_only': True,
    'display_version': False,
}

github_url='https://github.com/astorfi/TensorFlow-Roadmap'

html_context = {
"display_github": True, # Add 'Edit on Github' link instead of 'View page source'
"last_updated": True,
"commit": False,
 'github_url': 'https://github.com/astorfi/TensorFlow-Roadmap'
}


#def setup(app):
#     app.add_stylesheet('custom.css')


================================================
FILE: docs/source/content/books.rst
================================================
===================
Published Resources
===================

This section is dedicated to provide published resources on TensorFlow, Such as websites, blogs, and books.



---------------------------------
Online Courses and Documentations
---------------------------------

* `LearningTensorFlow`_: Beginner-level tutorials for a TensorFlow
* `Deep Learning by Google`_: A free online course developed by Google and Udacity
* `Tensorflow for Deep Learning Research`_: A comprehensive course by Stanford
* `Creative Applications of Deep Learning with TensorFlow`_: A non-free course on TensorFlow
* `Deep Learning with TensorFlow Tutorial`_: In this TensorFlow course, you will be able to learn the basic concepts of TensorFlow

.. _LearningTensorFlow: https://learningtensorflow.com/
.. _Deep Learning by Google: https://www.udacity.com/course/deep-learning--ud730
.. _Tensorflow for Deep Learning Research: https://web.stanford.edu/class/cs20si/
.. _Creative Applications of Deep Learning with TensorFlow: https://www.kadenze.com/courses/creative-applications-of-deep-learning-with-tensorflow/info
.. _Deep Learning with TensorFlow Tutorial: https://cognitiveclass.ai/courses/deep-learning-tensorflow/



------
Books
------

* `TensorFlow Machine Learning Cookbook`_: Quick guide to implementing TensorFlow in your day-to-day machine learning activities
* `Deep Learning with TensorFlow`_: Throughout the book, you’ll learn how to implement deep learning algorithms for machine learning systems
* `First contact with TensorFlow`_: An online book on TensorFlow
* `Building Machine Learning Projects with TensorFlow`_: Learn how to implement TensorFlow in production
* `Learning TensorFlow`_: This book is an end-to-end guide to TensorFlow
* `Machine Learning with TensorFlow`_: Tackle common commercial machine learning problems with Google’s TensorFlow library
* `Getting Started with TensorFlow`_: An easy-to-understand book on TensorFlow
* `Hands-On Machine Learning with Scikit-Learn and TensorFlow`_: By using examples, theory, the book help to gain an understanding of the machine learning concepts
* `Machine Learning with TensorFlow (MEAP)`_: An introduction to the concepts of TensorFlow

.. _TensorFlow Machine Learning Cookbook: https://www.amazon.com/dp/B01HY3TC54/ref=dp-kindle-redirect?_encoding=UTF8&btkr=1
.. _Deep Learning with TensorFlow: https://www.packtpub.com/big-data-and-business-intelligence/deep-learning-tensorflow
.. _First contact with TensorFlow: http://jorditorres.org/first-contact-with-tensorflow/
.. _Building Machine Learning Projects with TensorFlow: https://www.amazon.com/dp/B01M2Z8FS4/ref=dp-kindle-redirect?_encoding=UTF8&btkr=1
.. _Learning TensorFlow: http://shop.oreilly.com/product/0636920063698.do
.. _Machine Learning with TensorFlow: https://www.packtpub.com/big-data-and-business-intelligence/machine-learning-tensorflow
.. _Getting Started with TensorFlow: https://www.amazon.com/Getting-Started-TensorFlow-Giancarlo-Zaccone-ebook/dp/B01H1JD6JO
.. _Hands-On Machine Learning with Scikit-Learn and TensorFlow: http://shop.oreilly.com/product/0636920052289.do
.. _Machine Learning with TensorFlow (MEAP): https://www.manning.com/books/machine-learning-with-tensorflow


================================================
FILE: docs/source/content/howtocode.rst
================================================
============================
Programming with TensorFlow
============================

.. * `Title`_: some text
.. .. _Title: link

The references here, deal with the details of programming and writing TensorFlow code.

-------------------------------
Reading data and input pipeline
-------------------------------

The first part is always how to prepare data and how to provide the pipeline to feed it to TensorFlow.
Usually providing the input pipeline can be complicated, even more than the structure design!

~~~~~~~~~~~~~~~~~
Written resources
~~~~~~~~~~~~~~~~~

* `Dataset API for TensorFlow Input Pipelines`_: A TensorFlow official documentation on *Using the Dataset API for TensorFlow Input Pipelines*
* `TesnowFlow input pipeline`_: Input pipeline provided by Stanford.
* `TensorFlow input pipeline example`_: A working example.
* `TensorFlow Data Input`_: TensorFlow Data Input: Placeholders, Protobufs & Queues
* `Reading data`_: The official documentation by the TensorFLow on how to read data
* `basics of reading a CSV file`_: A tutorial on reading a CSV file
* `Custom Data Readers`_: Official documentation on this how to define a reader.

.. _Dataset API for TensorFlow Input Pipelines: https://github.com/tensorflow/tensorflow/tree/v1.2.0-rc1/tensorflow/contrib/data
.. _TesnowFlow input pipeline: http://web.stanford.edu/class/cs20si/lectures/slides_09.pdf
.. _TensorFlow input pipeline example: http://ischlag.github.io/2016/06/19/tensorflow-input-pipeline-example/
.. _TensorFlow Data Input: https://indico.io/blog/tensorflow-data-inputs-part1-placeholders-protobufs-queues/
.. _Reading data: https://www.tensorflow.org/programmers_guide/reading_data
.. _basics of reading a CSV file: http://learningtensorflow.com/ReadingFilesBasic/
.. _Custom Data Readers: https://www.tensorflow.org/extend/new_data_formats

~~~~~~~~~~~~~~~~
Visual resources
~~~~~~~~~~~~~~~~

* `Tensorflow tutorial on TFRecords`_: A tutorial on how to transform data into TFRecords

.. _Tensorflow tutorial on TFRecords: https://www.youtube.com/watch?v=F503abjanHA

----------
Variables
----------

Variables are supposed to hold the parameters and supersede by new values as the parameters are updated.
Variables must be clearly set and initialized.

~~~~~~~~~~~~~~~~~
Written Resources
~~~~~~~~~~~~~~~~~

^^^^^^^^^^^^^^^^^^^^^^^^
Creation, Initialization
^^^^^^^^^^^^^^^^^^^^^^^^

* `Variables Creation and Initialization`_: An official documentation on setting up variables
* `Introduction to TensorFlow Variables - Creation and Initialization`_: This tutorial deals with defining and initializing TensorFlow variables
* `Variables`_: An introduction to variables

.. _Variables Creation and Initialization: https://www.tensorflow.org/programmers_guide/variables
.. _Introduction to TensorFlow Variables - Creation and Initialization: http://machinelearninguru.com/deep_learning/tensorflow/basics/variables/variables.html
.. _Variables: http://learningtensorflow.com/lesson2/

^^^^^^^^^^^^^^^^^^^^^
Saving and restoring
^^^^^^^^^^^^^^^^^^^^^

* `Saving and Loading Variables`_: The official documentation on saving and restoring variables
* `save and restore Tensorflow models`_: A quick tutorial to save and restore Tensorflow models

.. _Saving and Loading Variables: https://www.tensorflow.org/programmers_guide/variables
.. _save and restore Tensorflow models: http://cv-tricks.com/tensorflow-tutorial/save-restore-tensorflow-models-quick-complete-tutorial/

^^^^^^^^^^^^^^^^^
Sharing Variables
^^^^^^^^^^^^^^^^^

* `Sharing Variables`_: The official documentation on how to share variables

.. _Sharing Variables: https://www.tensorflow.org/programmers_guide/variable_scope

~~~~~~~~~~~~~~~~~
Visual Resources
~~~~~~~~~~~~~~~~~

* `Deep Learning with Tensorflow - Tensors and Variables`_: A Tensorflow tutorial for introducing Tensors, Variables and Placeholders
* `Tensorflow Variables`_: A quick introduction to TensorFlow variables
* `Save and Restore in TensorFlow`_: TensorFlow Tutorial on Save and Restore variables

.. _Deep Learning with Tensorflow - Tensors and Variables: https://www.youtube.com/watch?v=zgV-WzLyrYE
.. _Tensorflow Variables: https://www.youtube.com/watch?v=UYyqNH3r4lk
.. _Save and Restore in TensorFlow: https://www.tensorflow.org/programmers_guide/variable_scope

--------------------
TensorFlow Utilities
--------------------

Different utilities empower TensorFlow for faster computation in a more monitored manner.

~~~~~~~~~~~~~~~~~
Written Resources
~~~~~~~~~~~~~~~~~

^^^^^^^^^^
Supervisor
^^^^^^^^^^

* `Supervisor - Training Helper for Days-Long Trainings`_: The official documentation for TensorFLow Supervisor.
* `Using TensorFlow Supervisor with TensorBoard summary groups`_: Using both TensorBoard and the Supervisor for profit
* `Tensorflow example`_: A TensorFlow example using Supervisor.


.. _Supervisor - Training Helper for Days-Long Trainings: https://www.tensorflow.org/programmers_guide/supervisor
.. _Using TensorFlow Supervisor with TensorBoard summary groups: https://dev.widemeadows.de/2017/01/21/using-tensorflows-supervisor-with-tensorboard-summary-groups/
.. _Tensorflow example: http://codata.colorado.edu/notebooks/tutorials/tensorflow_example_davis_yoshida/

^^^^^^^^^^^^^^^^^^^
TensorFlow Debugger
^^^^^^^^^^^^^^^^^^^

* `TensorFlow Debugger (tfdbg) Command-Line-Interface Tutorial`_: Official documentation for using debugger for MNIST
* `How to Use TensorFlow Debugger with tf.contrib.learn`_: A more high-level method to use the debugger.
* `Debugging TensorFlow Codes`_: A Practical Guide for Debugging TensorFlow Codes
* `Debug TensorFlow Models with tfdbg`_:  A tutorial by Google Developers Blog


.. _TensorFlow Debugger (tfdbg) Command-Line-Interface Tutorial: https://www.tensorflow.org/programmers_guide/debugger
.. _How to Use TensorFlow Debugger with tf.contrib.learn: https://www.tensorflow.org/programmers_guide/tfdbg-tflearn
.. _Debugging TensorFlow Codes: https://github.com/wookayin/tensorflow-talk-debugging
.. _Debug TensorFlow Models with tfdbg: https://developers.googleblog.com/2017/02/debug-tensorflow-models-with-tfdbg.html

^^^^^^^^^^
MetaGraphs
^^^^^^^^^^

* `Exporting and Importing a MetaGraph`_: Official TensorFlow documentation
* `Model checkpointing using meta-graphs in TensorFlow`_: A working example

.. _Exporting and Importing a MetaGraph: https://www.tensorflow.org/programmers_guide/meta_graph
.. _Model checkpointing using meta-graphs in TensorFlow: http://www.seaandsailor.com/tensorflow-checkpointing.html

^^^^^^^^^^^
Tensorboard
^^^^^^^^^^^

* `TensorBoard - Visualizing Learning`_: Official documentation by TensorFlow.
* `TensorFlow Ops`_: Provided by Stanford
* `Visualisation with TensorBoard`_: A tutorial on how to create and visualize a graph using TensorBoard
* `Tensorboard`_: A brief tutorial on Tensorboard

.. _TensorBoard - Visualizing Learning: https://www.tensorflow.org/get_started/summaries_and_tensorboard
.. _TensorFlow Ops: http://web.stanford.edu/class/cs20si/lectures/notes_02.pdf
.. _Visualisation with TensorBoard: http://learningtensorflow.com/Visualisation/
.. _Tensorboard: http://edwardlib.org/tutorials/tensorboard

~~~~~~~~~~~~~~~~~
Visual Resources
~~~~~~~~~~~~~~~~~

* `Hands-on TensorBoard (TensorFlow Dev Summit 2017)`_: An introduction to the amazing things you can do with TensorBoard
* `Tensorboard Explained in 5 Min`_: Providing the code for a simple handwritten character classifier in Python and visualizing it in Tensorboard
* `How to Use Tensorboard`_: Going through a bunch of different features in Tensorboard


.. _Hands-on TensorBoard (TensorFlow Dev Summit 2017): https://www.youtube.com/watch?v=eBbEDRsCmv4
.. _Tensorboard Explained in 5 Min: https://www.youtube.com/watch?v=3bownM3L5zM
.. _How to Use Tensorboard: https://www.youtube.com/watch?v=fBVEXKp4DIc


================================================
FILE: docs/source/content/projects.rst
================================================
===================
TensorFlow Projects
===================

This section is dedicated to provide resources that are mainly open source projects developed by TensorFlow.
Those might be comprehensive tutorials on working example.

-----------------------
Comprehensive Tutorials
-----------------------

* `TensorFlow-World`_: Concise and ready-to-use TensorFlow tutorials with detailed documentation
* `TensorFlow-Tutorials`_: Introduction to deep learning based on Google's TensorFlow framework
* `TensorFlow Tutorials`_: Organized tutorials in TensorFlow
* `TensorFlow-Examples`_: Providing working examples in TensorFlow
* `Tensorflow Tutorials using Jupyter Notebook`_: TensorFlow tutorials written in Python plus Jupyter Notebook
* `TensorFlow for Deep Learning Research`_: Code examples for the Stanford course CS 20SI

.. _TensorFlow-World: https://github.com/astorfi/TensorFlow-World
.. _TensorFlow-Tutorials: https://github.com/nlintz/TensorFlow-Tutorials
.. _TensorFlow Tutorials: https://github.com/Hvass-Labs/TensorFlow-Tutorials
.. _TensorFlow-Examples: https://github.com/aymericdamien/TensorFlow-Examples
.. _Tensorflow Tutorials using Jupyter Notebook: https://github.com/sjchoi86/Tensorflow-101
.. _TensorFlow for Deep Learning Research: https://github.com/chiphuyen/tf-stanford-tutorials

------
Models
------

* `TensorFlow Models`_: Machine learning models implemented in TensorFlow
* `Tensorflow VGG16 and VGG19`_: Implementation of VGG 16 and VGG 19 based on tensorflow-vgg16 and Caffe to Tensorflow
* `ResNet in TensorFlow`_: Implementation of `Deep Residual Learning for Image Recognition <https://arxiv.org/abs/1512.03385>`_
* `Inception in TensorFlow`_: Train the Inception v3 architecture
* `A TensorFlow implementation of DeepMind WaveNet paper`_: TensorFlow implementation of the `WaveNet generative neural network architecture <https://deepmind.com/blog/wavenet-generative-model-raw-audio/>`_ for audio generation
* `3D Convolutional Neural Networks for Speaker Verification`_: Implementation of `3D Convolutional Neural Networks for Speaker Verification application <https://arxiv.org/abs/1705.09422>`_ in TensorFlow.
* `Domain Transfer Network (DTN)`_: The implementation of `Unsupervised Cross-Domain Image Generation <https://arxiv.org/abs/1611.02200>`_ in TensorFlow
* `Neural Style`_: The Neural Style algorithm implementation that synthesizes a pastiche
* `SqueezeNet in TensorFlow`_: Tensorflow implementation of SqueezeNet


.. _TensorFlow Models: https://github.com/tensorflow/models
.. _Tensorflow VGG16 and VGG19: https://github.com/machrisaa/tensorflow-vgg
.. _ResNet in TensorFlow: https://github.com/ry/tensorflow-resnet
.. _Inception in TensorFlow: https://github.com/tensorflow/models/tree/master/inception
.. _A TensorFlow implementation of DeepMind WaveNet paper: https://github.com/ibab/tensorflow-wavenet
.. _3D Convolutional Neural Networks for Speaker Verification: https://github.com/astorfi/3D-convolutional-speaker-recognition
.. _Domain Transfer Network (DTN): https://github.com/yunjey/domain-transfer-network
.. _Neural Style: https://github.com/cysmith/neural-style-tf
.. _SqueezeNet in TensorFlow: https://github.com/vonclites/squeezenet


================================================
FILE: docs/source/content/tutorials.rst
================================================
====================
TensorFlow Tutorials
====================

This section is dedicated to provide tutorial resources on the implementation of
different models with TensorFlow.

------------------------------
Linear and Logistic Regression
------------------------------

~~~~~~~~~~~~~~~~~
Written Resources
~~~~~~~~~~~~~~~~~

* `TensorFlow Linear Model Tutorial`_: Using TF.Learn API in TensorFlow to solve a binary classification problem
* `Linear Regression in Tensorflow`_: Predicting house prices in Boston area
* `Linear regression with Tensorflow`_: Make use of tensorflow for numeric computation using data flow graphs
* `Logistic Regression in Tensorflow with SMOTE`_: Implementation of Logistic Regression in TensorFlow
* `A TensorFlow Tutorial - Email Classification`_: Using a simple logistic regression classifier
* `Linear Regression using TensorFlow`_: Training a linear model by TensorFlow
* `Logistic Regression using TensorFlow`_: Training a logistic regression by TensorFlow for binary classification


.. _TensorFlow Linear Model Tutorial: https://www.tensorflow.org/tutorials/wide
.. _Linear Regression in Tensorflow: https://aqibsaeed.github.io/2016-07-07-TensorflowLR/
.. _Linear regression with Tensorflow: https://www.linkedin.com/pulse/linear-regression-tensorflow-iv%C3%A1n-corrales-solera
.. _Logistic Regression in Tensorflow with SMOTE: https://aqibsaeed.github.io/2016-08-10-logistic-regression-tf/
.. _A TensorFlow Tutorial - Email Classification: http://jrmeyer.github.io/tutorial/2016/02/01/TensorFlow-Tutorial.html
.. _Linear Regression using TensorFlow: https://github.com/astorfi/TensorFlow-World/tree/master/docs/tutorials/2-basics_in_machine_learning/linear_regression
.. _Logistic Regression using TensorFlow: https://github.com/astorfi/TensorFlow-World/tree/master/docs/tutorials/2-basics_in_machine_learning/logistic_regression

~~~~~~~~~~~~~~~~~
Visual Resources
~~~~~~~~~~~~~~~~~

* `Deep Learning with Tensorflow - Logistic Regression`_: A tutorial on Logistic Regression
* `Deep Learning with Tensorflow - Linear Regression with TensorFlow`_: A tutorial on Linear Regression

.. _Deep Learning with Tensorflow - Logistic Regression: https://www.youtube.com/watch?v=4cBRxZavvTo&t=1s
.. _Deep Learning with Tensorflow - Linear Regression with TensorFlow: https://www.youtube.com/watch?v=zNalsMIB3NE


------------------------------
Convolutional Neural Networks
------------------------------

~~~~~~~~~~~~~~~~~
Written Resources
~~~~~~~~~~~~~~~~~

* `Convolutional Neural Networks`_: Official TensorFlow documentation
* `Convolutional Neural Networks using TensorFlow`_: Training a classifier using convolutional neural networks
* `Image classifier using convolutional neural network`_: Building a convolutional neural network based image classifier
* `Convolutional Neural Network CNN with TensorFlow tutorial`_: It covers how to write a basic convolutional neural network within TensorFlow with Python
* `Deep Learning CNNs in Tensorflow with GPUs`_: Designing the architecture of a convolutional neural network (CNN)


.. _Convolutional Neural Networks: https://www.tensorflow.org/tutorials/deep_cnn
.. _Convolutional Neural Networks using TensorFlow: https://github.com/astorfi/TensorFlow-World/tree/master/docs/tutorials/3-neural_network/convolutiona_neural_network
.. _Image classifier using convolutional neural network: http://cv-tricks.com/tensorflow-tutorial/training-convolutional-neural-network-for-image-classification/
.. _Convolutional Neural Network CNN with TensorFlow tutorial: https://pythonprogramming.net/cnn-tensorflow-convolutional-nerual-network-machine-learning-tutorial/
.. _Deep Learning CNNs in Tensorflow with GPUs: https://hackernoon.com/deep-learning-cnns-in-tensorflow-with-gpus-cba6efe0acc2

~~~~~~~~~~~~~~~~~
Visual Resources
~~~~~~~~~~~~~~~~~

* `Deep Learning with Neural Networks`_: Convolutional Neural Networks with TensorFlow
* `TensorFlow Tutorial`_: Convolutional Neural Network
* `Understanding Convolution with TensorFlow`_: A tutorial on Convolution operation with TensorFlow
* `Deep Learning with Tensorflow`_: Convolutional Network with TensorFlow

.. _Deep Learning with Neural Networks: https://www.youtube.com/watch?v=mynJtLhhcXk
.. _TensorFlow Tutorial: https://www.youtube.com/watch?v=HMcx-zY8JSg
.. _Understanding Convolution with TensorFlow: https://www.youtube.com/watch?v=ETdaP_bBNWc
.. _Deep Learning with Tensorflow: https://www.youtube.com/watch?v=yL-MkBSv18c

-------------------------
Recurrent Neural Networks
-------------------------

~~~~~~~~~~~~~~~~~
Written Resources
~~~~~~~~~~~~~~~~~

* `Recurrent Neural Networks`_: TensorFlow official documentation
* `How to build a Recurrent Neural Network in TensorFlow`_: How to build a simple working Recurrent Neural Network in TensorFlow
* `Recurrent Neural Networks in Tensorflow`_: Building a vanilla recurrent neural network (RNN) from the ground up in Tensorflow
* `RNNs in Tensorflow - a Practical Guide and Undocumented Features`_: Going over some of the best practices for working with RNNs in Tensorflow
* `RNN / LSTM cell example in TensorFlow and Python`_: Covering how to code a Recurrent Neural Network model with an LSTM in TensorFlow
* `Sequence prediction using recurrent neural networks(LSTM) with TensorFlow`_: How to approximate a sequence of vectors using a recurrent neural networks
* `TensorFlow RNN Tutorial`_: Recurrent Neural Networks for exploring time series and developing speech recognition capabilities

.. _Recurrent Neural Networks: https://www.tensorflow.org/tutorials/recurrent
.. _How to build a Recurrent Neural Network in TensorFlow: https://medium.com/@erikhallstrm/hello-world-rnn-83cd7105b767
.. _Recurrent Neural Networks in Tensorflow: https://r2rt.com/recurrent-neural-networks-in-tensorflow-i.html
.. _RNNs in Tensorflow - a Practical Guide and Undocumented Features: http://www.wildml.com/2016/08/rnns-in-tensorflow-a-practical-guide-and-undocumented-features/
.. _RNN / LSTM cell example in TensorFlow and Python: https://pythonprogramming.net/rnn-tensorflow-python-machine-learning-tutorial/
.. _Sequence prediction using recurrent neural networks(LSTM) with TensorFlow: http://mourafiq.com/2016/05/15/predicting-sequences-using-rnn-in-tensorflow.html
.. _TensorFlow RNN Tutorial: https://svds.com/tensorflow-rnn-tutorial/

~~~~~~~~~~~~~~~~~
Visual Resources
~~~~~~~~~~~~~~~~~

* `Deep Learning with Neural Networks and TensorFlow`_: Recurrent Neural Networks (RNN)
* `An Introduction to LSTMs in Tensorflow`_: A brief tutorial
* `Deep Learning with Tensorflow - The Recurrent Neural Network Model`_: A tutorial on the Recurrent Neural Network Models
* `Sequence Models and the RNN API`_: TensorFlow Dev Summit 2017
* `RNN Example in Tensorflow`_: A quick tutorial

.. _Deep Learning with Neural Networks and TensorFlow: https://www.youtube.com/watch?v=hWgGJeAvLws
.. _An Introduction to LSTMs in Tensorflow: https://www.youtube.com/watch?v=l4X-kZjl1gs
.. _Deep Learning with Tensorflow - The Recurrent Neural Network Model: https://www.youtube.com/watch?v=C0xoB8L8ms0&t=89s
.. _Sequence Models and the RNN API: https://www.youtube.com/watch?v=RIR_-Xlbp7s
.. _RNN Example in Tensorflow: https://www.youtube.com/watch?v=dFARw8Pm0Gk

-------------
Autoencoders
-------------

~~~~~~~~~~~~~~~~~
Written Resources
~~~~~~~~~~~~~~~~~

* `Deep Autoencoder with TensorFlow`_: An open source project
* `Variational Autoencoder in TensorFlow`_: A tutorial on Variational Autoencoder
* `Diving Into TensorFlow With Stacked Autoencoders`_: A nice brief tutorials
* `Convolutional Autoencoders in Tensorflow`_: Implementing a single layer CAE
* `Variational Autoencoder using Tensorflow`_: Facial expression low dimensional embedding

.. _Deep Autoencoder with TensorFlow: https://github.com/cmgreen210/TensorFlowDeepAutoencoder
.. _Variational Autoencoder in TensorFlow: https://jmetzen.github.io/2015-11-27/vae.html
.. _Diving Into TensorFlow With Stacked Autoencoders: http://cmgreen.io/2016/01/04/tensorflow_deep_autoencoder.html
.. _Convolutional Autoencoders in Tensorflow: https://pgaleone.eu/neural-networks/deep-learning/2016/12/13/convolutional-autoencoders-in-tensorflow/
.. _Variational Autoencoder using Tensorflow: http://int8.io/variational-autoencoder-in-tensorflow/

~~~~~~~~~~~~~~~~~
Visual Resources
~~~~~~~~~~~~~~~~~

* `Deep Learning with Tensorflow - Autoencoder Structure`_: Tutorial on Autoencoder models
* `Deep Learning with Tensorflow - RBMs and Autoencoders`_: Tutorial on Restricted Boltzmann machines and AEs

.. _Deep Learning with Tensorflow - Autoencoder Structure: https://www.youtube.com/watch?v=H_Bi_PQWJJc
.. _Deep Learning with Tensorflow - RBMs and Autoencoders: https://www.youtube.com/watch?v=FsAvo0E5Pmw

-----------------
Generative models
-----------------

~~~~~~~~~~~~~~~~~
Written Resources
~~~~~~~~~~~~~~~~~

* `Generative Adversarial Nets in TensorFlow`_: Implementing GAN using TensorFlow, with MNIST data
* `Generative Adversarial Networks`_: A working example of Generative Adversarial Networks

.. _Generative Adversarial Nets in TensorFlow: http://wiseodd.github.io/techblog/2016/09/17/gan-tensorflow/
.. _Generative Adversarial Networks: http://edwardlib.org/tutorials/gan

~~~~~~~~~~~~~~~~~
Visual Resources
~~~~~~~~~~~~~~~~~

* `TensorFlow Tutorial - Adversarial Examples`_: A tutorial on a working example for generative models

.. _TensorFlow Tutorial - Adversarial Examples: link

-------------
Multiple GPUs
-------------

~~~~~~~~~~~~~~~~~
Written Resources
~~~~~~~~~~~~~~~~~

* `Using GPUs`_: Official TensorFlow documentation
* `Deep Learning with Multiple GPUs on Rescale`_: TensorFlow Tutorial

.. _Using GPUs: https://www.tensorflow.org/tutorials/using_gpu
.. _Deep Learning with Multiple GPUs on Rescale: https://blog.rescale.com/deep-learning-with-multiple-gpus-on-rescale-tensorflow/


================================================
FILE: docs/source/content/warmup.rst
================================================
============================
Entrance to TensorFlow World
============================

In this section, different TensorFlow topics and their associated
resources will be addressed.

-------------
Installation
-------------

First of all, the TensorFlow must be installed!

~~~~~~~~~~~~~~~~~~
Written Resources
~~~~~~~~~~~~~~~~~~

* `Installing TensorFlow`_: Official TensorFLow installation
* `Install TensorFlow from the source`_: A comprehensive guide on how to install TensorFlow from the source using python/anaconda
* `TensorFlow Installation`_: A short TensorFlow installation guide powered by NVIDIA
* `7 SIMPLE STEPS TO INSTALL TENSORFLOW ON WINDOWS`_: A concise tutorial for installing TensorFlow on Windows

.. _Installing TensorFlow: https://www.tensorflow.org/install/
.. _Install TensorFlow from the source: https://github.com/astorfi/TensorFlow-World/tree/master/docs/tutorials/installation
.. _TensorFlow Installation: http://www.nvidia.com/object/gpu-accelerated-applications-tensorflow-installation.html
.. _7 SIMPLE STEPS TO INSTALL TENSORFLOW ON WINDOWS: http://saintlad.com/install-tensorflow-on-windows/


~~~~~~~~~~~~~~~~
Visual Resources
~~~~~~~~~~~~~~~~

* `Install TensorFlow on Ubuntu`_: A comprehensive tutorial on how to install TensorFlow on Ubuntu
* `Installation of TensorFlow`_: The video covers how to setup TensorFlow
* `Installing CPU and GPU TensorFlow on Windows`_: A tutorial on TensorFlow installation for Windows
* `Installing the GPU version of TensorFlow for making use of your CUDA GPU`_: A GPU-targeted TensoFlow installation


.. _Install TensorFlow on Ubuntu: https://www.youtube.com/watch?v=_3JFEPk4qQY&t=3s
.. _Installation of TensorFlow: https://www.youtube.com/watch?v=CvspEt8kSIg
.. _Installing CPU and GPU TensorFlow on Windows: https://www.youtube.com/watch?v=r7-WPbx8VuY
.. _Installing the GPU version of TensorFlow for making use of your CUDA GPU: https://www.youtube.com/watch?v=io6Ajf5XkaM

---------------
Getting Started
---------------

This part points to resources on how to start to code with TensorFLow

~~~~~~~~~~~~~~~~~~
Written Resources
~~~~~~~~~~~~~~~~~~

* `Getting Started With TensorFlow`_: This guide gets you started programming in TensorFlow
* `learning tensorflow`_:A great resource to start
* `Welcome to TensorFlow World`_: A simple and concise start to TensorFLow

.. _learning tensorflow: http://learningtensorflow.com/getting_started/
.. _Getting Started With TensorFlow: https://www.tensorflow.org/get_started/get_started
.. _Welcome to TensorFlow World: https://github.com/astorfi/TensorFlow-World/tree/master/docs/tutorials/0-welcome

~~~~~~~~~~~~~~~~
Visual Resources
~~~~~~~~~~~~~~~~

* `Gentlest Introduction to Tensorflow  <https://www.youtube.com/watch?v=dYhrCUFN0eM>`_
* `TensorFlow in 5 Minutes  <https://www.youtube.com/watch?v=2FmcHiLCwTU/>`_
* `Deep Learning with TensorFlow - Introduction to TensorFlow  <https://www.youtube.com/watch?v=MotG3XI2qSs>`_
* `TensorFlow Tutorial (Sherry Moore, Google Brain)  <https://www.youtube.com/watch?v=Ejec3ID_h0w>`_
* `Deep Learning with Neural Networks and TensorFlow Introduction  <https://www.youtube.com/watch?v=oYbVFhK_olY>`_
* `A fast with TensorFlow <https:/www.youtube.com/watch?v=Q-FF_0NAT3s>`_

--------------------------
Going Deeper in TensorFLow
--------------------------

Advanced machine learning users can go deeper in TensorFlow in order to
*hit the root*. Scratching the surface may never take us too further!


~~~~~~~~~~~~~~~~~~
Written Resources
~~~~~~~~~~~~~~~~~~

* `TensorFlow Mechanics`_: More experienced machine learning users can dig more in TensorFlow
* `Advanced TensorFlow`_: Advanced Tutorials in TensorFlow
* `We Need to Go Deeper`_: A Practical Guide to Tensorflow and Inception
* `Wide and Deep Learning - Better Together with TensorFlow`_: A tutorial by Google Research Blog




.. _TensorFlow Mechanics: https://www.tensorflow.org/get_started/mnist/mechanics
.. _Advanced TensorFlow: https://github.com/sjchoi86/advanced-tensorflow
.. _We Need to Go Deeper: https://medium.com/initialized-capital/we-need-to-go-deeper-a-practical-guide-to-tensorflow-and-inception-50e66281804f
.. _Wide and Deep Learning - Better Together with TensorFlow: https://research.googleblog.com/2016/06/wide-deep-learning-better-together-with.html


~~~~~~~~~~~~~~~~
Visual Resources
~~~~~~~~~~~~~~~~

* `TensorFlow DeepDive`_: More experienced machine learning users can dig more in TensorFlow
* `Go Deeper - Transfer Learning`_: TensorFlow and Deep Learning
* `Distributed TensorFlow - Design Patterns and Best Practices`_: A talk that was given at the Advanced Spark and TensorFlow Meetup
* `Fundamentals of TensorFlow`_
* `TensorFlow Wide and Deep - Advanced Classification the easy way`_
* `Tensorflow and deep learning - without a PhD`_: A great tutorial on TensoFLow workflow



.. _TensorFlow DeepDive: https://www.youtube.com/watch?v=T0H6zF3K1mc
.. _Go Deeper - Transfer Learning: https://www.youtube.com/watch?v=iu3MOQ-Z3b4
.. _Distributed TensorFlow - Design Patterns and Best Practices: https://www.youtube.com/watch?v=YAkdydqUE2c
.. _Fundamentals of TensorFlow: https://www.youtube.com/watch?v=EM6SU8QVSlY
.. _TensorFlow Wide and Deep - Advanced Classification the easy way: https://www.youtube.com/watch?v=WKgNNC0VLhM
.. _Tensorflow and deep learning - without a PhD: https://www.youtube.com/watch?v=vq2nnJ4g6N0


================================================
FILE: docs/source/credentials/CODE_OF_CONDUCT.rst
================================================
Contributor Covenant Code of Conduct
====================================

Our Pledge
----------

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards
-------------

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities
--------------------

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope
-----

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement
-----------

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at amirsina.torfi@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Attribution
------------

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/


================================================
FILE: docs/source/credentials/CONTRIBUTING.rst
================================================

*************
Contributing
*************

*For typos, please do not create a pull request. Instead, declare them in issues or email the repository owner*. Please note we have a code of conduct, please follow it in all your interactions with the project.

====================
Pull Request Process
====================

Please consider the following criterions in order to help us in a better way:

1. The pull request is mainly expected to be a link suggestion.
2. Please make sure your suggested resources are not obsolete or broken.
3. Ensure any install or build dependencies are removed before the end of the layer when doing a
   build and creating a pull request.
4. Add comments with details of changes to the interface, this includes new environment
   variables, exposed ports, useful file locations and container parameters.
5. You may merge the Pull Request in once you have the sign-off of at least one other developer, or if you
   do not have permission to do that, you may request the owner to merge it for you if you believe all checks are passed.

============
Final Note
============

We are looking forward to your kind feedback. Please help us to improve this open source project and make our work better.
For contribution, please create a pull request and we will investigate it promptly. Once again, we appreciate
your kind feedback and elaborate code inspections.


================================================
FILE: docs/source/credentials/LICENSE.rst
================================================
LICENSE
========

MIT License

Copyright (c) 2019 Amirsina Torfi

Permission is hereby granted, free of charge, to any person obtaining a copy
of this book and associated documentation files (the "source files"), to deal
in the product without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the product, and to permit persons to whom the book is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the product.

THE PRODUCT IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


================================================
FILE: docs/source/index.rst
================================================
.. TensoFlow-World-Resources documentation master file, created by
   sphinx-quickstart on Wed Jul  5 16:28:45 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to TensoFlow-World-Resources's documentation!
=====================================================

.. toctree::
   :maxdepth: 2
   :caption: Foreword

   intro/intro

.. toctree::
   :maxdepth: 2
   :caption: Content

   content/warmup
   content/howtocode
   content/tutorials
   content/projects
   content/books

.. toctree::
   :maxdepth: 2
   :caption: Document Credentials

   credentials/LICENSE


================================================
FILE: docs/source/intro/intro.rst
================================================
Introduction
============

The purpose of this project is to introduce a shortcut to developers and researcher
for finding useful resources about TensorFlow.

-----------
Motivation
-----------

There are different motivations for this open source project.

~~~~~~~~~~~~~~~~~~~~~
Why using TensorFlow?
~~~~~~~~~~~~~~~~~~~~~

A deep learning is of great interest these days, the crucial necessity for rapid and optimized implementation of the algorithms
and designing architectures is the software environment. TensorFlow is designed to facilitate this goal. The strong advantage of
TensorFlow is it flexibility is designing highly modular model which also can be a disadvantage too for beginners since lots of
the pieces must be considered together for creating the model. This issue has been facilitated as well by developing high-level APIs
such as `Keras <https://keras.io/>`_ and `Slim <https://github.com/tensorflow/models/blob/master/inception/inception/slim/README.md//>`_
which gather lots of the design puzzle pieces. The interesting point about TensorFlow is that **its trace can be found anywhere these days**.
Lots of the researchers and developers are using it and *its community is growing with the speed of light*! So the possible issues can
be overcame easily since they might be the issues of lots of other people considering a large number of people involved in TensorFlow community.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
What's the point of this open source project?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

There other similar repositories similar to this repository and are very
comprehensive and useful and to be honest they made me ponder if there is
a necessity for this repository! A great example is `awesome-tensorflow <https://github.com/jtoy/awesome-tensorflow>`_
repository which is a curated list of different TensorFlow resources.

**The point of this repository is that the resources are being targeted**. The organization
of the resources is such that the user can easily find the things he/she is looking for.
We divided the resources to a large number of categories that in the beginning one may
have a headache!!! However, if someone knows what is being located, it is very easy to find the most related resources.
Even if someone doesn't know what to look for, in the beginning, the general resources have
been provided.


------------------------------------
How to make the most of this effort
------------------------------------

The written and visual resources have been split. Moreover, As one can search
in the documentation, the number of categories might look to be too much. For
finding the most relevant resources, please at first look through the general resources.


================================================
FILE: docs/source/saved/conf (another copy).py
================================================
import os
import sys

import sphinx_rtd_theme
sys.path.insert(0, os.path.abspath('_ext'))
# from recommonmark.parser import CommonMarkParser

sys.path.insert(0, os.path.abspath('..'))
sys.path.append(os.path.dirname(__file__))
# os.environ.setdefault("DJANGO_SETTINGS_MODULE", "readthedocs.settings.dev")

# from django.conf import settings

# import django
# django.setup()


sys.path.append(os.path.abspath('_ext'))
extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.intersphinx',
]
templates_path = ['_templates']

edit_on_github_project = 'astorfi/TensorFlow-World-Resources'
edit_on_github_branch = 'master'

source_suffix = ['.rst', '.md']
# source_parsers = {
#     '.md': CommonMarkParser,
# }

master_doc = 'index'
project = u'TensoFlow-World-Resources'
copyright = u'2017, Amirsina Torfi'
author = u'Amirsina Torfi'
version = '1.0'
release = '1.0'
exclude_patterns = ['_build']
default_role = 'obj'
pygments_style = 'sphinx'
# intersphinx_mapping = {
#     'TensorFlow-World': ('https://github.com/astorfi/TensorFlow-World', None),
# }
htmlhelp_basename = 'ReadTheDocsdoc'
latex_documents = [
    (master_doc, 'TensoFlow-World-Resources.tex', u'TensoFlow-World-Resources Documentation',
     u'Amirsina Torfi', 'manual'),
]
man_pages = [
    (master_doc, 'tensoflow-world-resources', u'TensoFlow-World-Resources Documentation',
     [author], 1)
]
exclude_patterns = [
    # 'api' # needed for ``make gettext`` to not die.
]

language = 'en'

locale_dirs = [
    'locale/',
]
gettext_compact = False

html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_logo = '_img/tflogo.gif'
html_theme_options = {
    'logo_only': True,
    'display_version': False,
}

github_url='https://github.com/astorfi/TensorFlow-World-Resources'

html_context = {
"display_github": True, # Add 'Edit on Github' link instead of 'View page source'
"last_updated": True,
"commit": False,
 'github_url': 'https://github.com/spatialaudio/nbsphinx/'
}


#def setup(app):
#     app.add_stylesheet('custom.css')


================================================
FILE: docs/source/saved/conf (copy).py
================================================
import os
import sys

import sphinx_rtd_theme
sys.path.insert(0, os.path.abspath('_ext'))
# from recommonmark.parser import CommonMarkParser

sys.path.insert(0, os.path.abspath('..'))
sys.path.append(os.path.dirname(__file__))
# os.environ.setdefault("DJANGO_SETTINGS_MODULE", "readthedocs.settings.dev")

# from django.conf import settings

# import django
# django.setup()


sys.path.append(os.path.abspath('_ext'))
extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.intersphinx',
    'edit_on_github',
]
templates_path = ['_templates']

edit_on_github_project = 'astorfi/TensorFlow-World-Resources'
edit_on_github_branch = 'master'

source_suffix = ['.rst', '.md']
# source_parsers = {
#     '.md': CommonMarkParser,
# }

master_doc = 'index'
project = u'TensoFlow-World-Resources'
copyright = u'2017, Amirsina Torfi'
author = u'Amirsina Torfi'
version = '1.0'
release = '1.0'
exclude_patterns = ['_build']
default_role = 'obj'
pygments_style = 'sphinx'
# intersphinx_mapping = {
#     'TensorFlow-World': ('https://github.com/astorfi/TensorFlow-World', None),
# }
htmlhelp_basename = 'ReadTheDocsdoc'
latex_documents = [
    (master_doc, 'TensoFlow-World-Resources.tex', u'TensoFlow-World-Resources Documentation',
     u'Amirsina Torfi', 'manual'),
]
man_pages = [
    (master_doc, 'tensoflow-world-resources', u'TensoFlow-World-Resources Documentation',
     [author], 1)
]
exclude_patterns = [
    # 'api' # needed for ``make gettext`` to not die.
]

language = 'en'

locale_dirs = [
    'locale/',
]
gettext_compact = False

html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_logo = '_img/tflogo.gif'
html_theme_options = {
    'logo_only': True,
    'display_version': False,
}

github_url='https://github.com/astorfi/TensorFlow-World-Resources'

html_context = {
"display_github": True, # Add 'Edit on Github' link instead of 'View page source'
"last_updated": True,
"commit": False,
}


#def setup(app):
#     app.add_stylesheet('custom.css')


================================================
FILE: docs/source/saved/conf-2.py
================================================
# -*- coding: utf-8 -*-

import os
import sys
#
# TensoFlow-World-Resources documentation build configuration file, created by
# sphinx-quickstart on Wed Jul  5 16:28:45 2017.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'

# General information about the project.
# project = u'TensoFlow-World-Resources'
copyright = u'2017, Amirsina Torfi'
author = u'Amirsina Torfi'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = u'0.1.0'
# The full version, including alpha/beta/rc tags.
release = u'0.1.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.doctest',
    'sphinx.ext.todo',
    'sphinx.ext.viewcode',
]

autodoc_member_order = 'bysource'

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('../../'))

#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = []

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# If true, `todo` and `todoList` produce output, else they produce nothing.
# todo_include_todos = False


# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#html_theme = 'alabaster'
html_theme = 'default'

# on_rtd is whether we are on readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

if not on_rtd:  # only import and set the theme if we're building docs locally
    import sphinx_rtd_theme
    html_theme = 'sphinx_rtd_theme'
    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# otherwise, readthedocs.org uses their theme by default, so no need to specify it

# html_theme = 'alabaster'

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}

# html_theme_options = {
#     'show_powered_by': False,
#     'github_user': 'astorfi',
#     'github_repo': 'TensorFlow-World-Resources',
#     'github_banner': True,
#     'show_related': False
# }

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']


# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'TensoFlow-World-Resourcesdoc'


# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    #
    # 'papersize': 'letterpaper',

    # The font size ('10pt', '11pt' or '12pt').
    #
    # 'pointsize': '10pt',

    # Additional stuff for the LaTeX preamble.
    #
    # 'preamble': '',

    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
#  author, documentclass [howto, manual, or own class]).
latex_documents = [
    (master_doc, 'TensoFlow-World-Resources.tex', u'TensoFlow-World-Resources Documentation',
     u'Amirsina Torfi', 'manual'),
]


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    (master_doc, 'tensoflow-world-resources', u'TensoFlow-World-Resources Documentation',
     [author], 1)
]


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
    (master_doc, 'TensoFlow-World-Resources', u'TensoFlow-World-Resources Documentation',
     author, 'TensoFlow-World-Resources', 'One line description of project.',
     'Miscellaneous'),
]





================================================
FILE: docs/source/saved/conf.py
================================================
#!/usr/bin/env python3
# -*- coding: utf-8 -*-

# Use sphinx-quickstart to create your own conf.py file!
# After that, you have to edit a few things.  See below.

import sphinx_py3doc_enhanced_theme

# Select nbsphinx and, if needed, add a math extension (mathjax or pngmath):
extensions = [
    'nbsphinx',
    'sphinx.ext.mathjax',
]

# Exclude build directory and Jupyter backup files:
exclude_patterns = ['_build', '**.ipynb_checkpoints']

# Default language for syntax highlighting in reST and Markdown cells
highlight_language = 'none'

# Don't add .txt suffix to source files (available for Sphinx >= 1.5):
html_sourcelink_suffix = ''

# Execute notebooks before conversion: 'always', 'never', 'auto' (default)
#nbsphinx_execute = 'never'

# Use this kernel instead of the one stored in the notebook metadata:
#nbsphinx_kernel_name = 'python3'

# List of arguments to be passed to the kernel that executes the notebooks:
#nbsphinx_execute_arguments = ['--InlineBackend.figure_formats={"png", "pdf"}']

# If True, the build process is continued even if an exception occurs:
#nbsphinx_allow_errors = True

# Controls when a cell will time out (defaults to 30; use -1 for no timeout):
#nbsphinx_timeout = 60

# Default Pygments lexer for syntax highlighting in code cells:
#nbsphinx_codecell_lexer = 'ipython3'

# Width of input/output prompts used in CSS:
#nbsphinx_prompt_width = '8ex'

# If window is narrower than this, input/output prompts are on separate lines:
#nbsphinx_responsive_width = '700px'

# -- The settings below this line are not specific to nbsphinx ------------

master_doc = 'index'

project = 'TensorFlow-World-Resources'
author = 'Amirsina Torfi'
copyright = '2017, ' + author

linkcheck_ignore = [r'http://localhost:\d+/']

# -- Get version information from Git -------------------------------------

try:
    from subprocess import check_output
    release = check_output(['git', 'describe', '--tags', '--always'])
    release = release.decode().strip()
except Exception:
    release = '<unknown>'

# -- Options for HTML output ----------------------------------------------

html_title = project + ' version ' + release
html_theme = "sphinx_py3doc_enhanced_theme"
html_theme_path = [sphinx_py3doc_enhanced_theme.get_html_theme_path()]
html_logo = '_img/tflogo.gif'
html_theme_options = {
    'githuburl': 'https://github.com/astorfi/TensorFlow-World-Resources',
}

# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
    'papersize': 'a4paper',
    'preamble': r"""
\usepackage[sc,osf]{mathpazo}
\linespread{1.05}  % see http://www.tug.dk/FontCatalogue/urwpalladio/
\renewcommand{\sfdefault}{pplj}  % Palatino instead of sans serif
\IfFileExists{zlmtt.sty}{
    \usepackage[light,scaled=1.05]{zlmtt}  % light typewriter font from lmodern
}{
    \renewcommand{\ttdefault}{lmtt}  % typewriter font from lmodern
}
""",
}

latex_documents = [
    (master_doc, 'nbsphinx.tex', project, author, 'howto'),
]

latex_show_urls = 'footnote'




###########################################################################
#          auto-created readthedocs.org specific configuration            #
###########################################################################


#
# The following code was added during an automated build on readthedocs.org
# It is auto created and injected for every build. The result is based on the
# conf.py.tmpl file found in the readthedocs.org codebase:
# https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl
#


import sys
import os.path
from six import string_types

from sphinx import version_info

# Get suffix for proper linking to GitHub
# This is deprecated in Sphinx 1.3+,
# as each page can have its own suffix
if globals().get('source_suffix', False):
    if isinstance(source_suffix, string_types):
        SUFFIX = source_suffix
    else:
        SUFFIX = source_suffix[0]
else:
    SUFFIX = '.rst'

# Add RTD Static Path. Add to the end because it overwrites previous files.
if not 'html_static_path' in globals():
    html_static_path = []
if os.path.exists('_static'):
    html_static_path.append('_static')
html_static_path.append('/home/docs/checkouts/readthedocs.org/readthedocs/templates/sphinx/_static')

# Add RTD Theme only if they aren't overriding it already
using_rtd_theme = False
if 'html_theme' in globals():
    if html_theme in ['default']:
        # Allow people to bail with a hack of having an html_style
        if not 'html_style' in globals():
            import sphinx_rtd_theme
            html_theme = 'sphinx_rtd_theme'
            html_style = None
            html_theme_options = {}
            if 'html_theme_path' in globals():
                html_theme_path.append(sphinx_rtd_theme.get_html_theme_path())
            else:
                html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

            using_rtd_theme = True
else:
    import sphinx_rtd_theme
    html_theme = 'sphinx_rtd_theme'
    html_style = None
    html_theme_options = {}
    if 'html_theme_path' in globals():
        html_theme_path.append(sphinx_rtd_theme.get_html_theme_path())
    else:
        html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
    using_rtd_theme = True

if globals().get('websupport2_base_url', False):
    websupport2_base_url = 'https://readthedocs.org/websupport'
    if 'http' not in settings.MEDIA_URL:
        websupport2_static_url = 'https://media.readthedocs.org/static/'
    else:
        websupport2_static_url = 'https://media.readthedocs.org//static'


#Add project information to the template context.
context = {
    'using_theme': using_rtd_theme,
    'html_theme': html_theme,
    'current_version': "py3doc-enh-theme",
    'MEDIA_URL': "https://media.readthedocs.org/",
    'PRODUCTION_DOMAIN': "readthedocs.org",
    'versions': [
    ("latest", "/en/latest/"),
    ("traditional-theme", "/en/traditional-theme/"),
    ("rtd-theme", "/en/rtd-theme/"),
    ("pyramid-theme", "/en/pyramid-theme/"),
    ("py3doc-enh-theme", "/en/py3doc-enh-theme/"),
    ("nature-theme", "/en/nature-theme/"),
    ("jupyter-theme", "/en/jupyter-theme/"),
    ("julia-theme", "/en/julia-theme/"),
    ("haiku-theme", "/en/haiku-theme/"),
    ("guzzle-theme", "/en/guzzle-theme/"),
    ("dotted-theme", "/en/dotted-theme/"),
    ("conda-again", "/en/conda-again/"),
    ("cloud-theme", "/en/cloud-theme/"),
    ("classic-theme", "/en/classic-theme/"),
    ("bootstrap-theme", "/en/bootstrap-theme/"),
    ("bizstyle-theme", "/en/bizstyle-theme/"),
    ("better-theme", "/en/better-theme/"),
    ("basicstrap-theme", "/en/basicstrap-theme/"),
    ("alabaster-theme", "/en/alabaster-theme/"),
    ("agogo-theme", "/en/agogo-theme/"),
    ],
    'downloads': [ 
    ("pdf", "//readthedocs.org/projects/nbsphinx/downloads/pdf/py3doc-enh-theme/"),
    ("htmlzip", "//readthedocs.org/projects/nbsphinx/downloads/htmlzip/py3doc-enh-theme/"),
    ],
    'subprojects': [ 
    ],
    'slug': 'nbsphinx',
    'name': u'nbsphinx',
    'rtd_language': u'en',
    'canonical_url': 'http://nbsphinx.readthedocs.io/en/0.2.14/',
    'analytics_code': '',
    'single_version': False,
    'conf_py_path': '/doc/',
    'api_host': 'https://readthedocs.org',
    'github_user': 'astorfi',
    'github_repo': 'TensorFlow-World-Resources',
    'github_version': 'py3doc-enh-theme',
    'display_github': True,
    'bitbucket_user': 'None',
    'bitbucket_repo': 'None',
    'bitbucket_version': 'py3doc-enh-theme',
    'display_bitbucket': False,
    'READTHEDOCS': True,
    'using_theme': (html_theme == "default"),
    'new_theme': (html_theme == "sphinx_rtd_theme"),
    'source_suffix': SUFFIX,
    'user_analytics_code': '',
    'global_analytics_code': 'UA-17997319-1',
    
    'commit': 'e949221b',
    
}
if 'html_context' in globals():
    html_context.update(context)
else:
    html_context = context

# Add custom RTD extension
if 'extensions' in globals():
    extensions.append("readthedocs_ext.readthedocs")
else:
    extensions = ["readthedocs_ext.readthedocs"]


================================================
FILE: requirements.txt
================================================
python-coveralls
sphinx_rtd_theme