Create README.md

README.md

@@ -1,10 +1,21 @@
----
-title: LangSAM
-emoji: 🏃
-colorFrom: purple
-colorTo: yellow
-sdk: docker
-pinned: false
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Lang-SAM Deployment
+
+Contains endpoints for Lang-SAM (Language-Segment Anything) model along with SAM2 for advanced image segmentation capabilities. 
+
+## Features
+
+- Language-guided image segmentation using Lang-SAM
+- Advanced segmentation capabilities with SAM2
+- FastAPI backend with CORS support
+- OpenAI integration for product name processing
+
+## API Endpoints
+
+- `GET /`: Health check endpoint
+- `POST /segment/langsam`: Image segmentation endpoint. Accepts Image URL and text input (product name).
+- `POST /segment/sam2`: Image segmentation endpoint. Accepts Image and point input from the UI.
+- `POST /openai/chat`: Product name processing endpoint
+
+
+- Lang-SAM: [GitHub Repository](https://github.com/luca-medeiros/lang-segment-anything)
+- SAM2: [Original Implementation](https://github.com/facebookresearch/segment-anything)