Skip to content

Commit

Permalink
Fix c++ documentaion
Browse files Browse the repository at this point in the history
  • Loading branch information
pfultz2 committed Dec 16, 2019
1 parent 9b9d141 commit cd6e312
Show file tree
Hide file tree
Showing 6 changed files with 63 additions and 16 deletions.
12 changes: 8 additions & 4 deletions doc/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,15 @@ set(DOXYGEN_OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/doxygen/)
add_doxygen_doc(
OUTPUT_DIRECTORY ${DOXYGEN_OUTPUT}
INPUT
${CMAKE_CURRENT_SOURCE_DIR}/../src
${PROJECT_SOURCE_DIR}/src
INCLUDE_PATH
${CMAKE_CURRENT_SOURCE_DIR}/../src/include
${CMAKE_CURRENT_SOURCE_DIR}/../src/targets/cpu/include
${CMAKE_CURRENT_SOURCE_DIR}/../src/targets/gpu/include
${PROJECT_SOURCE_DIR}/src/include
${PROJECT_SOURCE_DIR}/src/targets/cpu/include
${PROJECT_SOURCE_DIR}/src/targets/gpu/include
STRIP_FROM_INC_PATH
${PROJECT_SOURCE_DIR}/src/include
${PROJECT_SOURCE_DIR}/src/targets/cpu/include
${PROJECT_SOURCE_DIR}/src/targets/gpu/include
SEARCH_INCLUDES YES
MACRO_EXPANSION YES
RECURSIVE YES
Expand Down
1 change: 1 addition & 0 deletions doc/src/cpp_user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ C++ User Guide
reference/operators
reference/program
reference/targets
reference/quantization
reference/pass
6 changes: 5 additions & 1 deletion doc/src/reference/operators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@ operation

.. doxygenstruct:: migraphx::operation

.. doxygenfunction:: migraphx::MIGRAPHX_INLINE_NS::is_context_free

.. doxygenfunction:: migraphx::MIGRAPHX_INLINE_NS::has_finalize

operators
---------

.. doxygenfile:: operators.hpp
.. doxygennamespace:: migraphx::op
42 changes: 31 additions & 11 deletions doc/src/reference/pass.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,10 @@ dead_code_elimination

.. doxygenstruct:: migraphx::dead_code_elimination

common_subexpression_elimination
--------------------------------
eliminate_common_subexpression
------------------------------

.. doxygenstruct:: migraphx::common_subexpression_elimination

constant_propagate
------------------

.. doxygenstruct:: migraphx::constant_propagate
.. doxygenstruct:: migraphx::eliminate_common_subexpression

eliminate_concat
----------------
Expand All @@ -31,10 +26,35 @@ eliminate_contiguous

.. doxygenstruct:: migraphx::eliminate_contiguous

fwd_conv_batchnorm_rewrite
--------------------------
eliminate_identity
------------------

.. doxygenstruct:: migraphx::eliminate_identity

eliminate_pad
-------------

.. doxygenstruct:: migraphx::eliminate_pad

propagate_constant
------------------

.. doxygenstruct:: migraphx::propagate_constant

rewrite_batchnorm
-----------------

.. doxygenstruct:: migraphx::rewrite_batchnorm

rewrite_rnn
-----------

.. doxygenstruct:: migraphx::rewrite_rnn

schedule
--------

.. doxygenstruct:: migraphx::fwd_conv_batchnorm_rewrite
.. doxygenstruct:: migraphx::schedule

simplify_algebra
----------------
Expand Down
5 changes: 5 additions & 0 deletions doc/src/reference/program.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,8 @@ parse_onnx
----------

.. doxygenfunction:: migraphx::MIGRAPHX_INLINE_NS::parse_onnx

parse_tf
--------

.. doxygenfunction:: migraphx::MIGRAPHX_INLINE_NS::parse_tf
13 changes: 13 additions & 0 deletions doc/src/reference/quantization.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Quantization
============

quantize_fp16
-------------

.. doxygenfunction:: migraphx::MIGRAPHX_INLINE_NS::quantize_fp16

quantize_int8
-------------

.. doxygenfunction:: migraphx::MIGRAPHX_INLINE_NS::quantize_int8

0 comments on commit cd6e312

Please sign in to comment.