Add model library to README.md

wkentaro · Feb 7, 2024 · fc07088 · fc07088
1 parent 6d5e812
commit fc07088
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -34,6 +34,25 @@
 pip install osam
 ```
 
+## Quickstart
+
+To run with Efficient-SAM:
+
+```bash
+osam run efficient-sam:25m --image <image_file>
+```
+
+## Model library
+
+Here are models that can be downloaded:
+
+| Model             | Parameters | Size  | Download                     |
+|-------------------|------------|-------|------------------------------|
+| SAM 91M           | 91M        | 100MB | `osam run sam:91m`           |
+| SAM 308M          | 398M       | 320MB | `osam run sam:308m`          |
+| SAM 636M          | 636M       | 630MB | `osam run sam:636m`          |
+| Efficient-SAM 10M | 10M        | 40MB  | `osam run efficient-sam:10m` |
+| Efficient-SAM 25M | 25M        | 100MB | `osam run efficient-sam:25m` |
 
 ## Usage