完善文档

2023-12-21 19:49:03 +08:00
parent 8d7c68fca4
commit a2c1294ac0
1 changed files with 49 additions and 2 deletions
@@ -1,2 +1,49 @@
-# comfyui-easyapi-nodes
-针对api接口开发补充的一些自定义节点：Base64ToImage  ImageToBase64  LoadImageToBase64
+# ComfyUI Segment Anything
+
+This project is a ComfyUI version of
+`https://github.com/continue-revolution/sd-webui-segment-anything`. At present, only the most core functionalities have been implemented. I would like to express my gratitude to [continue-revolution](https://github.com/continue-revolution) for their preceding work on which this is based.
+
+![example](./docs/images/example.jpg)
+
+I have ensured consistency with `sd-webui-segment-anything` in terms of output when given the same input.
+
+## Requirements
+
+Please ensure that you have installed Python dependencies using the following command:
+```
+pip3 install -r requirements.txt
+```
+
+## Models
+
+The models will be automatically downloaded when used. You can also manually download them according to the table below. If the automatic download is slow, you can set the `HTTP_PROXY` and `HTTPS_PROXY` environment variables to use a proxy.
+
+### GroundingDino
+
+Please directly download the models and configuration files to the `models/grounding-dino` directory under the ComfyUI root directory, without modifying the file names.
+
+| name | size | config file | model file |  
+|-|-|-|-|
+| GroundingDINO_SwinT_OGC | 694MB | [download link](https://huggingface.co/ShilongLiu/GroundingDINO/resolve/main/GroundingDINO_SwinT_OGC.cfg.py) | [download link](https://huggingface.co/ShilongLiu/GroundingDINO/resolve/main/groundingdino_swint_ogc.pth) |
+| GroundingDINO_SwinB | 938MB | [download link](https://huggingface.co/ShilongLiu/GroundingDINO/resolve/main/GroundingDINO_SwinB.cfg.py) | [download link](https://huggingface.co/ShilongLiu/GroundingDINO/resolve/main/groundingdino_swinb_cogcoor.pth) |
+
+### SAM
+
+Please directly download the model files to the `models/sams` directory under the ComfyUI root directory, without modifying the file names.
+
+| name | size | model file |
+|-|-|-|  
+| sam_vit_h | 2.56GB |[download link](https://dl.fbaipublicfiles.com/segment_anything/sam_vit_h_4b8939.pth) |
+| sam_vit_l | 1.25GB |[download link](https://dl.fbaipublicfiles.com/segment_anything/sam_vit_l_0b3195.pth) |
+| sam_vit_b | 375MB |[download link](https://dl.fbaipublicfiles.com/segment_anything/sam_vit_b_01ec64.pth) |  
+| sam_hq_vit_h | 2.57GB |[download link](https://huggingface.co/lkeab/hq-sam/resolve/main/sam_hq_vit_h.pth) |
+| sam_hq_vit_l | 1.25GB |[download link](https://huggingface.co/lkeab/hq-sam/resolve/main/sam_hq_vit_l.pth) |
+| sam_hq_vit_b | 379MB |[download link](https://huggingface.co/lkeab/hq-sam/resolve/main/sam_hq_vit_b.pth) |
+| mobile_sam | 39MB |[download link](https://github.com/ChaoningZhang/MobileSAM/blob/master/weights/mobile_sam.pt) |
+
+
+## Contribution
+
+Thank you for considering to help out with the source code! Welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes!
+
+If you'd like to contribute to this project, please fork, fix, commit and send a pull request for me to review and merge into the main code base.