Improved doc

CMU-Perceptual-Computing-Lab · Mar 24, 2018 · 7af0e8e · 7af0e8e
1 parent a22191c
commit 7af0e8e
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 11 deletions.
diff --git a/doc/faq.md b/doc/faq.md
@@ -5,11 +5,12 @@ OpenPose - Frequently Asked Question (FAQ)
 1. [FAQ](#faq)
     1. [Out of Memory Error](#out-of-memory-error)
     2. [Speed Up and Benchmark](#speed-up-and-benchmark)
-    3. [Webcam Slower than Images](#webcam-slower-than-images)
-    4. [Vide/Webcam Not Working](#video-webcam-not-working)
-    5. [Cannot Find OpenPose.dll Error](#cannot-find-openpose.dll-error-windows)
-    6. [Free Invalid Pointer Error](#free-invalid-pointer-error)
-    7. [Source Directory does not Contain CMakeLists.txt (Windows)](#source-directory-does-not-contain-cmakelists.txt-windows)
+    3. [Estimating FPS without Display](#estimating-fps-without-display)
+    4. [Webcam Slower than Images](#webcam-slower-than-images)
+    5. [Vide/Webcam Not Working](#video-webcam-not-working)
+    6. [Cannot Find OpenPose.dll Error](#cannot-find-openpose.dll-error-windows)
+    7. [Free Invalid Pointer Error](#free-invalid-pointer-error)
+    8. [Source Directory does not Contain CMakeLists.txt (Windows)](#source-directory-does-not-contain-cmakelists.txt-windows)
 
 
 
@@ -36,6 +37,11 @@ OpenPose - Frequently Asked Question (FAQ)
 
 
 
+### Estimating FPS without Display
+Check the [doc/installation.md#profiling-speed](./installation.md#profiling-speed) section.
+
+
+
 ### Webcam Slower than Images
 **Q: Webcam is slow** - Using a folder with images matches the speed FPS benchmarks, but the webcam has lower FPS. Note: often on Windows.
 
@@ -74,8 +80,3 @@ Note: OpenPose library is not an executable, but a library. So instead clicking
 **Q: I am getting an error of the type: `The source directory {path to file} does not contain a CMakeLists.txt file.`.**
 
 **A**: You might not have writing access to that folder. If you are in Windows, you should not try to install it in `Program Files`.
-
-
-
-### Estimating FPS without Display
-Check the [doc/installation.md#profiling-speed](./installation.md#profiling-speed) section.
diff --git a/doc/installation.md b/doc/installation.md
@@ -217,7 +217,7 @@ In order to uninstall OpenPose:
 
 ### Optional Settings
 #### Profiling Speed
-In order to obtain speed metrics from the command line while running OpenPose, compile it with the `PROFILER_ENABLED` flag. OpenPose will automatically display time measurements for each subthread after processing `F` frames (by default `F = 1000`, but it can be modified with the `--profile_speed` flag).
+OpenPose displays the FPS in the basic GUI. However, more complex speed metrics can be obtained from the command line while running OpenPose. In order to obtain those, compile OpenPose with the `PROFILER_ENABLED` flag. OpenPose will automatically display time measurements for each subthread after processing `F` frames (by default `F = 1000`, but it can be modified with the `--profile_speed` flag).
 
 - Time measurement for 1 graphic card: The FPS will be the slowest time displayed in your terminal command line (as OpenPose is multi-threaded). Times are in milliseconds, so `FPS = 1000/millisecond_measurement`.
 - Time measurement for >1 graphic cards: Assuming `n` graphic cards, you will have to wait up to `n` x `F` frames to visualize each graphic card speed (as the frames are splitted among them). In addition, the FPS would be: `FPS = minFPS(speed_per_GPU/n, worst_time_measurement_other_than_GPUs)`. For < 4 GPUs, this is usually `FPS = speed_per_GPU/n`.