From cd6e312c2d300625b2ec4c7b63f29c160bb4ed56 Mon Sep 17 00:00:00 2001 From: Paul Date: Mon, 16 Dec 2019 10:14:21 -0600 Subject: [PATCH] Fix c++ documentaion --- doc/CMakeLists.txt | 12 ++++++--- doc/src/cpp_user_guide.rst | 1 + doc/src/reference/operators.rst | 6 ++++- doc/src/reference/pass.rst | 42 ++++++++++++++++++++++-------- doc/src/reference/program.rst | 5 ++++ doc/src/reference/quantization.rst | 13 +++++++++ 6 files changed, 63 insertions(+), 16 deletions(-) create mode 100644 doc/src/reference/quantization.rst diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 4e5af96a73d..352c02159e4 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -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 diff --git a/doc/src/cpp_user_guide.rst b/doc/src/cpp_user_guide.rst index 78b16dd1bc0..cc0a2fa27c7 100644 --- a/doc/src/cpp_user_guide.rst +++ b/doc/src/cpp_user_guide.rst @@ -10,4 +10,5 @@ C++ User Guide reference/operators reference/program reference/targets + reference/quantization reference/pass diff --git a/doc/src/reference/operators.rst b/doc/src/reference/operators.rst index 9e3794fcdd5..c16cb37e6e6 100644 --- a/doc/src/reference/operators.rst +++ b/doc/src/reference/operators.rst @@ -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 diff --git a/doc/src/reference/pass.rst b/doc/src/reference/pass.rst index 93d8d386d2e..d88d6a79aeb 100644 --- a/doc/src/reference/pass.rst +++ b/doc/src/reference/pass.rst @@ -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 ---------------- @@ -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 ---------------- diff --git a/doc/src/reference/program.rst b/doc/src/reference/program.rst index a5e4fc0a3c7..459e1ce59d7 100644 --- a/doc/src/reference/program.rst +++ b/doc/src/reference/program.rst @@ -22,3 +22,8 @@ parse_onnx ---------- .. doxygenfunction:: migraphx::MIGRAPHX_INLINE_NS::parse_onnx + +parse_tf +-------- + +.. doxygenfunction:: migraphx::MIGRAPHX_INLINE_NS::parse_tf diff --git a/doc/src/reference/quantization.rst b/doc/src/reference/quantization.rst new file mode 100644 index 00000000000..5449aba31f7 --- /dev/null +++ b/doc/src/reference/quantization.rst @@ -0,0 +1,13 @@ +Quantization +============ + +quantize_fp16 +------------- + +.. doxygenfunction:: migraphx::MIGRAPHX_INLINE_NS::quantize_fp16 + +quantize_int8 +------------- + +.. doxygenfunction:: migraphx::MIGRAPHX_INLINE_NS::quantize_int8 +