From 914ca00f899f06191562e894bf96ac54ef51143a Mon Sep 17 00:00:00 2001 From: Rob Armstrong Date: Fri, 28 Mar 2025 15:16:10 -0700 Subject: [PATCH] Small update to README.md to clarify test script usage. --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dfc15946..d284ea4b 100644 --- a/README.md +++ b/README.md @@ -142,7 +142,8 @@ of the previous tags prior to the CMake build system transition in 12.8. ## Running All Samples as Tests It's important to note that the CUDA samples are _not_ intended as a validation suite for CUDA. They do not cover corner cases, they do not completely cover the -runtime and driver APIs, etc. That said, it can sometimes be useful to run all of the samples as a quick sanity check and we provide a script to do so, `run_tests.py`. +runtime and driver APIs, are not intended for performance benchmarking, etc. That said, it can sometimes be useful to run all of the samples as a quick sanity check and +we provide a script to do so, `run_tests.py`. This Python3 script finds all executables in a subdirectory you choose, matching application names with command line arguments specified in `test_args.json`. It accepts the following command line arguments: @@ -181,6 +182,11 @@ Skipping fluidsGL (marked as skip in config) For executables to run one time only with arguments, specify each argument as a list entry. Each entry in the JSON file will be appended to the command line, separated by a space. +All applications execute from their current directory, so all paths are relative to the application's location. + +Note that if an application needs no arguments, this entry is optional. An executable found without a matching entry in the JSON will just run as `./application` from its +current directory. + Configuration example: ```json "ptxgen": { @@ -202,6 +208,8 @@ Running ptxgen For executables to run multiple times with different command line arguments, specify any number of sets of args within a "runs" list. +As with single runs, all applications execute from their current directory, so all paths are relative to the application's location. + Configuration example: ```json "recursiveGaussian": {