Enable doctest (#2069)

* Enable doctest
* Fix GeometricMean docstring

Author: WindQAQ

pytest.ini

@@ -1,2 +1,3 @@
 [pytest]
 addopts = -ra
+doctest_optionflags = ELLIPSIS NORMALIZE_WHITESPACE IGNORE_EXCEPTION_DETAIL DONT_ACCEPT_BLANKLINE

tensorflow_addons/activations/hardshrink.py

@@ -33,6 +33,12 @@ def hardshrink(
     Computes hard shrink function:
     `x if x < lower or x > upper else 0`.
 
+    Usage:
+
+    >>> x = tf.constant([1.0, 0.0, 1.0])
+    >>> tfa.activations.hardshrink(x)
+    <tf.Tensor: shape=(3,), dtype=float32, numpy=array([1., 0., 1.], dtype=float32)>
+
     Args:
         x: A `Tensor`. Must be one of the following types:
             `float16`, `float32`, `float64`.

tensorflow_addons/conftest.py

@@ -1,3 +1,9 @@
+import numpy as np
+import pytest
+import tensorflow as tf
+
+import tensorflow_addons as tfa
+
 from tensorflow_addons.utils.test_utils import (  # noqa: F401
     maybe_run_functions_eagerly,
     only_run_functions_eagerly,
@@ -17,3 +23,10 @@
 # fixtures present in this file will be available
 # when running tests and can be referenced with strings
 # https://docs.pytest.org/en/latest/fixture.html#conftest-py-sharing-fixture-functions
+
+
+@pytest.fixture(autouse=True)
+def add_doctest_namespace(doctest_namespace):
+    doctest_namespace["np"] = np
+    doctest_namespace["tf"] = tf
+    doctest_namespace["tfa"] = tfa

tensorflow_addons/metrics/geometric_mean.py

@@ -34,12 +34,12 @@ class GeometricMean(Metric):
     Note: `tfa.metrics.GeometricMean` can be used the same as `tf.keras.metrics.Mean`
 
     Usage:
-    ```python
+
     >>> m = tfa.metrics.GeometricMean()
     >>> m.update_state([1, 3, 5, 7, 9])
     >>> m.result().numpy()
     3.9362833
-    ```
+
     """
 
     @typechecked

tensorflow_addons/utils/test_utils.py

@@ -166,7 +166,12 @@ def pytest_configure(config):
 
 @pytest.fixture(autouse=True, scope="function")
 def device(request):
-    requested_device = request.param
+    try:
+        requested_device = request.param
+    except Exception:
+        # workaround for DocTestItem
+        # https://github.com/pytest-dev/pytest/issues/5070
+        requested_device = "no_device"
     if requested_device == "no_device":
         yield requested_device
     elif requested_device == tf.distribute.MirroredStrategy:

tools/docker/cpu_tests.Dockerfile

@@ -20,7 +20,8 @@ RUN python configure.py
 RUN pip install -e ./
 RUN --mount=type=cache,id=cache_bazel,target=/root/.cache/bazel \
     bash tools/install_so_files.sh
-RUN pytest -v -n auto --durations=25 --cov=tensorflow_addons ./tensorflow_addons/
+RUN pytest -v -n auto --durations=25 --doctest-modules ./tensorflow_addons \
+    --cov=tensorflow_addons ./tensorflow_addons/
 
 RUN bazel build --enable_runfiles build_pip_pkg
 RUN bazel-bin/build_pip_pkg artifacts