[WIP] Add Mermaid dump support

[IceflowRE]

Close #272

[tsung-wei-huang]

Is there any web-based interface for users to visualize the dump file? Like https://dreampuf.github.io/GraphvizOnline/

Also, would you mind fixing the compile error in the CI?

[IceflowRE]

https://mermaid-js.github.io/mermaid-live-editor

And yes of course but i wanted to get the first impression from you. The viszualize target is working tho.

[IceflowRE]

CI is broken due to https://gcc.gnu.org/bugzilla/show_bug.cgi?id=85282.

Will do a workaround later.

[tsung-wei-huang]

@IceflowRE , your IDE looks perfect. Yes, I think your implementation idea is the right direction. Would you please be so nice to fix the CI error? Also, have you tried to compile your code with cuda (NVCC), and see if they can dump the cudaFlow correctly?

[tsung-wei-huang]

I suggest adding a new section to the page Profile Taskflow Programs like "Visualize Your Taskflow with Mermaid Format" and add a detailed explanation with code examples. Later I will change the title to Profile and Visualization Taskflow Programs and include another similar section Visualize Your Taskflow with GraphViz Format. I think this is more organized -:)

[IceflowRE]

I suggest adding a new section to the page Profile Taskflow Programs like "Visualize Your Taskflow with Mermaid Format" and add a detailed explanation with code examples. Later I will change the title to Profile and Visualization Taskflow Programs and include another similar section Visualize Your Taskflow with GraphViz Format. I think this is more organized -:)

Isn't there already a section in the quickstart?

[tsung-wei-huang]

@IceflowRE thanks for this excellent work. I think we can make GraphViz a default argument to the dump method, or it causes compile errors for projects, including mine, that are using taskflow's dump already.

// in taskflow/core/taskflow.hpp
void dump(std::ostream& ostream, DumpFormat = tf::DumpFormat::Graphviz) const;
std::string dump(DumpFormat = DumpFormat::Graphviz) const;

In this case, you don't need to modify the other code examples that are using Graphviz by default. Would you be so nice to change it?

Also, it does not look like you provide the Mermaid-formated dump in cudaGraph here. The method tasks an std::ostream&, a const void* pointer to the parent node (just pointer value is printed in Graphviz), and a const std::string& to the name of the parent node. I think we need to add another parameter tf::DumpFormat in the last argument to the base class

I will come back to merge the pull later this week (sry quite busy these days)

[IceflowRE]

Also, it does not look like you provide the Mermaid-formated dump in cudaGraph here. The method tasks an std::ostream&, a const void* pointer to the parent node (just pointer value is printed in Graphviz), and a const std::string& to the name of the parent node. I think we need to add another parameter tf::DumpFormat in the last argument to the base class

Actually there are a lot more dump functions ....

• cuda graph
• tensor
• cuda task
• cuda flow
• cuda capturer

[IceflowRE]

Also can take a few days, iam a bit busy and i havent Cuda installed yet to test it.