Update README.md

pytorch-labs · Oct 17, 2023 · d8db731 · d8db731
1 parent 1c338ba
commit d8db731
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -27,6 +27,14 @@ Install the package
 pip install ptl-segment-anything-fast
 ```
 
+## Usage
+
+The package acts like a drop-in replacement for segment-anything.
+
+So, for example, if you're currently doing `from segment_anything import sam_model_registry` you should be able to do `from segment_anything_fast import sam_model_registry`.
+
+Please don't be shy to open a Github issue if you're missing functionality or find an issue. Thank you.
+
 ## Results
 
 The results show a waterfall of techniques.