unit test documentation examples

Author: sdpython

.gitignore

@@ -12,3 +12,4 @@ _doc/auto_examples/*
 _doc/examples/plot_*.png
 _doc/_static/require.js
 _doc/_static/viz.js
+_unittests/ut__main/*.png

README.rst

@@ -59,6 +59,17 @@ well as to execute it.
 
     print(onnx_simple_text_plot(jitted_myloss.get_onnx()))
 
+::
+
+    [0.042]
+    opset: domain='' version=18
+    input: name='x0' type=dtype('float32') shape=['', '']
+    input: name='x1' type=dtype('float32') shape=['', '']
+    Sub(x0, x1) -> r__0
+      Abs(r__0) -> r__1
+        ReduceSum(r__1, keepdims=0) -> r__2
+    output: name='r__2' type=dtype('float32') shape=None
+
 It supports eager mode as well:
 
 .. code-block:: python

_doc/examples/plot_first_example.py

@@ -5,7 +5,9 @@
 First examples with onnx-array-api
 ==================================
 
-This demonstrates easy case with :epkg:`onnx-array-api`.
+This demonstrates an easy case with :epkg:`onnx-array-api`.
+It shows how a function can be easily converted into
+ONNX.
 
 A loss function from numpy to ONNX
 ++++++++++++++++++++++++++++++++++

_unittests/ut__main/test_documentation_examples.py

@@ -0,0 +1,62 @@
+import unittest
+import os
+import sys
+import importlib
+import subprocess
+import time
+from onnx_array_api.ext_test_case import ExtTestCase
+
+
+def import_source(module_file_path, module_name):
+    if not os.path.exists(module_file_path):
+        raise FileNotFoundError(module_file_path)
+    module_spec = importlib.util.spec_from_file_location(module_name, module_file_path)
+    if module_spec is None:
+        raise FileNotFoundError(
+            "Unable to find '{}' in '{}'.".format(module_name, module_file_path)
+        )
+    module = importlib.util.module_from_spec(module_spec)
+    return module_spec.loader.exec_module(module)
+
+
+class TestDocumentationExamples(ExtTestCase):
+    def test_documentation_examples(self):
+        this = os.path.abspath(os.path.dirname(__file__))
+        fold = os.path.normpath(os.path.join(this, "..", "..", "_doc", "examples"))
+        found = os.listdir(fold)
+        tested = 0
+        for name in found:
+            if name.startswith("plot_") and name.endswith(".py"):
+                perf = time.perf_counter()
+                try:
+                    mod = import_source(fold, os.path.splitext(name)[0])
+                    assert mod is not None
+                except FileNotFoundError:
+                    # try another way
+                    cmds = [sys.executable, "-u", os.path.join(fold, name)]
+                    p = subprocess.Popen(
+                        cmds, stdout=subprocess.PIPE, stderr=subprocess.PIPE
+                    )
+                    res = p.communicate()
+                    out, err = res
+                    st = err.decode("ascii", errors="ignore")
+                    if len(st) > 0 and "Traceback" in st:
+                        if '"dot" not found in path.' in st:
+                            # dot not installed, this part
+                            # is tested in onnx framework
+                            print(f"failed: {name!r} due to missing dot.")
+                            continue
+                        raise AssertionError(
+                            "Example '{}' (cmd: {} - exec_prefix='{}') "
+                            "failed due to\n{}"
+                            "".format(name, cmds, sys.exec_prefix, st)
+                        )
+                dt = time.perf_counter() - perf
+                print(f"{dt:.3f}: run {name!r}")
+                tested += 1
+        if tested == 0:
+            raise AssertionError("No example was tested.")
+
+
+if __name__ == "__main__":
+    unittest.main()

_unittests/ut_npx/test_npx.py

@@ -2418,7 +2418,7 @@ def l2_loss(x, y):
 
     def test_eager_cst_index(self):
         def l1_loss(x, y):
-            return absolute(x - y).sum()
+            return absolute_inline(x - y).sum()
 
         def l2_loss(x, y):
             return ((x - y) ** 2).sum()
@@ -2441,5 +2441,5 @@ def myloss(x, y):
 
 
 if __name__ == "__main__":
-    # TestNpx().test_eager_numpy()
+    TestNpx().test_eager_cst_index()
     unittest.main(verbosity=2)