Skip to content

Commit

Permalink
add more pages to zoo model page
Browse files Browse the repository at this point in the history
  • Loading branch information
2320sharon committed May 10, 2024
1 parent 9ddfce5 commit e1c0c37
Showing 1 changed file with 38 additions and 20 deletions.
58 changes: 38 additions & 20 deletions docs/models.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ 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).

These models have not been thoroughly tested yet, but testing is underway.

Anyone is encouraged to contribute models. Please visit [Segmentation Zoo](https://github.com/Doodleverse/segmentation_zoo), our repository of models and open a new [Discussion topic](https://github.com/Doodleverse/segmentation_zoo/discussions) and let us know about your model.

## Installation Instructions

---
Expand All @@ -28,44 +32,58 @@ pip install transformers

The following image segmentation models are available in CoastSeg to use on downloaded satellite imagery.

To use each model we first download the model weights from the model's Zenodo release and then initialize the model using these weights.

## RGB

**Recomended Model**

**1.** `segformer_RGB_4class_8190958` : a segformer model that takes RGB imagery and applies a 4 class segmentation model

Classes
- [Zenodo release](https://zenodo.org/records/8190958)

Classes

- 0: water
- 1: whitewater,
- 2: sediment,
- 3: other
- 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
- [Zenodo release](https://zenodo.org/records/6950472)

- 0: water
- 1: whitewater,
- 2: sediment,
- 3: other
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
- [Zenodo release](https://zenodo.org/records/8213427)

Classes

- 0: water
- 1: whitewater,
- 2: sediment,
- 3: other
- 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
- [Zenodo release](https://zenodo.org/records/8213443)

- If you have a study site that you used with the CoastSat classifer that you want to compare the zoo method to use this MNDWI model because the CoastSat method uses the MNDWI threshold to determine the land water interface.

Classes

- 0: water
- 1: whitewater,
- 2: sediment,
- 3: other
- 0: water
- 1: whitewater,
- 2: sediment,
- 3: other

0 comments on commit e1c0c37

Please sign in to comment.