From 831866337841ee0c6655a7305483fc89d33222de Mon Sep 17 00:00:00 2001 From: Kevin Townsend Date: Fri, 22 Oct 2021 23:49:45 +0200 Subject: [PATCH] samples: Minor documentation cleanup Minor documentation cleanup, removing some copy-paste errors, etc. Signed-off-by: Kevin Townsend --- samples/README.md | 2 +- samples/probability/apitest/README.rst | 78 -------------------------- samples/shell/README.rst | 9 --- 3 files changed, 1 insertion(+), 88 deletions(-) delete mode 100644 samples/probability/apitest/README.rst diff --git a/samples/README.md b/samples/README.md index 966dbe9..3db5b18 100644 --- a/samples/README.md +++ b/samples/README.md @@ -1,3 +1,3 @@ # Zephyr Scientific Library Sample Code -TODO: Create table mapping functions to demo sketches +Sample applications demonstrating common use cases for zscilib. \ No newline at end of file diff --git a/samples/probability/apitest/README.rst b/samples/probability/apitest/README.rst deleted file mode 100644 index db2e2b3..0000000 --- a/samples/probability/apitest/README.rst +++ /dev/null @@ -1,78 +0,0 @@ -.. _zscilib-benchmark-sample: - -Probability API Test -#################### - -Overview -******** - -This sample performs a set of calculations repetitively, tracking the time it -takes to execute each set of functions and outputting them in a standard -format to the console. - -It can be used to determine the effect different compiler or device settings -have on code execution on the same or different platforms. - -Accuracy -******** - -When running the benchmarking sample app on an actual ARM Cortex-M3 or M4 -core with the **DWT** peripheral block present, you will get reasonably -accurate benchmark data. - -Using ``qemu_cortex_m3`` or non M3/M4 hardware, the high-precision kernel clock -is used to track execution time, so the benchmark data is approximate and not -comparable across devices. - -Requirements -************ - -Depending on the device you are testing with, you may need to enable or -disable the ``CONFIG_STDOUT_CONSOLE`` flag. - -It should be set to ``y`` when using the emulator, and to ``n`` when running on -real hardware. - -Building and Running -******************** - -To run the benchmarks on the **Cortex M3 emulator**, run the following commands -which will compile the application, run it on the emulator, and output -the result to the console: - -.. code-block:: console - - $ west build -b qemu_cortex_m3 samples/benchmarking/ -t run - -To run the application on real HW, typically outputting the results to the -serial port, you can try a variant of the following, adjusting ``-b`` -as appropriate. - -The **nRF52840 PCA10056** from Nordic Semiconductors is used below: - -.. code-block:: console - - $ west build -b nrf52840_pca10056 samples/benchmarking/ - $ west flash - -Sample Output -************* - -The benchmark application will normally output text resembling the following: - -.. code-block:: console - - ***** Booting Zephyr OS zephyr-v1.14.0-39-ge03905354671 ***** - zscilib benchmark - - BOARD: nrf52840_pca10056 - ZSL VERSION: 0.1.0-prerelease (Apr 29 2019) - CONFIG_ZSL_PLATFORM_OPT: 2 - CONFIG_ZSL_SINGLE_PRECISION: False - CONFIG_ZSL_VECTOR_INLINE: False - CONFIG_ZSL_MATRIX_INLINE: False - CONFIG_ZSL_BOUNDS_CHECKS: True - - zsl_vec_add : 333 cycles - zsl_vec_add : 339 cycles - zsl_vec_add : 339 cycles diff --git a/samples/shell/README.rst b/samples/shell/README.rst index db6d4b7..ffd93d1 100644 --- a/samples/shell/README.rst +++ b/samples/shell/README.rst @@ -59,12 +59,3 @@ To do the same thing using ``west`, run: .. code-block:: console $ west build -p -b nrf52840_pca10056 samples/shell/ - -Sample Output -************* - -This application will normally output text resembling the following: - -.. code-block:: console - - TODO