-
Notifications
You must be signed in to change notification settings - Fork 126
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add graph documentations #788
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot for this tremendous work towards having a well documented Marian one day! :)
I added a first portion of comments. General comments to the tutorial/graph documentation:
- I think we could focus on the public API and more on how to use the graph than on details how it's implemented.
- I'm missing the description on how to use
DEBUG
.
For the doxygen documentation, I would like to make it as minimalistic as possible, to increase the chance that people will be using it when creating new code. We should also consider creating a very simple documentation explaining basic doxygen commands, so that developers can refer to when documenting their code.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just marked all Roman's comments as resolved.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Doxygen comments looks much better IMO. Have you tested how does the automatic @brief
work?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A nice document on expression graphs with useful examples. My comments are mostly typos, and just clarifications
Many thanks for your detailed comments! I just fixed them. |
Description
This PR mainly gets APIs related to
graph
documented.List of changes:
graph.md
src/graph/expression_graph.h
src/graph/node_initializers.h
src/graph/expression_graph.cpp
src/graph/node_initializers.cpp
src/tensors/tensor.h
src/graph/node.h
src/graph/node.cpp
src/common/definitions.h
src/common/shape.h
src/common/types.h
src/graph/node_operators.h
Added dependencies: none
How to test
Build and test successfully in
gna
.Checklist