MayankChoudhary76 commited on
Commit
2122c15
Β·
1 Parent(s): cb8a857

πŸ› οΈ Fix: Add required YAML frontmatter to README for Docker SDK

Browse files
Files changed (1) hide show
  1. README.md +13 -94
README.md CHANGED
@@ -1,100 +1,19 @@
1
- βœ… README.md for Local UI Project Folder
2
-
3
- # 🧠 MMR-Agentic-CoVE β€” Gradio UI (Local Dev / Dockerized)
4
-
5
- This folder contains the **Gradio UI frontend** for the [`MMR-Agentic-CoVE`](https://github.com/MayankChoudhary76/MMR-Agentic-CoVE) recommender system.
6
-
7
- It is designed to connect to an API backend (e.g., `cove-api`) and visualize recommendations from multimodal embeddings, including:
8
-
9
- - πŸ–ΌοΈ Image
10
- - ✍️ Text
11
- - 🏷️ Metadata
12
- - ⚑ FAISS similarity search
13
- - πŸš€ CoVE (Compressed Vocabulary Expansion)
14
- - πŸ’¬ Chat-based interaction
15
-
16
  ---
17
-
18
- ## πŸ—οΈ Project Structure
19
-
20
- cove-ui/
21
- β”‚
22
- β”œβ”€β”€ app.py # Gradio UI logic
23
- β”œβ”€β”€ requirements.txt # Python dependencies
24
- β”œβ”€β”€ Dockerfile # Docker container for Space deployment
25
- β”œβ”€β”€ README.md # (This file)
26
- └── space.yaml # Hugging Face Space config
27
-
28
  ---
29
 
30
- ## βš™οΈ Development Setup
31
-
32
- ### πŸ”Ή Option 1: Run Locally
33
-
34
- > Make sure you have Python 3.11+ and `virtualenv` installed.
35
-
36
- ```bash
37
- # Create environment
38
- python -m venv .venv
39
- source .venv/bin/activate
40
-
41
- # Install dependencies
42
- pip install -r requirements.txt
43
-
44
- # Run the UI
45
- python app.py
46
-
47
- πŸ”Ή Option 2: Docker (Recommended for Hugging Face Space)
48
-
49
- This project uses sdk: docker, which is best for using custom dependencies (like FAISS).
50
-
51
- To test locally:
52
-
53
- docker build -t cove-ui .
54
- docker run -p 7860:7860 cove-ui
55
-
56
- Then open: http://localhost:7860
57
-
58
- βΈ»
59
-
60
- πŸš€ Deployment to Hugging Face Spaces
61
- β€’ This UI is deployed at: https://huggingface.co/spaces/mickey1976/cove-ui
62
- β€’ It uses sdk: docker and connects to a backend API (cove-api) hosted separately:
63
- β€’ https://huggingface.co/spaces/mickey1976/cove-api
64
-
65
- βΈ»
66
-
67
- πŸ”— Related Components
68
-
69
- Component Description
70
- cove-api Backend FastAPI server
71
- mayankc-amazon_beauty_subset Dataset (embeddings, FAISS, model weights, metadata)
72
- MMR-Agentic-CoVE Full codebase on GitHub
73
-
74
-
75
- βΈ»
76
-
77
- 🧩 Notes
78
- β€’ API endpoints like /recommend, /chat_recommend, /users, /defaults, /faiss, /healthz are consumed by this UI.
79
- β€’ CoVE options: "off", "logits", "pure" can be selected for reranking and recommendation.
80
-
81
- βΈ»
82
-
83
- πŸ§ͺ Sample API Check
84
-
85
- Run this to ensure the backend is working:
86
-
87
- curl https://mayank-cove-api.hf.space/healthz
88
-
89
- Expected:
90
-
91
- { "ok": true, "version": "..." }
92
-
93
 
94
- βΈ»
95
 
96
- πŸ‘€ Author
97
- β€’ Mayank Choudhary
98
- M.S. Information Science, University of Arizona
99
- GitHub: @MayankChoudhary76
100
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: MMR-Agentic-CoVE UI
3
+ emoji: 🧠
4
+ colorFrom: pink
5
+ colorTo: indigo
6
+ sdk: docker
7
+ pinned: false
 
 
 
 
 
8
  ---
9
 
10
+ # MMR-Agentic-CoVE β€” Multimodal Recommender (Gradio UI)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
 
12
+ This Hugging Face Space hosts the **Gradio UI** frontend for the [CoVE-based recommender system](https://github.com/MayankChoudhary76/MMR-Agentic-CoVE), showcasing:
13
 
14
+ - Multimodal fusion of image, text, and meta
15
+ - CoVE (Compressed Vocabulary Expansion) support
16
+ - FAISS + re-ranking
17
+ - API-driven UI with user simulation and chat interface
18
 
19
+ > ⚠️ **Backend API must be separately deployed**, e.g., via [cove-api](https://huggingface.co/spaces/mickey1976/cove-api)