Skip to content
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

Merged
merged 20 commits into from
Feb 28, 2021
Merged

Add graph documentations #788

merged 20 commits into from
Feb 28, 2021

Conversation

qianqianzhu
Copy link
Contributor

@qianqianzhu qianqianzhu commented Jan 21, 2021

Description

This PR mainly gets APIs related to graph documented.

List of changes:

  • Add graph documentation (overview) graph.md
  • Add API documentations for src/graph/expression_graph.h
  • Add API documentations for src/graph/node_initializers.h
  • Small updates on code documentation in:
    • 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

  • I have tested the code manually
  • I have run regression tests
  • I have read and followed CONTRIBUTING.md
  • I have updated CHANGELOG.md

@qianqianzhu qianqianzhu marked this pull request as ready for review January 21, 2021 14:38
@snukky snukky self-assigned this Jan 22, 2021
@qianqianzhu qianqianzhu changed the title Add API documentations for ExpressionGraph Add API documentations for graph Feb 4, 2021
Copy link
Member

@snukky snukky left a 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.

doc/graph/graph.md Outdated Show resolved Hide resolved
doc/graph/graph.md Outdated Show resolved Hide resolved
doc/graph/graph.md Outdated Show resolved Hide resolved
doc/graph/graph.md Outdated Show resolved Hide resolved
doc/graph/graph.md Outdated Show resolved Hide resolved
src/graph/expression_graph.h Outdated Show resolved Hide resolved
src/graph/expression_graph.h Outdated Show resolved Hide resolved
src/graph/expression_graph.h Outdated Show resolved Hide resolved
src/graph/expression_graph.h Outdated Show resolved Hide resolved
src/graph/expression_graph.h Outdated Show resolved Hide resolved
Copy link
Contributor Author

@qianqianzhu qianqianzhu left a 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.

Copy link
Member

@snukky snukky left a 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?

src/graph/expression_graph.cpp Outdated Show resolved Hide resolved
src/graph/expression_graph.h Outdated Show resolved Hide resolved
src/graph/expression_graph.h Show resolved Hide resolved
src/graph/expression_graph.h Outdated Show resolved Hide resolved
src/graph/expression_graph.h Outdated Show resolved Hide resolved
src/graph/node_initializers.cpp Outdated Show resolved Hide resolved
src/graph/node_initializers.h Outdated Show resolved Hide resolved
src/graph/node_initializers.h Outdated Show resolved Hide resolved
src/graph/node_initializers.h Outdated Show resolved Hide resolved
@snukky snukky mentioned this pull request Feb 22, 2021
4 tasks
@qianqianzhu qianqianzhu changed the title Add API documentations for graph Add graph documentations Feb 23, 2021
Copy link
Member

@graemenail graemenail left a 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

src/graph/expression_graph.h Outdated Show resolved Hide resolved
src/graph/node_initializers.h Outdated Show resolved Hide resolved
src/graph/node_initializers.h Outdated Show resolved Hide resolved
src/graph/node_initializers.h Outdated Show resolved Hide resolved
src/graph/node_initializers.h Outdated Show resolved Hide resolved
doc/graph.md Outdated Show resolved Hide resolved
doc/graph.md Outdated Show resolved Hide resolved
doc/graph.md Outdated Show resolved Hide resolved
doc/graph.md Outdated Show resolved Hide resolved
doc/graph.md Outdated Show resolved Hide resolved
@qianqianzhu
Copy link
Contributor Author

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.

@snukky snukky merged commit 2a9c0bb into master Feb 28, 2021
@qianqianzhu qianqianzhu deleted the graph_docs branch March 1, 2021 10:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants