Skip to content

Commit

Permalink
TensorFlow: Update documentation to address quirks, add whitepaper link,
Browse files Browse the repository at this point in the history
and add tentative Dockerfile for GPU.  Change install instructions
to also suggest upgrading six for Mac.

Base CL: 107379398
  • Loading branch information
Vijay Vasudevan committed Nov 9, 2015
1 parent d6357a5 commit 468ecff
Showing 20 changed files with 270 additions and 214 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -75,3 +75,4 @@ Hello, TensorFlow!
##For more information

* [TensorFlow website](http://tensorflow.org)
* [TensorFlow whitepaper](http://download.tensorflow.org/paper/whitepaper2015.pdf)
76 changes: 38 additions & 38 deletions tensorflow/g3doc/api_docs/python/client.md
Original file line number Diff line number Diff line change
@@ -5,27 +5,27 @@
## Contents
### [Running Graphs](#AUTOGENERATED-running-graphs)
* [Session management](#AUTOGENERATED-session-management)
* [class tf.Session](#Session)
* [class tf.InteractiveSession](#InteractiveSession)
* [`class tf.Session`](#Session)
* [`class tf.InteractiveSession`](#InteractiveSession)
* [`tf.get_default_session()`](#get_default_session)
* [Error classes](#AUTOGENERATED-error-classes)
* [class tf.OpError](#OpError)
* [class tf.errors.CancelledError](#CancelledError)
* [class tf.errors.UnknownError](#UnknownError)
* [class tf.errors.InvalidArgumentError](#InvalidArgumentError)
* [class tf.errors.DeadlineExceededError](#DeadlineExceededError)
* [class tf.errors.NotFoundError](#NotFoundError)
* [class tf.errors.AlreadyExistsError](#AlreadyExistsError)
* [class tf.errors.PermissionDeniedError](#PermissionDeniedError)
* [class tf.errors.UnauthenticatedError](#UnauthenticatedError)
* [class tf.errors.ResourceExhaustedError](#ResourceExhaustedError)
* [class tf.errors.FailedPreconditionError](#FailedPreconditionError)
* [class tf.errors.AbortedError](#AbortedError)
* [class tf.errors.OutOfRangeError](#OutOfRangeError)
* [class tf.errors.UnimplementedError](#UnimplementedError)
* [class tf.errors.InternalError](#InternalError)
* [class tf.errors.UnavailableError](#UnavailableError)
* [class tf.errors.DataLossError](#DataLossError)
* [`class tf.OpError`](#OpError)
* [`class tf.errors.CancelledError`](#CancelledError)
* [`class tf.errors.UnknownError`](#UnknownError)
* [`class tf.errors.InvalidArgumentError`](#InvalidArgumentError)
* [`class tf.errors.DeadlineExceededError`](#DeadlineExceededError)
* [`class tf.errors.NotFoundError`](#NotFoundError)
* [`class tf.errors.AlreadyExistsError`](#AlreadyExistsError)
* [`class tf.errors.PermissionDeniedError`](#PermissionDeniedError)
* [`class tf.errors.UnauthenticatedError`](#UnauthenticatedError)
* [`class tf.errors.ResourceExhaustedError`](#ResourceExhaustedError)
* [`class tf.errors.FailedPreconditionError`](#FailedPreconditionError)
* [`class tf.errors.AbortedError`](#AbortedError)
* [`class tf.errors.OutOfRangeError`](#OutOfRangeError)
* [`class tf.errors.UnimplementedError`](#UnimplementedError)
* [`class tf.errors.InternalError`](#InternalError)
* [`class tf.errors.UnavailableError`](#UnavailableError)
* [`class tf.errors.DataLossError`](#DataLossError)


<!-- TOC-END This section was generated by neural network, THANKS FOR READING! -->
@@ -39,7 +39,7 @@ examples of how a graph is launched in a [`tf.Session`](#Session).

- - -

### class tf.Session <a class="md-anchor" id="Session"></a>
### `class tf.Session` <a class="md-anchor" id="Session"></a>

A class for running TensorFlow operations.

@@ -262,7 +262,7 @@ thread's function.

- - -

### class tf.InteractiveSession <a class="md-anchor" id="InteractiveSession"></a>
### `class tf.InteractiveSession` <a class="md-anchor" id="InteractiveSession"></a>

A TensorFlow `Session` for use in interactive contexts, such as a shell.

@@ -357,7 +357,7 @@ thread's function.

- - -

### class tf.OpError <a class="md-anchor" id="OpError"></a>
### `class tf.OpError` <a class="md-anchor" id="OpError"></a>

A generic error that is raised when TensorFlow execution fails.

@@ -419,7 +419,7 @@ The error message that describes the error.

- - -

### class tf.errors.CancelledError <a class="md-anchor" id="CancelledError"></a>
### `class tf.errors.CancelledError` <a class="md-anchor" id="CancelledError"></a>

Raised when an operation or step is cancelled.

@@ -441,7 +441,7 @@ Creates a `CancelledError`.

- - -

### class tf.errors.UnknownError <a class="md-anchor" id="UnknownError"></a>
### `class tf.errors.UnknownError` <a class="md-anchor" id="UnknownError"></a>

Unknown error.

@@ -461,7 +461,7 @@ Creates an `UnknownError`.

- - -

### class tf.errors.InvalidArgumentError <a class="md-anchor" id="InvalidArgumentError"></a>
### `class tf.errors.InvalidArgumentError` <a class="md-anchor" id="InvalidArgumentError"></a>

Raised when an operation receives an invalid argument.

@@ -483,7 +483,7 @@ Creates an `InvalidArgumentError`.

- - -

### class tf.errors.DeadlineExceededError <a class="md-anchor" id="DeadlineExceededError"></a>
### `class tf.errors.DeadlineExceededError` <a class="md-anchor" id="DeadlineExceededError"></a>

Raised when a deadline expires before an operation could complete.

@@ -499,7 +499,7 @@ Creates a `DeadlineExceededError`.

- - -

### class tf.errors.NotFoundError <a class="md-anchor" id="NotFoundError"></a>
### `class tf.errors.NotFoundError` <a class="md-anchor" id="NotFoundError"></a>

Raised when a requested entity (e.g., a file or directory) was not found.

@@ -518,7 +518,7 @@ Creates a `NotFoundError`.

- - -

### class tf.errors.AlreadyExistsError <a class="md-anchor" id="AlreadyExistsError"></a>
### `class tf.errors.AlreadyExistsError` <a class="md-anchor" id="AlreadyExistsError"></a>

Raised when an entity that we attempted to create already exists.

@@ -537,7 +537,7 @@ Creates an `AlreadyExistsError`.

- - -

### class tf.errors.PermissionDeniedError <a class="md-anchor" id="PermissionDeniedError"></a>
### `class tf.errors.PermissionDeniedError` <a class="md-anchor" id="PermissionDeniedError"></a>

Raised when the caller does not have permission to run an operation.

@@ -556,7 +556,7 @@ Creates a `PermissionDeniedError`.

- - -

### class tf.errors.UnauthenticatedError <a class="md-anchor" id="UnauthenticatedError"></a>
### `class tf.errors.UnauthenticatedError` <a class="md-anchor" id="UnauthenticatedError"></a>

The request does not have valid authentication credentials.

@@ -572,7 +572,7 @@ Creates an `UnauthenticatedError`.

- - -

### class tf.errors.ResourceExhaustedError <a class="md-anchor" id="ResourceExhaustedError"></a>
### `class tf.errors.ResourceExhaustedError` <a class="md-anchor" id="ResourceExhaustedError"></a>

Some resource has been exhausted.

@@ -589,7 +589,7 @@ Creates a `ResourceExhaustedError`.

- - -

### class tf.errors.FailedPreconditionError <a class="md-anchor" id="FailedPreconditionError"></a>
### `class tf.errors.FailedPreconditionError` <a class="md-anchor" id="FailedPreconditionError"></a>

Operation was rejected because the system is not in a state to execute it.

@@ -607,7 +607,7 @@ Creates a `FailedPreconditionError`.

- - -

### class tf.errors.AbortedError <a class="md-anchor" id="AbortedError"></a>
### `class tf.errors.AbortedError` <a class="md-anchor" id="AbortedError"></a>

The operation was aborted, typically due to a concurrent action.

@@ -627,7 +627,7 @@ Creates an `AbortedError`.

- - -

### class tf.errors.OutOfRangeError <a class="md-anchor" id="OutOfRangeError"></a>
### `class tf.errors.OutOfRangeError` <a class="md-anchor" id="OutOfRangeError"></a>

Raised when an operation executed past the valid range.

@@ -647,7 +647,7 @@ Creates an `OutOfRangeError`.

- - -

### class tf.errors.UnimplementedError <a class="md-anchor" id="UnimplementedError"></a>
### `class tf.errors.UnimplementedError` <a class="md-anchor" id="UnimplementedError"></a>

Raised when an operation has not been implemented.

@@ -667,7 +667,7 @@ Creates an `UnimplementedError`.

- - -

### class tf.errors.InternalError <a class="md-anchor" id="InternalError"></a>
### `class tf.errors.InternalError` <a class="md-anchor" id="InternalError"></a>

Raised when the system experiences an internal error.

@@ -684,7 +684,7 @@ Creates an `InternalError`.

- - -

### class tf.errors.UnavailableError <a class="md-anchor" id="UnavailableError"></a>
### `class tf.errors.UnavailableError` <a class="md-anchor" id="UnavailableError"></a>

Raised when the runtime is currently unavailable.

@@ -700,7 +700,7 @@ Creates an `UnavailableError`.

- - -

### class tf.errors.DataLossError <a class="md-anchor" id="DataLossError"></a>
### `class tf.errors.DataLossError` <a class="md-anchor" id="DataLossError"></a>

Raised when unrecoverable data loss or corruption is encountered.

36 changes: 18 additions & 18 deletions tensorflow/g3doc/api_docs/python/framework.md
Original file line number Diff line number Diff line change
@@ -5,11 +5,11 @@
## Contents
### [Building Graphs](#AUTOGENERATED-building-graphs)
* [Core graph data structures](#AUTOGENERATED-core-graph-data-structures)
* [class tf.Graph](#Graph)
* [class tf.Operation](#Operation)
* [class tf.Tensor](#Tensor)
* [`class tf.Graph`](#Graph)
* [`class tf.Operation`](#Operation)
* [`class tf.Tensor`](#Tensor)
* [Tensor types](#AUTOGENERATED-tensor-types)
* [class tf.DType](#DType)
* [`class tf.DType`](#DType)
* [`tf.as_dtype(type_value)`](#as_dtype)
* [Utility functions](#AUTOGENERATED-utility-functions)
* [`tf.device(dev)`](#device)
@@ -21,13 +21,13 @@
* [Graph collections](#AUTOGENERATED-graph-collections)
* [`tf.add_to_collection(name, value)`](#add_to_collection)
* [`tf.get_collection(key, scope=None)`](#get_collection)
* [class tf.GraphKeys](#GraphKeys)
* [`class tf.GraphKeys`](#GraphKeys)
* [Defining new operations](#AUTOGENERATED-defining-new-operations)
* [class tf.RegisterGradient](#RegisterGradient)
* [`class tf.RegisterGradient`](#RegisterGradient)
* [`tf.NoGradient(op_type)`](#NoGradient)
* [class tf.RegisterShape](#RegisterShape)
* [class tf.TensorShape](#TensorShape)
* [class tf.Dimension](#Dimension)
* [`class tf.RegisterShape`](#RegisterShape)
* [`class tf.TensorShape`](#TensorShape)
* [`class tf.Dimension`](#Dimension)
* [`tf.op_scope(values, name, default_name)`](#op_scope)
* [`tf.get_seed(op_seed)`](#get_seed)

@@ -40,7 +40,7 @@ Classes and functions for building TensorFlow graphs.

- - -

### class tf.Graph <a class="md-anchor" id="Graph"></a>
### `class tf.Graph` <a class="md-anchor" id="Graph"></a>

A TensorFlow computation, represented as a dataflow graph.

@@ -657,7 +657,7 @@ with tf.Graph().as_default() as g:

- - -

### class tf.Operation <a class="md-anchor" id="Operation"></a>
### `class tf.Operation` <a class="md-anchor" id="Operation"></a>

Represents a graph node that performs computation on tensors.

@@ -869,7 +869,7 @@ DEPRECATED: Use outputs.

- - -

### class tf.Tensor <a class="md-anchor" id="Tensor"></a>
### `class tf.Tensor` <a class="md-anchor" id="Tensor"></a>

Represents a value produced by an `Operation`.

@@ -1099,7 +1099,7 @@ The name of the device on which this tensor will be produced, or None.

- - -

### class tf.DType <a class="md-anchor" id="DType"></a>
### `class tf.DType` <a class="md-anchor" id="DType"></a>

Represents the type of the elements in a `Tensor`.

@@ -1504,7 +1504,7 @@ for more details.

- - -

### class tf.GraphKeys <a class="md-anchor" id="GraphKeys"></a>
### `class tf.GraphKeys` <a class="md-anchor" id="GraphKeys"></a>

Standard names to use for graph collections.

@@ -1539,7 +1539,7 @@ The following standard keys are defined:

- - -

### class tf.RegisterGradient <a class="md-anchor" id="RegisterGradient"></a>
### `class tf.RegisterGradient` <a class="md-anchor" id="RegisterGradient"></a>

A decorator for registering the gradient function for an op type.

@@ -1606,7 +1606,7 @@ tf.NoGradient("Size")

- - -

### class tf.RegisterShape <a class="md-anchor" id="RegisterShape"></a>
### `class tf.RegisterShape` <a class="md-anchor" id="RegisterShape"></a>

A decorator for registering the shape function for an op type.

@@ -1638,7 +1638,7 @@ Saves the "op_type" as the Operation type.

- - -

### class tf.TensorShape <a class="md-anchor" id="TensorShape"></a>
### `class tf.TensorShape` <a class="md-anchor" id="TensorShape"></a>

Represents the shape of a `Tensor`.

@@ -1948,7 +1948,7 @@ Returns the total number of elements, or none for incomplete shapes.

- - -

### class tf.Dimension <a class="md-anchor" id="Dimension"></a>
### `class tf.Dimension` <a class="md-anchor" id="Dimension"></a>

Represents the value of one dimension in a TensorShape.
- - -
Loading
Oops, something went wrong.

0 comments on commit 468ecff

Please sign in to comment.