From 9ddfce531b968c7c4c984be2e9c5833829dd70ea Mon Sep 17 00:00:00 2001
From: Sharon Fitzpatrick <SF2309@Gmail.Com>
Date: Thu, 9 May 2024 17:31:26 -0700
Subject: [PATCH] update the zoo models web page #208

---
 docs/models.md | 70 ++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 62 insertions(+), 8 deletions(-)

diff --git a/docs/models.md b/docs/models.md
index 401f3b0f..1b81b459 100644
--- a/docs/models.md
+++ b/docs/models.md
@@ -1,17 +1,71 @@
-# Hey this Guide is Under Construction 🚧 👷‍♀️ 🚧
+# The CoastSeg Zoo Workflow
 
-## Check back later when we're finished!! 🏗️
+This workflow can be found in the 'SDS_zoo_classifier.ipynb' notebook.
 
-# 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧
+The models available in this workflow come from [segmentation zoo](https://github.com/Doodleverse/segmentation_zoo) and were trained using [segmentation gym](https://github.com/Doodleverse/segmentation_gym).
 
-# The CoastSeg Zoo Workflow
+## Installation Instructions
 
-This workflow can be found in the 'SDS_zoo_classifier.ipynb' notebook. It is still under active development so use it at your own risk.
+---
 
-The models available in this workflow come from [segmentation zoo](https://github.com/Doodleverse/segmentation_zoo) and were trained using [segmentation gym](https://github.com/Doodleverse/segmentation_gym).
+You'll need to follow the optional set of installation instructions to install the dependencies `tensorflow` and `transformers` into the `coastseg` environment in order to run the models.
+
+**Warning**: The zoo workflow does not support Mac currently due to tensorflow and Mac having numerous compatibility issues. If you would like to help our team support Mac please submit an issue.
+
+**Install Additional Dependencies**
 
-# 🚧 Under development 🚧
+- Only install these dependencies if you plan to use CoastSeg's Zoo workflow notebook.
+- **Warning** installing tensorflow will not work correctly on Mac see for more details [Mac install guide](https://satelliteshorelines.github.io/CoastSeg/mac-install-guide/)
 
-- todo add explanation of each model
+```bash
+pip install tensorflow
+pip install transformers
+```
+
+## Available Models
+
+---
 
 The following image segmentation models are available in CoastSeg to use on downloaded satellite imagery.
+
+## RGB
+
+**1.** `segformer_RGB_4class_8190958` : a segformer model that takes RGB imagery and applies a 4 class segmentation model
+
+    Classes
+
+    - 0: water
+    - 1: whitewater,
+    - 2: sediment,
+    - 3: other
+
+**2.** `sat_RGB_4class_6950472` : a resunet model that takes RGB imagery and applies a 4 class segmentation model
+
+    Classes
+
+    - 0: water
+    - 1: whitewater,
+    - 2: sediment,
+    - 3: other
+
+## NDWI
+
+**1.** `segformer_NDWI_4class_8213427` : a segformer model that takes NDWI imagery and applies a 4 class segmentation model
+
+    Classes
+
+    - 0: water
+    - 1: whitewater,
+    - 2: sediment,
+    - 3: other
+
+## MNDWI
+
+**1.**`segformer_MNDWI_4class_8213443`: a segformer model that takes MNDWI imagery and applies a 4 class segmentation model
+
+    Classes
+
+    - 0: water
+    - 1: whitewater,
+    - 2: sediment,
+    - 3: other