From 49c489178b8f15a4a3f4ea447070d0875cd002c1 Mon Sep 17 00:00:00 2001 From: Daniel Lowell Date: Mon, 17 Dec 2018 15:53:05 -0600 Subject: [PATCH 1/2] Docs: persistent cache update for 1.7 (#1418) * Updated documentation to tell users to delete persistent cache is their compiler changes. * added note on user db removal. * Synched sections and added cross links. --- README.md | 19 ++++++++++++++++++- doc/src/cache.md | 4 ++++ doc/src/perfdatabase.md | 5 +++++ 3 files changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3b969eb096..afc6e750ef 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ An example cmake step can be: CXX=/opt/rocm/hcc/bin/hcc cmake -DMIOPEN_BACKEND=HIP -DCMAKE_PREFIX_PATH="/opt/rocm/hcc;/opt/rocm/hip" .. ``` -#### Setting up locations +#### Setting Up Locations By default the install location is set to '/opt/rocm', this can be set by using `CMAKE_INSTALL_PREFIX`: @@ -91,6 +91,8 @@ By default the install location is set to '/opt/rocm', this can be set by using cmake -DMIOPEN_BACKEND=OpenCL -DCMAKE_INSTALL_PREFIX= .. ``` +##### System Performance Database and User Database + The default path to the System PerfDb is `miopen/share/miopen/db/` within install location. The default path to the User PerfDb is `~/.config/miopen/`. For development purposes, setting `BUILD_DEV` will change default path to both database files to the source directory: ``` @@ -99,6 +101,21 @@ cmake -DMIOPEN_BACKEND=OpenCL -DBUILD_DEV=On .. Database paths can be explicitly customized by means of `MIOPEN_DB_PATH` (System PerfDb) and `MIOPEN_USER_DB_PATH` (User PerfDb) cmake variables. +If the user installs a new version of MIOpen, it is recommended that the user move, or delete their old user performance database file. The user can find the file with the suffix `*.updb.txt` in the user perf db path. + +More information about the performance database can be found [here](https://github.com/ROCmSoftwarePlatform/MIOpen/blob/master/doc/src/perfdatabase.md). + + +##### Persistent Program Cache + +MIOpen by default caches the device programs in the location `~/.cache/miopen/`. In the cache directory there exists a directory for each version of MIOpen. Users change the location of the cache directory during configuration using the flag `-DMIOPEN_CACHE_DIR=`. + +Users can also disable the cache during runtime using the environmental variable set as `MIOPEN_DISABLE_CACHE=1`. + +If the compiler changes, or the user modifies the kernels then the cache must be deleted for the MIOpen version in use; e.g., `rm -rf ~/.cache/miopen/`. More information about the cache can be found [here](https://github.com/ROCmSoftwarePlatform/MIOpen/blob/master/doc/src/cache.md). + + + #### Changing the cmake configuration The configuration can be changed after running cmake by using `ccmake`: diff --git a/doc/src/cache.md b/doc/src/cache.md index 4ab864f724..5828ec2547 100644 --- a/doc/src/cache.md +++ b/doc/src/cache.md @@ -13,3 +13,7 @@ Disabling the cache The are several ways to disable the cache. This is generally useful for development purposes. The cache can be disabled during build by either setting `MIOPEN_CACHE_DIR` to an empty string, or setting `BUILD_DEV=ON` when configuring cmake. The cache can also be disabled at runtime by setting the `MIOPEN_DISABLE_CACHE` environment variable to true. +Updating MIOpen and removing the cache +-------------------------------------- +If the compiler changes, or the user modifies the kernels then the cache must be deleted for the MIOpen version in use; e.g., `rm -rf ~/.cache/miopen/`. + \ No newline at end of file diff --git a/doc/src/perfdatabase.md b/doc/src/perfdatabase.md index ab1c512439..fe8c55b15d 100644 --- a/doc/src/perfdatabase.md +++ b/doc/src/perfdatabase.md @@ -74,3 +74,8 @@ This variable allows for limiting the scope of `MIOPEN_FIND_ENFORCE`, so that on **CONV_BWD (3)** `MIOPEN_FIND_ENFORCE` affects only Backward Data convolutions. **CONV_WRW (4)** `MIOPEN_FIND_ENFORCE` affects only Backward With Regard to Weights (a.k.a. WRW) convolutions. + + +### Updating MIOpen and the User Db + +It is important to note that if the user installs a new version of MIOpen, it is recommended that the user move, or delete their old user performance database file. This will prevent older database entries from polution the configurations shipped with the newer system database. The user can find the file with the suffix `*.updb.txt` in the user perf db path. \ No newline at end of file From ee8f5f69e58bafabed520712aeec37c430c24bba Mon Sep 17 00:00:00 2001 From: Daniel Lowell Date: Wed, 19 Dec 2018 12:10:09 -0600 Subject: [PATCH 2/2] Bumped date on release notes and added an extra note. --- doc/src/releasenotes.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/src/releasenotes.md b/doc/src/releasenotes.md index feee39aebf..af760562ca 100644 --- a/doc/src/releasenotes.md +++ b/doc/src/releasenotes.md @@ -1,17 +1,19 @@ ## MIOpen Release notes -### 12/14/2018 [ 1.7.0 ] +### 12/19/2018 [ 1.7.0 ] - This release contains general bug fixes and an updated performance database - Group convolutions backwards weights performance has been improved - Logging across the library has been improved +- Performance database has been updated Changes: - Fixed logging issues with group convolution and pooling - Fixed sphinx version issue in document generation +- Fixed issues with corrupt entries in performance database - Removed external dependency on libSSL and libCrypto - Added support for large image backwards weights in direct convolution - Added fp16 support for RNNs on the HIP backend