callbacks are an experimental feature

ROCm · Aug 6, 2021 · 60206b6 · 60206b6
1 parent b93c40c
commit 60206b6
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/docs/source/library.rst b/docs/source/library.rst
@@ -321,7 +321,7 @@ Transforms of real data
 Load and Store Callbacks
 ------------------------
 
-rocFFT includes functionality to call user-defined device functions
+rocFFT includes experimental functionality to call user-defined device functions
 when loading input from global memory at the start of a transform, or
 when storing output to global memory at the end of a transform.
 

diff --git a/library/include/rocfft.h b/library/include/rocfft.h
@@ -399,10 +399,10 @@ ROCFFT_EXPORT rocfft_status rocfft_execution_info_set_mode( rocfft_execution_inf
 ROCFFT_EXPORT rocfft_status rocfft_execution_info_set_stream(rocfft_execution_info info,
                                                              void*                 stream);
 
-/*! @brief Set a load callback for a plan execution
+/*! @brief Set a load callback for a plan execution (experimental)
  *  @details This function specifies a user-defined callback function
  *  that is run to load input from global memory at the start of the
- *  transform.
+ *  transform.  Callbacks are an experimental feature in rocFFT.
  *
  *  Callback function pointers/data are given as arrays, with one
  *  function/data pointer per device executing this plan.  Currently,
@@ -439,10 +439,10 @@ ROCFFT_EXPORT rocfft_status rocfft_execution_info_set_load_callback(rocfft_execu
                                                                     void** cb_data,
                                                                     size_t shared_mem_bytes);
 
-/*! @brief Set a store callback for a plan execution
+/*! @brief Set a store callback for a plan execution (experimental)
  *  @details This function specifies a user-defined callback function
  *  that is run to store output to global memory at the end of the
- *  transform.
+ *  transform.  Callbacks are an experimental feature in rocFFT.
  *
  *  Callback function pointers/data are given as arrays, with one
  *  function/data pointer per device executing this plan.  Currently,