jhj0517 commited on
Commit
b5e4671
·
1 Parent(s): 919f44d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +14 -4
README.md CHANGED
@@ -1,7 +1,7 @@
1
  # sam2-playground
2
  Gradio based Playground Web UI using [facebook/segment-anything-2](https://github.com/facebookresearch/segment-anything-2) models.
3
 
4
- ## Online Demos
5
  <div>
6
  <a href="https://colab.research.google.com/github/jhj0517/sam2-playground/blob/master/notebooks/sam2_playground.ipynb">
7
  <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Colab" style="display:inline-block;">
@@ -48,16 +48,26 @@ To run this Web UI, you need these prerequisites. If you don't have them, please
48
  After installing FFmpeg, **make sure to add the `FFmpeg/bin` folder to your system PATH!** <br>
49
  And for CUDA, if you're not using an Nvidia GPU and CUDA 12.4, edit the [requirements.txt](https://github.com/jhj0517/sam2-playground/blob/master/requirements.txt) to match your environment.
50
 
51
- ### Running with Shell / Batch Scripts
52
  There's a set of shell / batch scripts for installation and running.
53
 
54
  1. Download `sam2-playground.zip` with the file corresponding to your OS from [sam2-playground-portable.zip]() and extract its contents.
55
  2. Run `install.bat` or `install.sh` to install dependencies. (This will create a `venv` directory and install dependencies there.)
56
  3. Start WebUI with `start-webui.bat` or `start-webui.sh`
57
- 4. To update the WebUI, run `update.bat` or `update.sh`
58
 
59
- ### Docker
 
 
 
 
 
 
 
 
 
60
 
 
61
 
62
  ## Todo
63
  - [ ] Support `change()` API for `gradio_image_prompter` and automatically generate preview for video predictor
 
1
  # sam2-playground
2
  Gradio based Playground Web UI using [facebook/segment-anything-2](https://github.com/facebookresearch/segment-anything-2) models.
3
 
4
+ ### Online Demos
5
  <div>
6
  <a href="https://colab.research.google.com/github/jhj0517/sam2-playground/blob/master/notebooks/sam2_playground.ipynb">
7
  <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Colab" style="display:inline-block;">
 
48
  After installing FFmpeg, **make sure to add the `FFmpeg/bin` folder to your system PATH!** <br>
49
  And for CUDA, if you're not using an Nvidia GPU and CUDA 12.4, edit the [requirements.txt](https://github.com/jhj0517/sam2-playground/blob/master/requirements.txt) to match your environment.
50
 
51
+ ### Option 1 : Running with Shell / Batch Scripts
52
  There's a set of shell / batch scripts for installation and running.
53
 
54
  1. Download `sam2-playground.zip` with the file corresponding to your OS from [sam2-playground-portable.zip]() and extract its contents.
55
  2. Run `install.bat` or `install.sh` to install dependencies. (This will create a `venv` directory and install dependencies there.)
56
  3. Start WebUI with `start-webui.bat` or `start-webui.sh`
57
+ 4. To update, run `update.bat` or `update.sh`
58
 
59
+ ### Option 2: Docker
60
+ 1. Build the image ( Image is about ~6 GB )
61
+ ```
62
+ docker compose build
63
+ ```
64
+ 2. Run the container
65
+ ```
66
+ docker compose up
67
+ ```
68
+ 3. Connect to `localhost:7860` with your browser.
69
 
70
+ Update [`docker-compose.yaml`](https://github.com/jhj0517/sam2-playground/blob/master/docker-compose.yaml) to match your environments.
71
 
72
  ## Todo
73
  - [ ] Support `change()` API for `gradio_image_prompter` and automatically generate preview for video predictor