summaryrefslogtreecommitdiff
path: root/doc/clblast.md
diff options
context:
space:
mode:
authorCedric Nugteren <web@cedricnugteren.nl>2017-02-18 10:32:32 +0100
committerCedric Nugteren <web@cedricnugteren.nl>2017-02-18 10:32:32 +0100
commit3d10690c830a749d1e9c2c60bcd68a61590ef994 (patch)
tree8d49818cfedd781612d00eefbf0a3fa0fb4ff1df /doc/clblast.md
parentcda449a5c39041b2a0e6893ee254e145447b78ca (diff)
Added missing documentation for the fill and clear cache functions
Diffstat (limited to 'doc/clblast.md')
-rw-r--r--doc/clblast.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/clblast.md b/doc/clblast.md
index 37b99f3d..11560dce 100644
--- a/doc/clblast.md
+++ b/doc/clblast.md
@@ -2781,3 +2781,38 @@ Requirements for OMATCOPY:
+ClearCache: Resets the cache of compiled binaries (auxiliary function)
+-------------
+
+CLBlast stores binaries of compiled kernels into a cache in case the same kernel is used later on for the same device. This cache can be cleared to free up system memory or it can be useful in case of debugging.
+
+C++ API:
+```
+StatusCode ClearCache()
+```
+
+C API:
+```
+CLBlastStatusCode CLBlastClearCache()
+```
+
+
+
+FillCache: Populates the cache of compiled binaries for a specific device (auxiliary function)
+-------------
+
+CLBlast stores binaries of compiled kernels into a cache in case the same kernel is used later on for the same device. This cache is automatically populated whenever a new binary is created. Thus, the first run of a specific kernel could take extra time. For debugging or performance evaluation purposes, it might be useful to populate the cache upfront. This function populates the cache for all kernels in CLBlast for all precisions, but for a specific device only.
+
+C++ API:
+```
+StatusCode FillCache(const cl_device_id device)
+```
+
+C API:
+```
+CLBlastStatusCode CLBlastFillCache(const cl_device_id device)
+```
+
+Arguments to FillCache:
+
+* `const cl_device_id device`: The OpenCL device to fill the cache for.