doc: add a warning for profiling API

oneapi-src · Jul 10, 2023 · 8d796ef · 8d796ef
1 parent 51a8f7a
commit 8d796ef
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/doc/advanced/experimental.md b/doc/advanced/experimental.md
@@ -186,6 +186,13 @@ user-provided queue.
     dnnl::reset_profiling(stream);
 ~~~
 
+@warning
+- When the stream is created with enabled profiling capabilities it will
+  collect profiling data for each primitive execution. It is the user's
+  responsibility to reset the profiler's state to avoid consuming all
+  memory resources in the system.
+
+
 #### Limitations
 
 * Only GPU engines with OpenCL and SYCL runtimes are supported