Skip to content

Commit 468ecff

Browse files
author
Vijay Vasudevan
committed
TensorFlow: Update documentation to address quirks, add whitepaper link,
and add tentative Dockerfile for GPU. Change install instructions to also suggest upgrading six for Mac. Base CL: 107379398
1 parent d6357a5 commit 468ecff

File tree

20 files changed

+270
-214
lines changed

20 files changed

+270
-214
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,3 +75,4 @@ Hello, TensorFlow!
7575
##For more information
7676

7777
* [TensorFlow website](http://tensorflow.org)
78+
* [TensorFlow whitepaper](http://download.tensorflow.org/paper/whitepaper2015.pdf)

tensorflow/g3doc/api_docs/python/client.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,27 @@
55
## Contents
66
### [Running Graphs](#AUTOGENERATED-running-graphs)
77
* [Session management](#AUTOGENERATED-session-management)
8-
* [class tf.Session](#Session)
9-
* [class tf.InteractiveSession](#InteractiveSession)
8+
* [`class tf.Session`](#Session)
9+
* [`class tf.InteractiveSession`](#InteractiveSession)
1010
* [`tf.get_default_session()`](#get_default_session)
1111
* [Error classes](#AUTOGENERATED-error-classes)
12-
* [class tf.OpError](#OpError)
13-
* [class tf.errors.CancelledError](#CancelledError)
14-
* [class tf.errors.UnknownError](#UnknownError)
15-
* [class tf.errors.InvalidArgumentError](#InvalidArgumentError)
16-
* [class tf.errors.DeadlineExceededError](#DeadlineExceededError)
17-
* [class tf.errors.NotFoundError](#NotFoundError)
18-
* [class tf.errors.AlreadyExistsError](#AlreadyExistsError)
19-
* [class tf.errors.PermissionDeniedError](#PermissionDeniedError)
20-
* [class tf.errors.UnauthenticatedError](#UnauthenticatedError)
21-
* [class tf.errors.ResourceExhaustedError](#ResourceExhaustedError)
22-
* [class tf.errors.FailedPreconditionError](#FailedPreconditionError)
23-
* [class tf.errors.AbortedError](#AbortedError)
24-
* [class tf.errors.OutOfRangeError](#OutOfRangeError)
25-
* [class tf.errors.UnimplementedError](#UnimplementedError)
26-
* [class tf.errors.InternalError](#InternalError)
27-
* [class tf.errors.UnavailableError](#UnavailableError)
28-
* [class tf.errors.DataLossError](#DataLossError)
12+
* [`class tf.OpError`](#OpError)
13+
* [`class tf.errors.CancelledError`](#CancelledError)
14+
* [`class tf.errors.UnknownError`](#UnknownError)
15+
* [`class tf.errors.InvalidArgumentError`](#InvalidArgumentError)
16+
* [`class tf.errors.DeadlineExceededError`](#DeadlineExceededError)
17+
* [`class tf.errors.NotFoundError`](#NotFoundError)
18+
* [`class tf.errors.AlreadyExistsError`](#AlreadyExistsError)
19+
* [`class tf.errors.PermissionDeniedError`](#PermissionDeniedError)
20+
* [`class tf.errors.UnauthenticatedError`](#UnauthenticatedError)
21+
* [`class tf.errors.ResourceExhaustedError`](#ResourceExhaustedError)
22+
* [`class tf.errors.FailedPreconditionError`](#FailedPreconditionError)
23+
* [`class tf.errors.AbortedError`](#AbortedError)
24+
* [`class tf.errors.OutOfRangeError`](#OutOfRangeError)
25+
* [`class tf.errors.UnimplementedError`](#UnimplementedError)
26+
* [`class tf.errors.InternalError`](#InternalError)
27+
* [`class tf.errors.UnavailableError`](#UnavailableError)
28+
* [`class tf.errors.DataLossError`](#DataLossError)
2929

3030

3131
<!-- 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).
3939

4040
- - -
4141

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

4444
A class for running TensorFlow operations.
4545

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

263263
- - -
264264

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

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

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

358358
- - -
359359

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

362362
A generic error that is raised when TensorFlow execution fails.
363363

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

420420
- - -
421421

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

424424
Raised when an operation or step is cancelled.
425425

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

442442
- - -
443443

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

446446
Unknown error.
447447

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

462462
- - -
463463

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

466466
Raised when an operation receives an invalid argument.
467467

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

484484
- - -
485485

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

488488
Raised when a deadline expires before an operation could complete.
489489

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

500500
- - -
501501

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

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

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

519519
- - -
520520

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

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

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

538538
- - -
539539

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

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

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

557557
- - -
558558

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

561561
The request does not have valid authentication credentials.
562562

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

573573
- - -
574574

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

577577
Some resource has been exhausted.
578578

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

590590
- - -
591591

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

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

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

608608
- - -
609609

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

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

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

628628
- - -
629629

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

632632
Raised when an operation executed past the valid range.
633633

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

648648
- - -
649649

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

652652
Raised when an operation has not been implemented.
653653

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

668668
- - -
669669

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

672672
Raised when the system experiences an internal error.
673673

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

685685
- - -
686686

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

689689
Raised when the runtime is currently unavailable.
690690

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

701701
- - -
702702

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

705705
Raised when unrecoverable data loss or corruption is encountered.
706706

tensorflow/g3doc/api_docs/python/framework.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
## Contents
66
### [Building Graphs](#AUTOGENERATED-building-graphs)
77
* [Core graph data structures](#AUTOGENERATED-core-graph-data-structures)
8-
* [class tf.Graph](#Graph)
9-
* [class tf.Operation](#Operation)
10-
* [class tf.Tensor](#Tensor)
8+
* [`class tf.Graph`](#Graph)
9+
* [`class tf.Operation`](#Operation)
10+
* [`class tf.Tensor`](#Tensor)
1111
* [Tensor types](#AUTOGENERATED-tensor-types)
12-
* [class tf.DType](#DType)
12+
* [`class tf.DType`](#DType)
1313
* [`tf.as_dtype(type_value)`](#as_dtype)
1414
* [Utility functions](#AUTOGENERATED-utility-functions)
1515
* [`tf.device(dev)`](#device)
@@ -21,13 +21,13 @@
2121
* [Graph collections](#AUTOGENERATED-graph-collections)
2222
* [`tf.add_to_collection(name, value)`](#add_to_collection)
2323
* [`tf.get_collection(key, scope=None)`](#get_collection)
24-
* [class tf.GraphKeys](#GraphKeys)
24+
* [`class tf.GraphKeys`](#GraphKeys)
2525
* [Defining new operations](#AUTOGENERATED-defining-new-operations)
26-
* [class tf.RegisterGradient](#RegisterGradient)
26+
* [`class tf.RegisterGradient`](#RegisterGradient)
2727
* [`tf.NoGradient(op_type)`](#NoGradient)
28-
* [class tf.RegisterShape](#RegisterShape)
29-
* [class tf.TensorShape](#TensorShape)
30-
* [class tf.Dimension](#Dimension)
28+
* [`class tf.RegisterShape`](#RegisterShape)
29+
* [`class tf.TensorShape`](#TensorShape)
30+
* [`class tf.Dimension`](#Dimension)
3131
* [`tf.op_scope(values, name, default_name)`](#op_scope)
3232
* [`tf.get_seed(op_seed)`](#get_seed)
3333

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

4141
- - -
4242

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

4545
A TensorFlow computation, represented as a dataflow graph.
4646

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

658658
- - -
659659

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

662662
Represents a graph node that performs computation on tensors.
663663

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

870870
- - -
871871

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

874874
Represents a value produced by an `Operation`.
875875

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

11001100
- - -
11011101

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

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

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

15051505
- - -
15061506

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

15091509
Standard names to use for graph collections.
15101510

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

15401540
- - -
15411541

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

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

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

16071607
- - -
16081608

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

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

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

16391639
- - -
16401640

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

16431643
Represents the shape of a `Tensor`.
16441644

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

19491949
- - -
19501950

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

19531953
Represents the value of one dimension in a TensorShape.
19541954
- - -

0 commit comments

Comments
 (0)