Add result message to and format output of bench-all

extra/bench-all.sh

@@ -17,16 +17,32 @@ printf "Running benchmark for all models\n"
 printf "This can take a while!\n"
 printf "\n"
 
-printf "| CPU | OS | Config | Model | Threads | Total Load | Real Load | Total Encode | Real Encode | Commit |\n"
-printf "| --- | -- | ------ | ----- | ------- | ---------- | --------- | ------------ | ----------- | ------ |\n"
+cat >&2 << EOF
+How to interpret these results:
+- CPU is your CPU model.
+- OS is your current operating system.
+- Model is the GGML model being benchmarked.
+- Threads is the number of threads used.
+- Total Load is the total amount of CPU time whisper took to load the model.
+- Real Load is the real amount of time your computer took to load the model.
+- Total Encode is the total amount of CPU time whisper took to encode the input.
+  If you're using multiple threads, the time spent in each thread will be added together.
+- Real Encode is the real amount of time your computer took to encode the input.
+  This should be approximately (Total Encode / Threads). If it isn't, you likely have another program making use of the CPU.
+- Commit is the current git commit.
+
+EOF
+
+printf "|   CPU   |   OS   | Config |  Model  | Threads | Total Load | Real Load | Total Encode | Real Encode |  Commit  |\n"
+printf "| ------- | ------ | ------ | ------- | ------- | ---------- | --------- | ------------ | ----------- | -------- |\n"
 
 for model in "${models[@]}"; do
     # run once to heat-up the cache
-    ./bench -m ./models/ggml-$model.bin -t $n_threads 2>/dev/null 1>/dev/null
+    ./bench -m "./models/ggml-$model.bin" -t "$n_threads" 2>/dev/null 1>/dev/null
 
     # actual run
     # store stderr output in a variable in order to parse it later
-    output=$(./bench -m ./models/ggml-$model.bin -t $n_threads 2>&1)
+    output=$(./bench -m "./models/ggml-$model.bin" -t "$n_threads" 2>&1)
 
     # parse the output:
     total_load_time=$(echo "$output" | grep "load time" | awk '{print $5}')
@@ -58,6 +74,14 @@ for model in "${models[@]}"; do
 
     commit=$(git rev-parse --short HEAD)
 
-    printf "| <todo> | <todo> | $config | $model | $n_threads | $total_load_time | $real_load_time | $total_encode_time | $real_encode_time | $commit |\n"
+    printf "| <todo>  | <todo> | %-6s | %-7s | %-7s | %-10s | %-9s | %-12s | %-11s | %-8s |\n" \
+        "$config" \
+        "$model" \
+        "$n_threads" \
+        "$total_load_time" \
+        "$real_load_time" \
+        "$total_encode_time" \
+        "$real_encode_time" \
+        "$commit"
 done