update Userguide and design doc for GraphView

Goal:

The objective is to present to the users a comprehensive userguide allowing them to use the common aidge method of the graphView class

Questions:

Possible Fixes

(If you can, suggest a possible fix)

added Discussion 💬 label

assigned to @pineapple and @cmoineau

What is the difference between getParents and getOrderedParents? results seem the same

Not sure, but I think getParents was suppose to return a set ? At least for children it is the difference.

What is Connector operator()(const std::vector ctors); ?

It is the function to use functional declaration like:

x = Connector()
y = Connector()
z = my_conv(x, y)
z.get_graph()

what does the "verbose" parameter of save?

Just looking at the code as I am not the author of the code:

• MetaOp intern graph are saved in an extra file that is named <path>_<MetaOp type>_<rank in current graph>.
• If a child is not in the current GraphView then point to its pointer instead of rank, since we cannot compute its rank.

How does setOrderedInputs works? (what is the order of an input)

How does setOrderedOutputs works? (what is the order of an output)

These are functions that allow the user to set an order for inputs and ouputs. If I have a graph with two branch I don't have a natural order. This function allow to set one.

A visual representation:

flowchart TD
	A --> SUM
	B --> SUM
	SUM --> POW
	C --> POW

What is the order of the input of this graph ? A, B, C or B, A, C ?

Note: Same issue for outputs

Hope this answer your questions

No more question after we answered (@pineapple made a meeting with @operrin and @sylvainbataille).

Closing the issue.

closed

mentioned in merge request !245

reopened

assigned to @operrin and unassigned @cmoineau and @pineapple

added StatusWork in Progress label

changed the description

added to epic &14

added Documentation 📖 label and removed Discussion 💬 label

assigned to @sylvainbataille

changed the description

@pineapple @cmoineau Why does forwarddims return False instead of an exception? (what is the functional meaning of this false? (degraded mode?)

@pineapple @cmoineau Why isn't there exceptions in replace? (same as forwarddims)

@pineapple @cmoineau for inputs(string) what is supposed to happen if the node isn't found (seen no exception handling)

changed the description

output() seem to behave weirdly with node additions, to be confirmed

markNonUnicity logic seems wrong to me, to be confirmed

shouldn't updateNodeName be friend instead of public? using it as is will lead to discrepencies so leaving it public feel unsafe

Why are there unimplemented funcs there?

Where ?

There https://gitlab.eclipse.org/eclipse/aidge/aidge_core/-/blob/main/src/graph/GraphView.cpp?ref_type=heads#L611-614

There https://gitlab.eclipse.org/eclipse/aidge/aidge_core/-/blob/main/src/graph/GraphView.cpp?ref_type=heads#L1037-1040

There https://gitlab.eclipse.org/eclipse/aidge/aidge_core/-/blob/main/src/graph/GraphView.cpp?ref_type=heads#L1032-1035

Why some funcs have the Node/inoutput ID as a pair andd others as two different inputs of the func?

Example?

Both versions exist for addChild (both graphview and node's addchilds for graphview's insertParent Node and indexes are separated same for Node's removechild, addChildOp and addparent.

We got pairs the rest of the time

Why is there commented code?

To keep it

In case of commented code, I think an explenation of why it is kept/ what it does and why it's not uncommented might be nice to avoid putting raw commented code

Not sure about one part of updateInputsOutputsNew i need some explaining

updateInputsOutputsDelete's usage is unclear with the Node's status (should it happen before or after the deletion?)

changed the description