Skip to content

Commit

Permalink
Updated the README files concerning testing. (#1344)
Browse files Browse the repository at this point in the history
  • Loading branch information
gabrieldemarmiesse authored Mar 20, 2020
1 parent 2125961 commit 5568ea8
Show file tree
Hide file tree
Showing 10 changed files with 40 additions and 39 deletions.
8 changes: 4 additions & 4 deletions tensorflow_addons/activations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ must:

#### Testing Requirements
* Simple unittests that demonstrate the layer is behaving as expected.
* When applicable, run all unittests with TensorFlow's
`@run_in_graph_and_eager_modes` (for test method)
or `run_all_in_graph_and_eager_modes` (for TestCase subclass)
decorator.
* To run your `tf.functions` in eager mode and graph mode in the tests,
you can use the `@pytest.mark.usefixtures("maybe_run_functions_eagerly")`
decorator. This will run the tests twice, once normally, and once
with `tf.config.experimental_run_functions_eagerly(True)`.
* Add a `py_test` to this sub-package's BUILD file.
* Add activation name to [activations_test.py](https://github.com/tensorflow/addons/tree/master/tensorflow_addons/activations/activations_test.py) to test serialization.

Expand Down
8 changes: 4 additions & 4 deletions tensorflow_addons/callbacks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ must:

#### Testing Requirements
* Simple unittests that demonstrate the callback is behaving as expected.
* When applicable, run all unittests with TensorFlow's
`@run_in_graph_and_eager_modes` (for test method)
or `run_all_in_graph_and_eager_modes` (for TestCase subclass)
decorator.
* To run your `tf.functions` in eager mode and graph mode in the tests,
you can use the `@pytest.mark.usefixtures("maybe_run_functions_eagerly")`
decorator. This will run the tests twice, once normally, and once
with `tf.config.experimental_run_functions_eagerly(True)`.
* Add a `py_test` to this sub-package's BUILD file.

#### Documentation Requirements
Expand Down
8 changes: 4 additions & 4 deletions tensorflow_addons/image/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ must:
#### Testing Requirements
* Simple unittests that demonstrate the image op is behaving as
expected.
* When applicable, run all unittests with TensorFlow's
`@run_in_graph_and_eager_modes` (for test method)
or `run_all_in_graph_and_eager_modes` (for TestCase subclass)
decorator.
* To run your `tf.functions` in eager mode and graph mode in the tests,
you can use the `@pytest.mark.usefixtures("maybe_run_functions_eagerly")`
decorator. This will run the tests twice, once normally, and once
with `tf.config.experimental_run_functions_eagerly(True)`.
* Add a `py_test` to this sub-package's BUILD file.

#### Documentation Requirements
Expand Down
8 changes: 4 additions & 4 deletions tensorflow_addons/layers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ must:

#### Testing Requirements
* Simple unittests that demonstrate the layer is behaving as expected.
* When applicable, run all unittests with TensorFlow's
`@run_in_graph_and_eager_modes` (for test method)
or `run_all_in_graph_and_eager_modes` (for TestCase subclass)
decorator.
* To run your `tf.functions` in eager mode and graph mode in the tests,
you can use the `@pytest.mark.usefixtures("maybe_run_functions_eagerly")`
decorator. This will run the tests twice, once normally, and once
with `tf.config.experimental_run_functions_eagerly(True)`.
* Run `layer_test` on the layer.
* Add a `py_test` to this sub-package's BUILD file.

Expand Down
8 changes: 4 additions & 4 deletions tensorflow_addons/losses/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ must:
#### Testing Requirements
* Simple unittests that demonstrate the loss is behaving as expected on
some set of known inputs and outputs.
* When applicable, run all tests with TensorFlow's
`@run_in_graph_and_eager_modes` (for test method)
or `run_all_in_graph_and_eager_modes` (for TestCase subclass)
decorator.
* To run your `tf.functions` in eager mode and graph mode in the tests,
you can use the `@pytest.mark.usefixtures("maybe_run_functions_eagerly")`
decorator. This will run the tests twice, once normally, and once
with `tf.config.experimental_run_functions_eagerly(True)`.
* Add a `py_test` to this sub-package's BUILD file.

#### Documentation Requirements
Expand Down
8 changes: 4 additions & 4 deletions tensorflow_addons/metrics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ must:

#### Testing Requirements
* Simple unittests that demonstrate the metric is behaving as expected.
* When applicable, run all unittests with TensorFlow's
`@run_in_graph_and_eager_modes` (for test method)
or `run_all_in_graph_and_eager_modes` (for TestCase subclass)
decorator.
* To run your `tf.functions` in eager mode and graph mode in the tests,
you can use the `@pytest.mark.usefixtures("maybe_run_functions_eagerly")`
decorator. This will run the tests twice, once normally, and once
with `tf.config.experimental_run_functions_eagerly(True)`.
* Add a `py_test` to this sub-package's BUILD file.

#### Documentation Requirements
Expand Down
8 changes: 4 additions & 4 deletions tensorflow_addons/optimizers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ must:
* Add the addon to the `py_library` in this sub-package's BUILD file.

#### Testing Requirements
* When applicable, run all tests with TensorFlow's
`@run_in_graph_and_eager_modes` (for test method)
or `run_all_in_graph_and_eager_modes` (for TestCase subclass)
decorator.
* To run your `tf.functions` in eager mode and graph mode in the tests,
you can use the `@pytest.mark.usefixtures("maybe_run_functions_eagerly")`
decorator. This will run the tests twice, once normally, and once
with `tf.config.experimental_run_functions_eagerly(True)`.
* Add a `py_test` to this sub-package's BUILD file.

#### Documentation Requirements
Expand Down
8 changes: 4 additions & 4 deletions tensorflow_addons/rnn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ In order to conform with the current API standard, all cells must:
* Add the addon to the `py_library` in this sub-package's BUILD file.

#### Testing Requirements
* When applicable, run all tests with TensorFlow's
`@run_in_graph_and_eager_modes` (for test method)
or `@run_all_in_graph_and_eager_modes` (for TestCase subclass)
decorator.
* To run your `tf.functions` in eager mode and graph mode in the tests,
you can use the `@pytest.mark.usefixtures("maybe_run_functions_eagerly")`
decorator. This will run the tests twice, once normally, and once
with `tf.config.experimental_run_functions_eagerly(True)`.
* Add a `py_test` to this sub-package's BUILD file.

#### Documentation Requirements
Expand Down
7 changes: 4 additions & 3 deletions tensorflow_addons/seq2seq/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,10 @@ In order to conform with the current API standard, all objects must:
#### Testing Requirements
* Simple unittests that demonstrate the class is behaving as expected on
some set of known inputs and outputs.
* When applicable, run all tests with TensorFlow's
`@run_in_graph_and_eager_modes` (for test method)
or `run_all_in_graph_and_eager_modes` (for TestCase subclass) decorator.
* To run your `tf.functions` in eager mode and graph mode in the tests,
you can use the `@pytest.mark.usefixtures("maybe_run_functions_eagerly")`
decorator. This will run the tests twice, once normally, and once
with `tf.config.experimental_run_functions_eagerly(True)`.
* Add a `py_test` to this sub-package's BUILD file.

## Sample code and Migration guide from TF 1.X
Expand Down
8 changes: 4 additions & 4 deletions tensorflow_addons/text/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ must:
#### Testing Requirements
* Simple unittests that demonstrate the text op is behaving as
expected.
* When applicable, run all unittests with TensorFlow's
`@run_in_graph_and_eager_modes` (for test method)
or `run_all_in_graph_and_eager_modes` (for TestCase subclass)
decorator.
* To run your `tf.functions` in eager mode and graph mode in the tests,
you can use the `@pytest.mark.usefixtures("maybe_run_functions_eagerly")`
decorator. This will run the tests twice, once normally, and once
with `tf.config.experimental_run_functions_eagerly(True)`.
* Add a `py_test` to this sub-package's BUILD file.

#### Documentation Requirements
Expand Down

0 comments on commit 5568ea8

Please sign in to comment.