Add README for examples

README.md

@@ -164,7 +164,7 @@ For example, to reproduce the results from the banner image on the [VitalLens AP
 python examples/test.py --method=VITALLENS --video_path=examples/sample_video_2.mp4 --vitals_path=examples/sample_vitals_2.csv --api_key=YOUR_API_KEY
 ```
 
-This sample is kindly provided by the [VitalVideos](http://vitalvideos.org) dataset!
+This sample is kindly provided by the [VitalVideos](http://vitalvideos.org) dataset.
 
 ### Example: Use VitalLens API to estimate vitals from a video file
 

examples/README.md

@@ -0,0 +1,21 @@
+# Sample videos with ground truth labels
+
+In this folder, you can find two sample videos to test `vitallens` on.
+Each video has ground truth labels recorded with gold-standard medical equipment.
+
+- `sample_video_1.mp4` which has ground truth labels for PPG Waveform (`ppg`), ECG Waveform (`ecg`), Respiratory Waveform (`resp`), Blood Pressure (`sbp` and `dbp`), Blood Oxygen (`spo2`), Heart Rate (`hr_ecg` - derived from ECG and `hr_ppg` - derived from PPG), Heart Rate Variability (`hrv_sdnn_ecg`), and Respiratory Rate (`rr`).
+- `sample_video_2.mp4` which has ground truth labels for PPG Waveform (`ppg`). This sample is kindly provided by the [VitalVideos](http://vitalvideos.org) dataset.
+
+There is a test script in `test.py` which lets you run vitals estimation and plot the predictions against the ground truth labels.
+Some options are available:
+
+- `method`: Choose from [`VITALLENS`, `POS`, `G`, `CHROM`] (Default: `VITALLENS`)
+- `video_path`: Path to video (Default: `examples/sample_video_1.mp4`)
+- `vitals_path`: Path to gold-standard vitals (Default: `examples/sample_vitals_1.csv`)
+- `api_key`: Pass your API Key. Required if using `method=VITALLENS`.
+
+For example, to reproduce the results from the banner image on the [VitalLens API Webpage](https://www.rouast.com/api/):
+
+```
+python examples/test.py --method=VITALLENS --video_path=examples/sample_video_2.mp4 --vitals_path=examples/sample_vitals_2.csv --api_key=YOUR_API_KEY
+```