Skip to content

Commit 6d1cc2e

Browse files
committed
Fixed typos and grammatical errors
1 parent dbba95e commit 6d1cc2e

11 files changed

+31
-31
lines changed

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ Follow either of the two links above to access the appropriate CLA and instructi
8989
### Contributing code
9090

9191
If you have improvements to TensorFlow, send us your pull requests! For those
92-
just getting started, Github has a
93-
[how to](https://help.github.com/articles/using-pull-requests/).
92+
just getting started, GitHub has a
93+
[how-to](https://help.github.com/articles/using-pull-requests/).
9494

9595
TensorFlow team members will be assigned to review your pull requests. Once the
9696
pull requests are approved and pass continuous integration checks, a TensorFlow
@@ -101,7 +101,7 @@ automatically on GitHub.
101101

102102
If you want to contribute, start working through the TensorFlow codebase,
103103
navigate to the
104-
[Github "issues" tab](https://github.com/tensorflow/tensorflow/issues) and start
104+
[GitHub "issues" tab](https://github.com/tensorflow/tensorflow/issues) and start
105105
looking through interesting issues. If you are not sure of where to start, then
106106
start by trying one of the smaller/easier issues here i.e.
107107
[issues with the "good first issue" label](https://github.com/tensorflow/tensorflow/labels/good%20first%20issue)

ISSUES.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
If you open a GitHub Issue, here is our policy:
22

3-
1. It must be a bug/performance issue or a feature request or a build issue or
3+
1. It must be a bug/performance issue or a feature request or a build issue or
44
a documentation issue (for small doc fixes please send a PR instead).
5-
1. Make sure the Issue Template is filled out.
6-
1. The issue should be related to the repo it is created in.
5+
2. Make sure the Issue Template is filled out.
6+
3. The issue should be related to the repo it is created in.
77

88
**Here's why we have this policy:** We want to focus on the work that benefits
99
the whole community, e.g., fixing bugs and adding features. Individual support

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
[![TF Official Continuous](https://tensorflow.github.io/build/TF%20Official%20Continuous.svg)](https://tensorflow.github.io/build#TF%20Official%20Continuous)
1515
[![TF Official Nightly](https://tensorflow.github.io/build/TF%20Official%20Nightly.svg)](https://tensorflow.github.io/build#TF%20Official%20Nightly)
1616

17-
**`Documentation`** |
17+
**`Documentation`** |
1818
------------------- |
1919
[![Documentation](https://img.shields.io/badge/api-reference-blue.svg)](https://www.tensorflow.org/api_docs/) |
2020

@@ -114,7 +114,7 @@ apply fixes to bugs or security vulnerabilities:
114114

115115
* Clone the TensorFlow repo and switch to the corresponding branch for your
116116
desired TensorFlow version, for example, branch `r2.8` for version 2.8.
117-
* Apply (that is, cherry pick) the desired changes and resolve any code
117+
* Apply (that is, cherry-pick) the desired changes and resolve any code
118118
conflicts.
119119
* Run TensorFlow tests and ensure they pass.
120120
* [Build](https://www.tensorflow.org/install/source) the TensorFlow pip

RELEASE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@
9797
* Optimized this function for some cases by fusing internal operations.
9898

9999
* `tf.saved_model.SaveOptions`
100-
* Provided a new `experimental_skip_saver` argument which if specified,
100+
* Provided a new `experimental_skip_saver` argument which, if specified,
101101
will suppress the addition of `SavedModel`-native save and restore ops
102102
to the `SavedModel`, for cases where users already build custom
103103
save/restore ops and checkpoint formats for the model being saved, and

SECURITY.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ TensorFlow and how to report them.
88
This document applies to other repositories in the TensorFlow organization,
99
covering security practices for the entirety of the TensorFlow ecosystem.
1010

11-
## TensorFlow models are programs
11+
## TensorFlow's models are programs
1212

1313
TensorFlow
1414
[**models**](https://developers.google.com/machine-learning/glossary/#model) (to
1515
use a term commonly used by machine learning practitioners) are expressed as
16-
programs that TensorFlow executes. TensorFlow programs are encoded as
16+
programs that TensorFlow executes. TensorFlow's programs are encoded as
1717
computation
1818
[**graphs**](https://developers.google.com/machine-learning/glossary/#graph).
1919
The model's parameters are often stored separately in **checkpoints**.
@@ -31,7 +31,7 @@ The computation graph may also accept **inputs**. Those inputs are the
3131
data you supply to TensorFlow to train a model, or to use a model to run
3232
inference on the data.
3333

34-
**TensorFlow models are programs, and need to be treated as such from a security
34+
**TensorFlow's models are programs, and need to be treated as such from a security
3535
perspective.**
3636

3737
## Execution models of TensorFlow code
@@ -101,7 +101,7 @@ compare model quality for a fixed model architecture), you must carefully audit
101101
your model, and we recommend you run the TensorFlow process in a sandbox.
102102

103103
Similar considerations should apply if the model uses **custom ops** (C++ code
104-
written outside of the TensorFlow tree and loaded as plugins).
104+
written outside the TensorFlow tree and loaded as plugins).
105105

106106
## Accepting untrusted inputs
107107

tensorflow/python/autograph/g3doc/reference/common_errors.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ AutoGraph turned off.
8888
* placing a Tensor-dependent `break`, `continue` or `return` inside a Python
8989
loop (see example below)
9090
* attempting to use a `tf.Tensor` in a list comprehension, by iterating over
91-
it or using it in a condition)
91+
it or using it in a condition
9292

9393
A typical example of mixing Python and TF control flow in an incompatible way
9494
is:
@@ -156,7 +156,7 @@ exceptions, expect them to be wrapped by this exception.
156156
This error usually appears in the context of a conversion warning. It indicates
157157
that a lambda function could not be parsed (see [Limitations](limitations.md)).
158158

159-
This type of errors can usually be avoided by creating lambda functions in
159+
This type of error can usually be avoided by creating lambda functions in
160160
separate simple assignments, for example:
161161

162162
```

tensorflow/python/autograph/g3doc/reference/control_flow.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ In the example above, we've optimized away the conditional on a constant
4646
condition. The AutoGraph dispatch rules have the same effect: anything that is
4747
not a TensorFlow object is a compile-time constant for TensorFlow, and can be
4848
optimized away. For this reason, you can usually mix Python and TensorFlow
49-
computation and it will transparently have the expected result even
49+
computation, and it will transparently have the expected result even
5050
when only some computations are executed in the graph.
5151

5252
<!-- TODO(mdan): This is actually a limitation (a very subtle one) -->

tensorflow/python/autograph/g3doc/reference/error_handling.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ exception inside `tf.function`, you will obtain the original exception.
2424
The exception traceback still contains the entire call stack, including frames
2525
corresponding to generated code.
2626

27-
AutoGraph tries to re-raise an exception of the same type as the original
27+
AutoGraph tries to re-raise an exception to the same type as the original
2828
exception. This is usually possible for subclasses of
2929
`Exception` that do not define a custom `__init__`. For more complex
3030
exception types which define a custom constructor, AutoGraph raises a
@@ -144,7 +144,7 @@ refer to symbols used in your code.
144144

145145
### TensorFlow execution errors
146146

147-
TensorFlow execution errors are displayed normally, but the portions of the
147+
TensorFlow's execution errors are displayed normally, but the portions of the
148148
error message which correspond to user code contain references to the original
149149
code.
150150

tensorflow/python/autograph/g3doc/reference/functions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ are handled correctly.
4545
The following types of functions are not converted:
4646

4747
* functions already converted
48-
* functions defined in a allowlisted module (see autograph/core/config.py)
48+
* functions defined in an allowlisted module (see autograph/core/config.py)
4949
* non-Python functions (such as native bindings)
5050
* `print`, `pdb.set_trace`, `ipdb.set_trace`
5151
* most built-in functions (exceptions are listed in

tensorflow/python/autograph/g3doc/reference/limitations.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ tf.print(x) # Error -- x may be None here
4343
```
4444

4545
For this reason, AutoGraph forbids variables to be defined in only one branch
46-
of a TensorFlow conditional, if the variable is used afterwards:
46+
of a TensorFlow conditional, if the variable is used afterward:
4747

4848
```
4949
del x
@@ -172,7 +172,7 @@ The examples below use a `while` loop, but the same notions extend to all
172172
control flow such as `if` and `for` statements.
173173

174174
In the example below, `x` needs to become a loop variable of the
175-
corresponding `tf.while_loop':
175+
corresponding 'tf.while_loop':
176176

177177
```
178178
while x > 0:
@@ -343,7 +343,7 @@ recognizes.
343343

344344
AutoGraph assumes that variables that local functions close over may be used
345345
anywhere in the parent function, because in general it is possible to hide a
346-
function call in almost any Python statement). For this reason, these variables
346+
function call in almost any Python statement. For this reason, these variables
347347
are accounted within TensorFlow loops.
348348

349349
For example, the following code correctly captures `a` in the TensorFlow loop
@@ -358,7 +358,7 @@ for i in tf.range(3):
358358
f() # Prints 2
359359
```
360360

361-
An consequence is that these variables must be defined before the loop (see
361+
A consequence is that these variables must be defined before the loop (see
362362
Undefined and None values above). So the following code will raise an error,
363363
even if the variable is never used after the loop:
364364

@@ -462,7 +462,7 @@ for i in tf.range(10):
462462

463463
#### Python collections of fixed structure are allowed TensorFlow control flow
464464

465-
An exception from the previous rule is made by Python collections that are
465+
An exception to the previous rule is made by Python collections that are
466466
static, that is, they don't grow in size for the duration of the computation.
467467

468468
Caution: Use functional programming style when manipulating static collections.
@@ -503,7 +503,7 @@ for i in tf.range(10):
503503
d[key] += i # Problem -- accessing `dict` using non-constant key
504504
```
505505

506-
The code above will raises an "illegal capture" error. To remedy it, write it
506+
The code above will raise an "illegal capture" error. To remedy it, write it
507507
in functional programming style:
508508

509509
```
@@ -530,7 +530,7 @@ rank is dynamic.
530530

531531
TensorFlow has optional static types and shapes: the shape of tensors may be
532532
static (e.g. `my_tensor.shape=(3, 3)` denotes a three by three matrix) or
533-
dynamic (e.g. `my_tensor.shape=(None, 3)` denotes a matrix with a dynamic
533+
dynamic (e.g. `my_tensor.shape=(None, 3)`) denotes a matrix with a dynamic
534534
number of rows and three columns. When the shapes are dynamic, you can still
535535
query it at runtime by using the `tf.shape()` function.
536536

tensorflow/python/autograph/g3doc/reference/operators.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Generally, the dispatch follows these rules:
7070

7171
The first rule above means that if you convert normal, non-TensorFlow code with
7272
AutoGraph and call it with non-TensorFlow inputs, executing the generated code
73-
should be no different than executing the original.
73+
should be no different from executing the original.
7474

7575
### Functional form
7676

@@ -95,7 +95,7 @@ Args:
9595
cond: expression condition; same as `cond` in `_ if cond else _`.
9696
if_true: true value (as thunk); same as `lambda: x` in `x if _ else _`.
9797
if_false: false value (as thunk); same as `lambda: x` in `_ if _ else x`.
98-
expr_repr: human readable string representing `cond`. Used for error messages.
98+
expr_repr: human-readable string representing `cond`. Used for error messages.
9999

100100
Example:
101101

@@ -147,7 +147,7 @@ Args:
147147
<b>`.
148148
* get_state: returns the current value of the loop variables
149149
* set_state: sets new values into the loop variables
150-
* symbol_names: human readable string representing each loop variable. Used
150+
* symbol_names: human-readable string representing each loop variable. Used
151151
for error messages.
152152
* opts: additional, implementation-specific, keyword arguments.
153153

@@ -232,7 +232,7 @@ Args:
232232
<b>`.
233233
* get_state: returns the current value of the conditional variables
234234
* set_state: sets new values into the conditional variables
235-
* symbol_names: human readable string representing each conditional variable.
235+
* symbol_names: human-readable string representing each conditional variable.
236236
Used for error messages.
237237
* nouts: number of output conditional variables. Not all conditional variables
238238
are outputs - some are just inputs. The first nouts values in get_state and
@@ -280,7 +280,7 @@ Args:
280280
* body: loop body (as thunk); same as `def body(): <b>` in `while _: <b>`.
281281
* get_state: returns the current value of the loop variables
282282
* set_state: sets new values into the loop variables
283-
* symbol_names: human readable string representing each loop variable. Used
283+
* symbol_names: human-readable string representing each loop variable. Used
284284
for error messages.
285285
* opts: additional, implementation-specific, keyword arguments.
286286

0 commit comments

Comments
 (0)