Skip to content

Commit 438941b

Browse files
authored
DOC: Add updates to BUILD in contrib guidelines (#57)
* DOC: Add updates to BUILD in contrib guidelines
1 parent 4bf9c3d commit 438941b

File tree

5 files changed

+15
-9
lines changed

5 files changed

+15
-9
lines changed

tensorflow_addons/custom_ops/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,16 @@ 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
1616
standards (Layers, Losses, etc.)
17+
* Add the addon to the `py_library` in this sub-package's BUILD file
1718

1819
#### Testing Requirements
1920
* Simple unittests that demonstrate the custom op is behaving as
2021
expected.
2122
* When applicable, run all unittests with TensorFlow's
2223
`@run_all_in_graph_and_eager_modes` decorator.
24+
* Add a `py_test` to the custom-op's BUILD file
2325

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

tensorflow_addons/layers/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,16 @@ 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
1819

1920
#### Testing Requirements
2021
* Simple unittests that demonstrate the layer is behaving as expected.
2122
* When applicable, run all unittests with TensorFlow's
2223
`@run_all_in_graph_and_eager_modes` decorator.
2324
* Run `keras.testing_utils.layer_test` on the layer.
25+
* Add a `py_test` to this sub-package's BUILD file
2426

2527
#### Documentation Requirements
2628
* Update the table of contents in the project's central README
27-
* Update the table of contents in this sub-project's README
29+
* Update the table of contents in this sub-package's README
2830

tensorflow_addons/losses/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,16 @@ 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
1718

1819
#### Testing Requirements
1920
* Simple unittests that demonstrate the loss is behaving as expected on
2021
some set of known inputs and outputs.
2122
* When applicable, run all tests with TensorFlow's
2223
`@run_all_in_graph_and_eager_modes` decorator.
23-
24+
* Add a `py_test` to this sub-package's BUILD file
25+
2426
#### Documentation Requirements
2527
* Update the table of contents in the project's central README
26-
* Update the table of contents in this sub-project's README
28+
* Update the table of contents in this sub-package's README
2729

tensorflow_addons/optimizers/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,14 @@ 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
1617

1718
#### Testing Requirements
1819
* When applicable, run all tests with TensorFlow's
1920
`@run_all_in_graph_and_eager_modes` decorator
20-
21+
* Add a `py_test` to this sub-package's BUILD file
22+
2123
#### Documentation Requirements
2224
* Update the table of contents in the project's central README
23-
* Update the table of contents in this sub-project's README
25+
* Update the table of contents in this sub-packages's README
2426

tensorflow_addons/utils/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
11
# Addons Utils
2-
3-
## Standard API

0 commit comments

Comments
 (0)