Skip to content

Commit

Permalink
[SWDEV-416089][Doc] convolution API in MIOpen is restricted to alpha …
Browse files Browse the repository at this point in the history
…= 1.0 and beta = 0.0 (#2419)
  • Loading branch information
bghimireamd authored Sep 26, 2023
1 parent c977e00 commit b9e724a
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions include/miopen/miopen.h
Original file line number Diff line number Diff line change
Expand Up @@ -1715,6 +1715,8 @@ miopenFindConvolutionForwardAlgorithm(miopenHandle_t handle,
* Runs the forward convolution layer based on the selected algorithm. The function
* miopenFindConvolutionForwardAlgorithm() must have been executed previously to
* determine the required memory needed for the workspace and the best convolutional algorithm.
* The scaling parameter alpha (float) and shift parameter beta (float) are only supported for
* alpha = 1 and beta = 0.
*
* If using Group/Depthwise convolution mode, call miopenSetConvolutionGroupCount() before running
* this.
Expand Down Expand Up @@ -1751,6 +1753,8 @@ MIOPEN_EXPORT miopenStatus_t miopenConvolutionForward(miopenHandle_t handle,
/*! @brief Calculate element-wise scale and shift of a tensor via a bias tensor
*
* This function applies an element-wise bias to a data tensor from an input bias tensor.
* The scaling parameter alpha (float) and shift parameter beta (float) are only supported for
* alpha = 1 and beta = 0.
*
* @param handle MIOpen handle (input)
* @param alpha Floating point scaling factor, allocated on the host (input)
Expand Down Expand Up @@ -2018,6 +2022,8 @@ miopenConvolutionBackwardWeights(miopenHandle_t handle,
/*! @brief Calculates the gradient with respect to the bias.
*
* Compute the convolution backwards gradient with respect to the bias tensor.
* The scaling parameter alpha (float) and shift parameter beta (float) are only supported for
* alpha = 1 and beta = 0.
*
* @param handle MIOpen handle (input)
* @param alpha Floating point scaling factor, allocated on the host (input)
Expand Down

0 comments on commit b9e724a

Please sign in to comment.