Skip to content

Commit

Permalink
rocAL - Formatting and doxygen changes (#38)
Browse files Browse the repository at this point in the history
* Clean up PR
  • Loading branch information
SundarRajan28 authored Sep 26, 2023
1 parent a7730f9 commit f24f545
Show file tree
Hide file tree
Showing 306 changed files with 12,333 additions and 13,886 deletions.
19 changes: 18 additions & 1 deletion .Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -960,7 +960,24 @@ INPUT = README.md \
amd_openvx_extensions/amd_nn/include/vx_amd_nn.h \
amd_openvx_extensions/amd_opencv/include/vx_ext_opencv.h \
amd_openvx_extensions/amd_rpp/include/vx_ext_rpp.h \
amd_openvx_extensions/amd_winml/include/vx_ext_winml.h
amd_openvx_extensions/amd_winml/include/vx_ext_winml.h \
rocAL/rocAL/include/api/rocal_api_augmentation.h \
rocAL/rocAL/include/api/rocal_api_data_loaders.h \
rocAL/rocAL/include/api/rocal_api_data_transfer.h \
rocAL/rocAL/include/api/rocal_api_info.h \
rocAL/rocAL/include/api/rocal_api_meta_data.h \
rocAL/rocAL/include/api/rocal_api_parameters.h \
rocAL/rocAL/include/api/rocal_api_types.h \
rocAL/rocAL/include/api/rocal_api.h \
rocAL/rocAL_pybind/amd/rocal/decoders.py \
rocAL/rocAL_pybind/amd/rocal/fn.py \
rocAL/rocAL_pybind/amd/rocal/pipeline.py \
rocAL/rocAL_pybind/amd/rocal/random.py \
rocAL/rocAL_pybind/amd/rocal/readers.py \
rocAL/rocAL_pybind/amd/rocal/types.py \
rocAL/rocAL_pybind/amd/rocal/plugin/generic.py \
rocAL/rocAL_pybind/amd/rocal/plugin/pytorch.py \
rocAL/rocAL_pybind/amd/rocal/plugin/tf.py

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down
4 changes: 2 additions & 2 deletions amd_openvx/openvx/include/VX/vx_api.h
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ VX_API_ENTRY vx_enum VX_API_CALL vxRegisterUserStruct(vx_context context, vx_siz
* \brief Registers user-defined structures to the context, and associates a name to it.
* \param [in] context The reference to the implementation context.
* \param [in] size The size of user struct in bytes.
* \param [in] *type_name Pointer to the '\0' terminated string that identifies the
* \param [in] type_name Pointer to the '\0' terminated string that identifies the
* user struct type. The string is copied by the function so
* that it stays the property of the caller. NULL means that
* the user struct is not named. The length of the string
Expand All @@ -177,8 +177,8 @@ VX_API_ENTRY vx_enum VX_API_CALL vxRegisterUserStructWithName(vx_context context
/*!
* \brief Returns the name of the user-defined structure associated with the enumeration given.
* \param [in] context The reference to the implementation context.
* \param [out] user_struct_type Name of the user struct
* \param [in] type_name The enumeration value of the user struct
* \param [out] name_size Name of the user struct
* \param [in] name_size The size of allocated buffer pointed to by type_name
* \return A <tt>\ref vx_status_e</tt> enumeration.
* \retval VX_SUCCESS user_struct_type was valid, and name was found and returned
Expand Down
6 changes: 6 additions & 0 deletions amd_openvx/openvx/include/vx_ext_amd.h
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,13 @@ THE SOFTWARE.
* \ingroup group_amd
*/
#define AGO_TARGET_AFFINITY_CPU 0x0010 // CPU
/*! \brief AMD target affinity enumerations for AgoTargetAffinityInfo.device_type
* \ingroup group_amd
*/
#define AGO_TARGET_AFFINITY_GPU 0x0020 // GPU
/*! \brief AMD target affinity enumerations for AgoTargetAffinityInfo.device_type
* \ingroup group_amd
*/
#define AGO_TARGET_AFFINITY_APU 0x0030 // APU

/*! \brief AMD internal parameters. [TODO: This needs to be moved to ago_internal.h]
Expand Down
6 changes: 1 addition & 5 deletions amd_openvx_extensions/amd_custom/include/vx_amd_custom.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ THE SOFTWARE.
*/

/*! \brief The type enumeration lists all NN extension types.
* \ingroup group_cnn
* \ingroup group_amd_nn
* \ingroup group_amd_custom
*/
enum vx_amd_custom_type_e
Expand All @@ -44,8 +42,6 @@ enum vx_amd_custom_type_e
};

/*! \brief Input parameters for a convolution operation.
* \ingroup group_cnn
* \ingroup group_amd_nn
* \ingroup group_amd_custom
*/
typedef struct _vx_amd_custom_params_t
Expand All @@ -58,7 +54,7 @@ typedef struct _vx_amd_custom_params_t
* \param [in] graph The handle to the graph.
* \param [in] inputs The input tensor data.
* \param [in] function custom funtion enum.
* \param [in] array for user specified custom_parameters.
* \param [in] custom_parameters for user specified custom_parameters.
* \param [out] outputs The output tensor data.
* \return <tt> vx_node</tt>.
* \returns A node reference <tt>\ref vx_node</tt>. Any possible errors preventing a
Expand Down
Loading

0 comments on commit f24f545

Please sign in to comment.