From 6ce17e86e42caca5b753b5950e72f545cf5ccd58 Mon Sep 17 00:00:00 2001 From: cmoineau <cyril.moineau@cea.fr> Date: Fri, 11 Aug 2023 08:52:06 +0000 Subject: [PATCH] [Docs] Update ONNX API. --- aidge/aidge_backend_cpu | 2 +- aidge/aidge_core | 2 +- aidge/aidge_onnx | 2 +- docs/source/API/Onnx/index.rst | 26 ++++++++++++++++++++++++++ 4 files changed, 29 insertions(+), 3 deletions(-) diff --git a/aidge/aidge_backend_cpu b/aidge/aidge_backend_cpu index 67192853..e2fb16db 160000 --- a/aidge/aidge_backend_cpu +++ b/aidge/aidge_backend_cpu @@ -1 +1 @@ -Subproject commit 67192853d7c2b0b0dc27c3efefa6db559215721f +Subproject commit e2fb16db2ee45144216e246670d4cd481d033e54 diff --git a/aidge/aidge_core b/aidge/aidge_core index f6f1c60c..f2ea4dc9 160000 --- a/aidge/aidge_core +++ b/aidge/aidge_core @@ -1 +1 @@ -Subproject commit f6f1c60c98cd7630ceba03aa6fc43ae7533e8330 +Subproject commit f2ea4dc9f09ce82622c32284bfcd62bbe153579f diff --git a/aidge/aidge_onnx b/aidge/aidge_onnx index cb865d49..af92d98b 160000 --- a/aidge/aidge_onnx +++ b/aidge/aidge_onnx @@ -1 +1 @@ -Subproject commit cb865d494e4ed60a1d5e259ae9441421d9b188a8 +Subproject commit af92d98bc39b31834cb937771043b2907d0f89b0 diff --git a/docs/source/API/Onnx/index.rst b/docs/source/API/Onnx/index.rst index e3e2d1c4..b445876b 100644 --- a/docs/source/API/Onnx/index.rst +++ b/docs/source/API/Onnx/index.rst @@ -3,3 +3,29 @@ Aidge ONNX API .. autofunction:: aidge_onnx.load_onnx +Node converter +-------------- + +Register +~~~~~~~~ + +.. autofunction:: aidge_onnx.node_converter.register_converter + +.. autofunction:: aidge_onnx.node_converter.supported_operators + +.. autodecorator:: aidge_onnx.node_converter.auto_register + +.. because defaultdict.__doc__ is readonly, Sphinx cannot use the docstring set in the code. +.. data:: aidge_onnx.node_converter.ONNX_NODE_CONVERTER_ + + This ``defaultdict`` maps the ONNX type to a function which can convert an ONNX Node into an Aidge Node. + This means that if a key is missing from :py:data:`aidge_onnx.node_converter.ONNX_NODE_CONVERTER_`, it will return the function :py:func:`aidge_onnx.node_converter.generic.import_generic` which import the ONNX node as an Aidge generic operator. + It is possible to add keys to this dictionnary at runtime using :py:func:`aidge_onnx.node_converter.register_converter` or :py:func:`aidge_onnx.node_converter.auto_register` + + +Converters +~~~~~~~~~~ + +.. autofunction:: aidge_onnx.node_converter.generic.import_generic + + -- GitLab