From e1e72618cddd19f6334c20d90a56319689c8b6e7 Mon Sep 17 00:00:00 2001
From: thibault allenet <thibault.allenet@cea.fr>
Date: Wed, 2 Aug 2023 15:45:47 +0000
Subject: [PATCH] NodeRegex & Recipies python API doc
---
.../graphmatching/pybind_NodeRegex.cpp | 12 +++++++++--
python_binding/recipies/pybind_Recipies.cpp | 20 +++++++++++++++++--
2 files changed, 28 insertions(+), 4 deletions(-)
diff --git a/python_binding/graphmatching/pybind_NodeRegex.cpp b/python_binding/graphmatching/pybind_NodeRegex.cpp
index 76e91c495..6bbb74764 100644
--- a/python_binding/graphmatching/pybind_NodeRegex.cpp
+++ b/python_binding/graphmatching/pybind_NodeRegex.cpp
@@ -15,8 +15,16 @@
namespace py = pybind11;
namespace Aidge {
void init_NodeRegex(py::module& m){
- py::class_<NodeRegex, std::shared_ptr<NodeRegex>>(m, "NodeRegex")
- .def(py::init<const std::string>(), py::arg("condition"))
+ py::class_<NodeRegex, std::shared_ptr<NodeRegex>>(m, "NodeRegex", "NodeRegex class describes a condition to test on any operator. Current version only tests the type of the operator.")
+ .def(py::init<const std::string>(), py::arg("condition"), R"mydelimiter(
+ Constructor of NodeRegex
+
+ Parameters
+ ----------
+ :param condition: Condition to be fulfilled by an operator. Currently supported conditions are only the operator types.
+ :type condition: `string`
+
+ )mydelimiter")
;
}
}
diff --git a/python_binding/recipies/pybind_Recipies.cpp b/python_binding/recipies/pybind_Recipies.cpp
index 8f76d5395..ba03c3b1b 100644
--- a/python_binding/recipies/pybind_Recipies.cpp
+++ b/python_binding/recipies/pybind_Recipies.cpp
@@ -20,8 +20,24 @@ namespace py = pybind11;
namespace Aidge {
void init_Recipies(py::module &m) {
- m.def("fuse_mul_add", &fuseMulAdd, py::arg("nodes"));
- m.def("remove_flatten", &removeFlatten, py::arg("nodes"));
+ m.def("fuse_mul_add", &fuseMulAdd, py::arg("nodes"), R"mydelimiter(
+ Recipie to Fuse MatMul and Add operators into an `aidge.FC` operator.
+
+ Parameters
+ ----------
+ :param nodes: The MatMul and Add nodes to fuse.
+ :type nodes: list of `aidge.node`
+
+ )mydelimiter");
+ m.def("remove_flatten", &removeFlatten, py::arg("nodes"), R"mydelimiter(
+ Recipie to remove a flatten operator.
+
+ Parameters
+ ----------
+ :param nodes: The flatten operator to remove.
+ :type condition: list of `aidge.node`
+
+ )mydelimiter");
}
} // namespace Aidge
--
GitLab