Skip to content

Commit 6af6b3b

Browse files
lambertatensorflower-gardener
authored andcommitted
Rename programmers_guide/ directory to guide/.
Update references in source files and docs in tensorflow and related projects. PiperOrigin-RevId: 201766994
1 parent 26f48b7 commit 6af6b3b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+110
-115
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ data flow graphs. The graph nodes represent mathematical operations, while
1414
the graph edges represent the multidimensional data arrays (tensors) that flow
1515
between them. This flexible architecture enables you to deploy computation to one
1616
or more CPUs or GPUs in a desktop, server, or mobile device without rewriting
17-
code. TensorFlow also includes [TensorBoard](https://www.tensorflow.org/programmers_guide/summaries_and_tensorboard), a data visualization toolkit.
17+
code. TensorFlow also includes [TensorBoard](https://www.tensorflow.org/guide/summaries_and_tensorboard), a data visualization toolkit.
1818

1919
TensorFlow was originally developed by researchers and engineers
2020
working on the Google Brain team within Google's Machine Intelligence Research

RELEASE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -465,7 +465,7 @@ answered questions, and were part of inspiring discussions.
465465

466466
## Major Features And Improvements
467467
* `tf.keras` is now part of the core TensorFlow API.
468-
* [`tf.data`](http://tensorflow.org/programmers_guide/datasets) is now part of
468+
* [`tf.data`](http://tensorflow.org/guide/datasets) is now part of
469469
the core TensorFlow API.
470470
* The API is now subject to backwards compatibility guarantees.
471471
* For a guide to migrating from the `tf.contrib.data` API, see the
@@ -485,7 +485,7 @@ answered questions, and were part of inspiring discussions.
485485
* TensorFlow Debugger (tfdbg):
486486
* Add `eval` command to allow evaluation of arbitrary Python/numpy expressions
487487
in tfdbg command-line interface. See
488-
[Debugging TensorFlow Programs](https://www.tensorflow.org/programmers_guide/debugger)
488+
[Debugging TensorFlow Programs](https://www.tensorflow.org/guide/debugger)
489489
for more details.
490490
* Usability improvement: The frequently used tensor filter `has_inf_or_nan` is
491491
now added to `Session` wrappers and hooks by default. So there is no need
@@ -772,7 +772,7 @@ answered questions, and were part of inspiring discussions.
772772
* Support client-provided ClusterSpec's and propagate them to all workers to enable the creation of dynamic TensorFlow clusters.
773773
* TensorFlow C library now available for Windows.
774774
* We released a new open-source version of TensorBoard.
775-
* [`SavedModel CLI`](https://www.tensorflow.org/versions/master/programmers_guide/saved_model_cli) tool available to inspect and execute MetaGraph in SavedModel
775+
* [`SavedModel CLI`](https://www.tensorflow.org/versions/master/guide/saved_model_cli) tool available to inspect and execute MetaGraph in SavedModel
776776
* Android releases of TensorFlow are now pushed to jcenter for easier
777777
integration into apps. See
778778
https://github.com/tensorflow/tensorflow/blob/master/tensorflow/contrib/android/README.md

tensorflow/contrib/autograph/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ IMPORTANT: AutoGraph is alpha software, and under active development. Expect rou
44

55
AutoGraph is a Python to TensorFlow compiler.
66

7-
With AutoGraph, you can write [Eager style](https://www.tensorflow.org/programmers_guide/eager) code in a concise manner, and run it as a TensorFlow graph. AutoGraph uses source code transformation and partial evaluation to generate Python code that builds an equivalent TensorFlow subgraph. The result is code that behaves like ops and can be freely combined with other TensorFlow ops.
7+
With AutoGraph, you can write [Eager style](https://www.tensorflow.org/guide/eager) code in a concise manner, and run it as a TensorFlow graph. AutoGraph uses source code transformation and partial evaluation to generate Python code that builds an equivalent TensorFlow subgraph. The result is code that behaves like ops and can be freely combined with other TensorFlow ops.
88

99
For example, this Python function:
1010

tensorflow/contrib/data/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
guarantees as `tf.data`, but we will provide deprecation advice in advance of
2121
removing existing functionality.
2222
23-
See the @{$datasets$Importing Data} Programmer's Guide for an overview.
23+
See @{$guide/datasets$Importing Data} for an overview.
2424
2525
@@Counter
2626
@@CheckpointInputPipelineHook

tensorflow/contrib/eager/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Installation instructions at https://www.tensorflow.org/install/
4444

4545
For an introduction to eager execution in TensorFlow, see:
4646

47-
- [User Guide](https://www.tensorflow.org/programmers_guide/eager) ([source](../../docs_src/programmers_guide/eager.md))
47+
- [User Guide](https://www.tensorflow.org/guide/eager) ([source](../../docs_src/guide/eager.md))
4848
- Notebook: [Basic Usage](python/examples/notebooks/1_basics.ipynb)
4949
- Notebook: [Gradients](python/examples/notebooks/2_gradients.ipynb)
5050
- Notebook: [Importing Data](python/examples/notebooks/3_datasets.ipynb)

tensorflow/contrib/eager/python/examples/notebooks/3_datasets.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"source": [
1010
"# Eager Execution Tutorial: Importing Data\n",
1111
"\n",
12-
"This notebook demonstrates the use of the [`tf.data.Dataset` API](https://www.tensorflow.org/programmers_guide/datasets) to build pipelines to feed data to your program. It covers:\n",
12+
"This notebook demonstrates the use of the [`tf.data.Dataset` API](https://www.tensorflow.org/guide/datasets) to build pipelines to feed data to your program. It covers:\n",
1313
"\n",
1414
"* Creating a `Dataset`.\n",
1515
"* Iteration over a `Dataset` with eager execution enabled.\n",
@@ -18,7 +18,7 @@
1818
"\n",
1919
"If you're familiar with TensorFlow graphs, the API for constructing the `Dataset` object remains exactly the same when eager execution is enabled, but the process of iterating over elements of the dataset is slightly simpler.\n",
2020
"You can use Python iteration over the `tf.data.Dataset` object and do not need to explicitly create an `tf.data.Iterator` object.\n",
21-
"As a result, the discussion on iterators in the [Programmer's Guide](https://www.tensorflow.org/programmers_guide/datasets) is not relevant when eager execution is enabled."
21+
"As a result, the discussion on iterators in the [TensorFlow Guide](https://www.tensorflow.org/guide/datasets) is not relevant when eager execution is enabled."
2222
]
2323
},
2424
{
@@ -63,7 +63,7 @@
6363
"source": [
6464
"# Step 1: Create a source `Dataset`\n",
6565
"\n",
66-
"Create a _source_ dataset using one of the factory functions like [`Dataset.from_tensors`](https://www.tensorflow.org/api_docs/python/tf/data/Dataset#from_tensors), [`Dataset.from_tensor_slices`](https://www.tensorflow.org/api_docs/python/tf/data/Dataset#from_tensor_slices) or using objects that read from files like [`TextLineDataset`](https://www.tensorflow.org/api_docs/python/tf/data/TextLineDataset) or [`TFRecordDataset`](https://www.tensorflow.org/api_docs/python/tf/data/TFRecordDataset). See the [Programmer's Guide](https://www.google.com/url?sa=D\u0026q=https%3A%2F%2Fwww.tensorflow.org%2Fprogrammers_guide%2Fdatasets%23reading_input_data) for more information."
66+
"Create a _source_ dataset using one of the factory functions like [`Dataset.from_tensors`](https://www.tensorflow.org/api_docs/python/tf/data/Dataset#from_tensors), [`Dataset.from_tensor_slices`](https://www.tensorflow.org/api_docs/python/tf/data/Dataset#from_tensor_slices) or using objects that read from files like [`TextLineDataset`](https://www.tensorflow.org/api_docs/python/tf/data/TextLineDataset) or [`TFRecordDataset`](https://www.tensorflow.org/api_docs/python/tf/data/TFRecordDataset). See the [TensorFlow Guide](https://www.tensorflow.org/guide/datasets#reading_input_data) for more information."
6767
]
6868
},
6969
{

tensorflow/contrib/eager/python/g3doc/guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Eager execution is a feature that makes TensorFlow execute operations
44
immediately: concrete values are returned, instead of creating a computational
55
graph that is executed later.
66

7-
A user guide is available: https://www.tensorflow.org/programmers_guide/eager
8-
([source file](../../../../docs_src/programmers_guide/eager.md))
7+
A user guide is available: https://www.tensorflow.org/guide/eager
8+
([source file](../../../../docs_src/guide/eager.md))
99

1010
We welcome feedback through [GitHub issues](https://github.com/tensorflow/tensorflow/labels/comp:eager).
1111

tensorflow/contrib/lite/toco/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Usage information is given in these documents:
1717
Once an application developer has a trained TensorFlow model, TOCO will accept
1818
that model and generate a TensorFlow Lite
1919
[FlatBuffer](https://google.github.io/flatbuffers/) file. TOCO currently supports
20-
[SavedModels](https://www.tensorflow.org/programmers_guide/saved_model#using_savedmodel_with_estimators)
20+
[SavedModels](https://www.tensorflow.org/guide/saved_model#using_savedmodel_with_estimators)
2121
and frozen graphs (models generated via
2222
[freeze_graph.py](https://github.com/tensorflow/tensorflow/blob/master/tensorflow/python/tools/freeze_graph.py)).
2323
The TensorFlow Lite FlatBuffer file can be shipped to client devices, generally

tensorflow/contrib/lite/toco/g3doc/cmdline_examples.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,19 +81,19 @@ tflite_convert \
8181
--saved_model_dir=/tmp/saved_model
8282
```
8383

84-
[SavedModel](https://www.tensorflow.org/programmers_guide/saved_model#using_savedmodel_with_estimators)
84+
[SavedModel](https://www.tensorflow.org/guide/saved_model#using_savedmodel_with_estimators)
8585
has fewer required flags than frozen graphs due to access to additional data
8686
contained within the SavedModel. The values for `--input_arrays` and
8787
`--output_arrays` are an aggregated, alphabetized list of the inputs and outputs
8888
in the [SignatureDefs](https://www.tensorflow.org/serving/signature_defs) within
8989
the
90-
[MetaGraphDef](https://www.tensorflow.org/programmers_guide/saved_model#apis_to_build_and_load_a_savedmodel)
90+
[MetaGraphDef](https://www.tensorflow.org/guide/saved_model#apis_to_build_and_load_a_savedmodel)
9191
specified by `--saved_model_tag_set`. As with the GraphDef, the value for
9292
`input_shapes` is automatically determined whenever possible.
9393

9494
There is currently no support for MetaGraphDefs without a SignatureDef or for
9595
MetaGraphDefs that use the [`assets/`
96-
directory](https://www.tensorflow.org/programmers_guide/saved_model#structure_of_a_savedmodel_directory).
96+
directory](https://www.tensorflow.org/guide/saved_model#structure_of_a_savedmodel_directory).
9797

9898
## Quantization
9999

tensorflow/contrib/tpu/python/tpu/tpu_estimator.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1136,7 +1136,7 @@ def _validate_input_pipeline(self):
11361136
err_msg = ('Input pipeline contains one or more QueueRunners. '
11371137
'It could be slow and not scalable. Please consider '
11381138
'converting your input pipeline to use `tf.data` instead (see '
1139-
'https://www.tensorflow.org/programmers_guide/datasets for '
1139+
'https://www.tensorflow.org/guide/datasets for '
11401140
'instructions.')
11411141
if _WRAP_INPUT_FN_INTO_WHILE_LOOP:
11421142
raise RuntimeError(err_msg)

tensorflow/core/protobuf/config.proto

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ message GPUOptions {
147147

148148
// Everything inside experimental is subject to change and is not subject
149149
// to API stability guarantees in
150-
// https://www.tensorflow.org/programmers_guide/version_compat.
150+
// https://www.tensorflow.org/guide/version_compat.
151151
Experimental experimental = 9;
152152
};
153153

@@ -381,7 +381,7 @@ message ConfigProto {
381381

382382
// Everything inside Experimental is subject to change and is not subject
383383
// to API stability guarantees in
384-
// https://www.tensorflow.org/programmers_guide/version_compat.
384+
// https://www.tensorflow.org/guide/version_compat.
385385
message Experimental {
386386
// Task name for group resolution.
387387
string collective_group_leader = 1;
@@ -426,7 +426,7 @@ message RunOptions {
426426

427427
// Everything inside Experimental is subject to change and is not subject
428428
// to API stability guarantees in
429-
// https://www.tensorflow.org/programmers_guide/version_compat.
429+
// https://www.tensorflow.org/guide/version_compat.
430430
message Experimental {
431431
// If non-zero, declares that this graph is going to use collective
432432
// ops and must synchronize step_ids with any other graph with this

tensorflow/docs_src/api_guides/python/client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
This library contains classes for launching graphs and executing operations.
55

6-
@{$programmers_guide/low_level_intro$This guide} has examples of how a graph
6+
@{$guide/low_level_intro$This guide} has examples of how a graph
77
is launched in a @{tf.Session}.
88

99
## Session management

tensorflow/docs_src/api_guides/python/input_dataset.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
[TOC]
33

44
@{tf.data.Dataset} allows you to build complex input pipelines. See the
5-
@{$datasets$programmer's guide} for an in-depth explanation of how to use this
6-
API.
5+
@{$guide/datasets} for an in-depth explanation of how to use this API.
76

87
## Reader classes
98

tensorflow/docs_src/api_guides/python/reading_data.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ There are four methods of getting data into a TensorFlow program:
1616

1717
## `tf.data` API
1818

19-
See the @{$datasets$programmer's guide} for an in-depth explanation of
20-
@{tf.data.Dataset}. The `tf.data` API enables you to extract and preprocess data
19+
See the @{$guide/datasets} for an in-depth explanation of @{tf.data.Dataset}.
20+
The `tf.data` API enables you to extract and preprocess data
2121
from different input/file formats, and apply transformations such as batching,
2222
shuffling, and mapping functions over the dataset. This is an improved version
2323
of the old input methods---feeding and `QueueRunner`---which are described
@@ -511,8 +511,8 @@ You can have the train and eval in the same graph in the same process, and share
511511
their trained variables or layers. See @{$variables$the shared variables tutorial}.
512512

513513
To support the single-graph approach
514-
@{$programmers_guide/datasets$`tf.data`} also supplies
515-
@{$programmers_guide/datasets#creating_an_iterator$advanced iterator types} that
514+
@{$guide/datasets$`tf.data`} also supplies
515+
@{$guide/datasets#creating_an_iterator$advanced iterator types} that
516516
that allow the user to change the input pipeline without rebuilding the graph or
517517
session.
518518

tensorflow/docs_src/deploy/distributed.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This document shows how to create a cluster of TensorFlow servers, and how to
44
distribute a computation graph across that cluster. We assume that you are
5-
familiar with the @{$programmers_guide/low_level_intro$basic concepts} of
5+
familiar with the @{$guide/low_level_intro$basic concepts} of
66
writing low level TensorFlow programs.
77

88
## Hello distributed TensorFlow!

tensorflow/docs_src/extend/architecture.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@ learning models and system-level optimizations.
77
This document describes the system architecture that makes this
88
combination of scale and flexibility possible. It assumes that you have basic familiarity
99
with TensorFlow programming concepts such as the computation graph, operations,
10-
and sessions. See @{$programmers_guide/low_level_intro$this document}
11-
for an introduction to these topics. Some familiarity
12-
with @{$distributed$distributed TensorFlow}
10+
and sessions. See @{$guide/low_level_intro$this document} for an introduction to
11+
these topics. Some familiarity with @{$distributed$distributed TensorFlow}
1312
will also be helpful.
1413

1514
This document is for developers who want to extend TensorFlow in some way not

tensorflow/docs_src/get_started/_index.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ landing_page:
7474
The high-level Keras API provides building blocks to create and
7575
train deep learning models. Start with these beginner-friendly
7676
notebook examples, then read the
77-
<a href="/programmers_guide/keras">TensorFlow Keras guide</a>.
77+
<a href="/guide/keras">TensorFlow Keras guide</a>.
7878
</p>
7979
<ol style="padding-left:20px;">
8080
<li><a href="/get_started/basic_classification">Basic classification</a></li>
@@ -85,7 +85,7 @@ landing_page:
8585
</ol>
8686
</div>
8787
<div class="devsite-landing-row-item-buttons" style="margin-top:0;">
88-
<a class="button button-primary tfo-button-primary" href="/programmers_guide/keras">Read the Keras guide</a>
88+
<a class="button button-primary tfo-button-primary" href="/guide/keras">Read the Keras guide</a>
8989
</div>
9090
</div>
9191
- classname: tfo-landing-row-item-code-block
@@ -123,7 +123,7 @@ landing_page:
123123
<div class="devsite-landing-row-item-description-content">
124124
<p>
125125
Eager execution provides an imperative, define-by-run interface for advanced operations. Write custom layers, forward passes, and training loops with auto‑differentiation. Start with
126-
these notebooks, then read the <a href="/programmers_guide/eager">eager execution guide</a>.
126+
these notebooks, then read the <a href="/guide/eager">eager execution guide</a>.
127127
</p>
128128
<ol style="padding-left:20px;">
129129
<li>
@@ -165,7 +165,7 @@ landing_page:
165165
</ol>
166166
</div>
167167
<div class="devsite-landing-row-item-buttons">
168-
<a class="button button-primary tfo-button-primary" href="/programmers_guide/eager">Read the eager execution guide</a>
168+
<a class="button button-primary tfo-button-primary" href="/guide/eager">Read the eager execution guide</a>
169169
</div>
170170
</div>
171171
- custom_html: >
@@ -177,7 +177,7 @@ landing_page:
177177
<p>
178178
Estimators can train large models on multiple machines in a
179179
production environment. Try the examples below and read the
180-
<a href="/programmers_guide/estimators">Estimators guide</a>.
180+
<a href="/guide/estimators">Estimators guide</a>.
181181
</p>
182182
<ol style="padding-left: 20px;">
183183
<li><a href="/tutorials/text_classification_with_tf_hub">How to build a simple text classifier with TF-Hub</a></li>
@@ -186,7 +186,7 @@ landing_page:
186186
</ol>
187187
</div>
188188
<div class="devsite-landing-row-item-buttons">
189-
<a class="button button-primary tfo-button-primary" href="/programmers_guide/estimators">Read the Estimators guide</a>
189+
<a class="button button-primary tfo-button-primary" href="/guide/estimators">Read the Estimators guide</a>
190190
</div>
191191
</div>
192192

tensorflow/docs_src/get_started/next_steps.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
## Learn more about TensorFlow
44

5-
* The [TensorFlow Guide](/programmers_guide) includes usage guides for the
5+
* The [TensorFlow Guide](/guide) includes usage guides for the
66
high-level APIs, as well as advanced TensorFlow operations.
7-
* [Premade Estimators](/programmers_guide/premade_estimators) are designed to
7+
* [Premade Estimators](/guide/premade_estimators) are designed to
88
get results out of the box. Use TensorFlow without building your own models.
99
* [TensorFlow.js](https://js.tensorflow.org/) allows web developers to train and
1010
deploy ML models in the browser and using Node.js.

tensorflow/docs_src/programmers_guide/checkpoints.md renamed to tensorflow/docs_src/guide/checkpoints.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,8 @@ Estimators. TensorFlow provides two model formats:
88
* SavedModel, which is a format independent of the code that created
99
the model.
1010

11-
This document focuses on checkpoints. For details on SavedModel, see the
12-
@{$saved_model$Saving and Restoring} chapter of the
13-
*TensorFlow Programmer's Guide*.
11+
This document focuses on checkpoints. For details on `SavedModel`, see the
12+
@{$saved_model$Saving and Restoring} guide.
1413

1514

1615
## Sample code
@@ -232,8 +231,7 @@ This separation will keep your checkpoints recoverable.
232231
Checkpoints provide an easy automatic mechanism for saving and restoring
233232
models created by Estimators.
234233

235-
See the @{$saved_model$Saving and Restoring}
236-
chapter of the *TensorFlow Programmer's Guide* for details on:
234+
See the @{$saved_model$Saving and Restoring} guide for details about:
237235

238236
* Saving and restoring models using low-level TensorFlow APIs.
239237
* Exporting and importing models in the SavedModel format, which is a

tensorflow/docs_src/programmers_guide/datasets_for_estimators.md renamed to tensorflow/docs_src/guide/datasets_for_estimators.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ print(mnist_ds)
9191
```
9292

9393
This will print the following line, showing the
94-
@{$programmers_guide/tensors#shapes$shapes} and
95-
@{$programmers_guide/tensors#data_types$types} of the items in
94+
@{$guide/tensors#shapes$shapes} and
95+
@{$guide/tensors#data_types$types} of the items in
9696
the dataset. Note that a `Dataset` does not know how many items it contains.
9797

9898
``` None
@@ -128,7 +128,7 @@ print(dataset)
128128

129129
Here we see that when a `Dataset` contains structured elements, the `shapes`
130130
and `types` of the `Dataset` take on the same structure. This dataset contains
131-
dictionaries of @{$programmers_guide/tensors#rank$scalars}, all of type
131+
dictionaries of @{$guide/tensors#rank$scalars}, all of type
132132
`tf.float64`.
133133

134134
The first line of the iris `train_input_fn` uses the same functionality, but
@@ -382,6 +382,6 @@ Estimator. Consider the following documents next:
382382
* The @{$low_level_intro#datasets$Low Level Introduction}, which demonstrates
383383
how to experiment directly with `tf.data.Datasets` using TensorFlow's low
384384
level APIs.
385-
* @{$programmers_guide/datasets} which goes into great detail about additional
385+
* @{$guide/datasets} which goes into great detail about additional
386386
functionality of `Datasets`.
387387

0 commit comments

Comments
 (0)