From 7a313c8f908431b337dc36ced1d12930c9d9cf9a Mon Sep 17 00:00:00 2001
From: zhong-al <74470739+zhong-al@users.noreply.github.com>
Date: Fri, 13 Dec 2024 21:08:00 -0500
Subject: [PATCH] Apply suggestions from code review

Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
---
 README.md | 20 ++++++++++++++------
 1 file changed, 14 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 670eb3c..5a48226 100644
--- a/README.md
+++ b/README.md
@@ -98,12 +98,20 @@ miniscene2behavior [--hub huggingface_hub] [--config path_to_config] --checkpoin
 ```
 
 **Notes:**
- - ex: miniscene2behavior --hub imageomics/x3d-kabr-kinetics --checkpoint checkpoint_epoch_00075.pyth.zip --miniscene path_to_miniscene
-  - download checkpoint from huggingface and extract config
- - ex: miniscene2behavior --hub imageomics/x3d-kabr-kinetics --config config.yml --checkpoint checkpoint_epoch_00075.pyth --miniscene path_to_miniscene
-  - download checkpoint and config from huggingface
- - ex: miniscene2behavior --config config.yml --checkpoint checkpoint_epoch_00075.pyth --miniscene path_to_miniscene
-  - use local checkpoint and config
+**Examples:**
+ - download checkpoint from huggingface and extract config ex: 
+ ```
+miniscene2behavior --hub imageomics/x3d-kabr-kinetics --checkpoint checkpoint_epoch_00075.pyth.zip --miniscene path_to_miniscene
+ ```
+ - download checkpoint and config from huggingface ex: 
+```
+miniscene2behavior --hub imageomics/x3d-kabr-kinetics --config config.yml --checkpoint checkpoint_epoch_00075.pyth --miniscene path_to_miniscene
+```
+ - use local checkpoint and config ex: 
+```
+miniscene2behavior --config config.yml --checkpoint checkpoint_epoch_00075.pyth --miniscene path_to_miniscene
+```
+**Notes:**
  - If `gpu_num` is 0, the model will use CPU. Using at least 1 GPU greatly increases inference speed. If you're using OSC, you can request a node with one GPU by running `sbatch -N 1 --gpus-per-node 1 -A [account] --time=[minutes] [bash script]`.
  - mini-scenes are clipped videos focused on individual animals and video is the raw video file from which mini-scenes have been extracted.