Skip to content

Commit 6d70ad4

Browse files
facaiyseanpmorgan
authored andcommitted
DOC: minor fix for readme (#60)
* DOC: minor fix for readme
1 parent 5bc92f9 commit 6d70ad4

File tree

6 files changed

+21
-25
lines changed

6 files changed

+21
-25
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Want to contribute but not sure of what? Here are a few suggestions:
2121
these are a great way to familiarize yourself and others with TF-Addons.
2222
2. Solve an [existing issue](https://github.com/tensorflow/addons/issues).
2323
These range from low-level software bugs to higher-level design problems.
24-
Check out the label [help wanted](https://github.com/tensorflow/addons/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).
24+
Check out the label [help wanted](https://github.com/tensorflow/addons/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). If you're a new contributor, the label [good first issue](https://github.com/tensorflow/addons/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) can be a good place to start.
2525

2626
All submissions, including submissions by project members, require
2727
review.
@@ -86,4 +86,4 @@ your current agreements on file or to sign a new one.
8686

8787
You generally only need to submit a CLA once, so if you've already submitted one
8888
(even if it was for a different project), you probably don't need to do it
89-
again.
89+
again.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ developments that cannot be integrated into core TensorFlow
1212
## Contents
1313
| Sub-Package | Addon | Reference |
1414
|:----------------------- |:----------- |:---------------------------- |
15-
| addons.image | Transform | |
15+
| addons.image | transform | |
1616
| addons.layers | Maxout | https://arxiv.org/abs/1302.4389 |
1717
| addons.layers | PoinareNormalize | https://arxiv.org/abs/1705.08039 |
1818
| addons.layers | WeightNormalization | https://arxiv.org/abs/1602.07868 |

tensorflow_addons/custom_ops/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,16 @@
1313
In order to conform with the current API standard, all custom ops
1414
must:
1515
* Must be impossible to implement in one of the other API
16-
standards (Layers, Losses, etc.)
17-
* Add the addon to the `py_library` in this sub-package's BUILD file
16+
standards (Layers, Losses, etc.).
17+
* Add the addon to the `py_library` in this sub-package's BUILD file.
1818

1919
#### Testing Requirements
2020
* Simple unittests that demonstrate the custom op is behaving as
2121
expected.
2222
* When applicable, run all unittests with TensorFlow's
2323
`@run_all_in_graph_and_eager_modes` decorator.
24-
* Add a `py_test` to the custom-op's BUILD file
24+
* Add a `py_test` to the custom-op's BUILD file.
2525

2626
#### Documentation Requirements
27-
* Update the table of contents in the project's central README
28-
* Update the table of contents in this sub-packages's README
29-
27+
* Update the table of contents in the project's central README.
28+
* Update the table of contents in this sub-packages's README.

tensorflow_addons/layers/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,15 @@ must:
1515
* Inherit from either `keras.layers.Layer` or its subclasses.
1616
* [Register as a keras global object](https://github.com/tensorflow/addons/blob/master/tensorflow_addons/utils/python/keras_utils.py)
1717
so it can be serialized properly.
18-
* Add the addon to the `py_library` in this sub-package's README
18+
* Add the addon to the `py_library` in this sub-package's BUILD file.
1919

2020
#### Testing Requirements
2121
* Simple unittests that demonstrate the layer is behaving as expected.
2222
* When applicable, run all unittests with TensorFlow's
2323
`@run_all_in_graph_and_eager_modes` decorator.
2424
* Run `keras.testing_utils.layer_test` on the layer.
25-
* Add a `py_test` to this sub-package's BUILD file
25+
* Add a `py_test` to this sub-package's BUILD file.
2626

2727
#### Documentation Requirements
28-
* Update the table of contents in the project's central README
29-
* Update the table of contents in this sub-package's README
30-
28+
* Update the table of contents in the project's central README.
29+
* Update the table of contents in this sub-package's README.

tensorflow_addons/losses/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,15 @@ must:
1414
* Inherit from `keras.losses.LossFunctionWrapper`.
1515
* [Register as a keras global object](https://github.com/tensorflow/addons/blob/master/tensorflow_addons/utils/python/keras_utils.py)
1616
so it can be serialized properly.
17-
* Add the addon to the `py_library` in this sub-package's README
17+
* Add the addon to the `py_library` in this sub-package's BUILD file.
1818

1919
#### Testing Requirements
2020
* Simple unittests that demonstrate the loss is behaving as expected on
2121
some set of known inputs and outputs.
2222
* When applicable, run all tests with TensorFlow's
2323
`@run_all_in_graph_and_eager_modes` decorator.
24-
* Add a `py_test` to this sub-package's BUILD file
24+
* Add a `py_test` to this sub-package's BUILD file.
2525

2626
#### Documentation Requirements
27-
* Update the table of contents in the project's central README
28-
* Update the table of contents in this sub-package's README
29-
27+
* Update the table of contents in the project's central README.
28+
* Update the table of contents in this sub-package's README.

tensorflow_addons/optimizers/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,13 @@ must:
1313
* Inherit from either `keras.optimizer_v2.OptimizerV2` or its subclasses.
1414
* [Register as a keras global object](https://github.com/tensorflow/addons/blob/master/tensorflow_addons/utils/python/keras_utils.py)
1515
so it can be serialized properly.
16-
* Add the addon to the `py_library` in this sub-package's README
16+
* Add the addon to the `py_library` in this sub-package's BUILD file.
1717

1818
#### Testing Requirements
1919
* When applicable, run all tests with TensorFlow's
20-
`@run_all_in_graph_and_eager_modes` decorator
21-
* Add a `py_test` to this sub-package's BUILD file
20+
`@run_all_in_graph_and_eager_modes` decorator.
21+
* Add a `py_test` to this sub-package's BUILD file.
2222

2323
#### Documentation Requirements
24-
* Update the table of contents in the project's central README
25-
* Update the table of contents in this sub-packages's README
26-
24+
* Update the table of contents in the project's central README.
25+
* Update the table of contents in this sub-packages's README.

0 commit comments

Comments
 (0)