From 7d0d68ab81185b7faa3c3d450ab22ffdcbb45b12 Mon Sep 17 00:00:00 2001 From: Xavier Dupre Date: Mon, 13 Nov 2023 15:50:31 +0100 Subject: [PATCH] improve documentation --- README.rst | 2 +- _doc/api/light_api.rst | 17 +++++++++++++++++ _doc/tech/aapi.rst | 2 +- 3 files changed, 19 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 7d53c79..b24b73d 100644 --- a/README.rst +++ b/README.rst @@ -113,7 +113,7 @@ It supports eager mode as well: l2_loss=[0.002] [0.042] -The second API ir **Light API** tends to do every thing in one line. +The second API or **Light API** tends to do every thing in one line. The euclidean distance looks like the following: :: diff --git a/_doc/api/light_api.rst b/_doc/api/light_api.rst index 5fe184f..889a70b 100644 --- a/_doc/api/light_api.rst +++ b/_doc/api/light_api.rst @@ -84,3 +84,20 @@ Translater .. autoclass:: onnx_array_api.light_api.translate.Translater :members: +Available operators +=================== + +One input ++++++++++ + +.. autoclass:: onnx_array_api.light_api._op_var.OpsVar + :members: + +Two inputs or more +++++++++++++++++++ + +.. autoclass:: onnx_array_api.light_api._op_vars.OpsVars + :members: + + + diff --git a/_doc/tech/aapi.rst b/_doc/tech/aapi.rst index 13e6c02..bbbad63 100644 --- a/_doc/tech/aapi.rst +++ b/_doc/tech/aapi.rst @@ -8,7 +8,7 @@ Python is not strongly typed and many different types can be used to represent a value. Argument *axis* can be an integer or a tuple (see `min from Array API ` +generated/array_api.min.html>`_ for example). On the other side, `ReduceMin from ONNX `_ is considered as a tensor.