Skip to content
Snippets Groups Projects

#194: Add documentation for GraphView

Open Ghost User requested to merge hrouis/aidge_core:aidge_core#194 into dev
1 file
+ 4
0
Compare changes
  • Side-by-side
  • Inline
@@ -60,6 +60,7 @@ void init_GraphView(py::module& m) {
Orders the inputs of the GraphView
The inputs will be ordered in the same order as they come in the std::vector.
Inputs missing from this vector will then be added as per their previous order.
:param inputs: set of inputs in the wanted order
:type inputs: List[(Node, int)]
)mydelimiter")
@@ -69,6 +70,7 @@ void init_GraphView(py::module& m) {
Orders the outputs of the GraphView
The outputs will be ordered in the same order as they come in the std::vector.
Outputs missing from this vector will then be added as per their previous order.
:param outputs: set of outputs in the wanted order
:type outputs: List[(Node, int)]
)mydelimiter")
@@ -146,6 +148,7 @@ void init_GraphView(py::module& m) {
When a Node is removed, the clone() method automatically finds the next valid parent in line, going backward in
the graph and connects it if that makes sense without ambiguity (effectively treating the removed Node as an
identity operation).
:param cloneNode Callback function to clone a node
:type cloneNode Node
:return: Cloned GraphView
@@ -160,6 +163,7 @@ void init_GraphView(py::module& m) {
.def("get_node", &GraphView::getNode, py::arg("node_name"),
R"mydelimiter(
Get the Node with the corresponding name if it is in the GraphView.
:param node_name The name of the Node
:type string
:return: The Node of the GraphView with corresponding name
Loading