Skip to content

Commit 3563871

Browse files
update testing requirements
1 parent afd0646 commit 3563871

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

tensorflow_addons/metrics/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,13 @@
1515
#### Standard API
1616
In order to conform with the current API standard, all metrics
1717
must:
18-
* Be a `tf.function`.
19-
* Have the signature `fn(input, axis=-1, name=None)`.
18+
* Inherit from `tf.metrics.Metric`.
2019
* [Register as a keras global object](https://github.com/tensorflow/addons/blob/master/tensorflow_addons/utils/python/keras_utils.py)
2120
so it can be serialized properly.
2221
* Add the addon to the `py_library` in this sub-package's BUILD file.
2322

2423
#### Testing Requirements
25-
* Simple unittests that demonstrate the layer is behaving as expected.
24+
* Simple unittests that demonstrate the metric is behaving as expected.
2625
* When applicable, run all unittests with TensorFlow's
2726
`@run_in_graph_and_eager_modes` (for test method)
2827
or `run_all_in_graph_and_eager_modes` (for TestCase subclass)

0 commit comments

Comments
 (0)