diff --git a/README.md b/README.md index bbcc301..0c1ab4d 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ *Osam* provides: -- **Segment-Anything Models** - original SAM, Efficient-SAM; +- **Segment-Anything Models** - original SAM, EfficientSAM; - **Local APIs** - CLI & Python & HTTP interface; - **Customization** - Host custom vision models. @@ -32,10 +32,10 @@ pip install osam ## Quickstart -To run with Efficient-SAM: +To run with EfficientSAM: ```bash -osam run efficient-sam --image +osam run efficientsam --image ``` ## Model library @@ -47,10 +47,10 @@ Here are models that can be downloaded: | SAM 91M | 91M | 100MB | `osam run sam:91m` | | SAM 308M | 308M | 320MB | `osam run sam:308m` | | SAM 636M | 636M | 630MB | `osam run sam` | -| Efficient-SAM 10M | 10M | 40MB | `osam run efficient-sam:10m` | -| Efficient-SAM 25M | 25M | 100MB | `osam run efficient-sam` | +| EfficientSAM 10M | 10M | 40MB | `osam run efficientsam:10m` | +| EfficientSAM 25M | 25M | 100MB | `osam run efficientsam` | -PS. `sam`, `efficient-sam` is equivalent to `sam:latest`, `efficient-sam:latest`. +PS. `sam`, `efficientsam` is equivalent to `sam:latest`, `efficientsam:latest`. ## Usage @@ -58,14 +58,14 @@ PS. `sam`, `efficient-sam` is equivalent to `sam:latest`, `efficient-sam:latest` ```bash # Run a model with an image -osam run efficient-sam --image examples/_images/dogs.jpg > output.png +osam run efficientsam --image examples/_images/dogs.jpg > output.png # Get a JSON output -osam run efficient-sam --image examples/_images/dogs.jpg --json -# {"model": "efficient-sam", "mask": "..."} +osam run efficientsam --image examples/_images/dogs.jpg --json +# {"model": "efficientsam", "mask": "..."} # Give a prompt -osam run efficient-sam --image examples/_images/dogs.jpg \ +osam run efficientsam --image examples/_images/dogs.jpg \ --prompt '{"points": [[1439, 504], [1439, 1289]], "point_labels": [1, 1]}' > output.png ``` @@ -79,7 +79,7 @@ import osam.apis import osam.types request = osam.types.GenerateRequest( - model="efficient-sam", + model="efficientsam", image=np.asarray(PIL.Image.open("examples/_images/dogs.jpg")), prompt=osam.types.Prompt(points=[[1439, 504], [1439, 1289]], point_labels=[1, 1]), ) @@ -98,7 +98,7 @@ osam serve # POST request curl 127.0.0.1:11368/api/generate -X POST \ -H "Content-Type: application/json" \ - -d "{\"model\": \"efficient-sam\", \"image\": \"$(cat examples/_images/dogs.jpg | base64)\"}" \ + -d "{\"model\": \"efficientsam\", \"image\": \"$(cat examples/_images/dogs.jpg | base64)\"}" \ | jq -r .mask | base64 --decode > mask.png ```