Update README.md
Browse files
README.md
CHANGED
@@ -14,7 +14,7 @@ short_description: upload and get π―πaccurate tanishq jewlery recommendatio
|
|
14 |
|
15 |
|
16 |
|
17 |
-
|
18 |
#### project work flow and pipelining:
|
19 |
|
20 |
```markdown
|
@@ -47,66 +47,3 @@ app.py --> frontend/gradio_app.py
|
|
47 |
|
48 |
---
|
49 |
|
50 |
-
### **Explanation of the Structure**
|
51 |
-
- **`app.py`**: The entry point of the application.
|
52 |
-
- Calls `frontend/gradio_app.py` to create the Gradio interface.
|
53 |
-
- **`frontend/gradio_app.py`**: Creates the Gradio interface.
|
54 |
-
- Calls `frontend/input_handlers.py` to process user inputs.
|
55 |
-
- **`frontend/input_handlers.py`**: Handles image inputs (upload, URL, base64).
|
56 |
-
- Calls `backend/jewelry_recomm_service.py` to get recommendations.
|
57 |
-
- Calls `utils/formatter.py` to format the results.
|
58 |
-
- **`backend/jewelry_recomm_service.py`**: Core service for recommendations.
|
59 |
-
- Calls `backend/supportingfiles/model_loader.py` to load models and metadata.
|
60 |
-
- Calls `backend/supportingfiles/image_processor.py` to extract embeddings.
|
61 |
-
- Calls `backend/supportingfiles/recommender.py` to find similar items.
|
62 |
-
- **`backend/supportingfiles/model_loader.py`**: Loads models and metadata.
|
63 |
-
- Uses `config.py` for paths and device settings.
|
64 |
-
- **`backend/supportingfiles/image_processor.py`**: Processes images and extracts embeddings.
|
65 |
-
- Uses `config.py` for image transformations and device settings.
|
66 |
-
- **`backend/supportingfiles/recommender.py`**: Performs similarity search.
|
67 |
-
- Uses `config.py` for default recommendation settings.
|
68 |
-
- **`utils/formatter.py`**: Formats recommendations as HTML or JSON.
|
69 |
-
- **`config.py`**: Contains configuration settings (standalone file).
|
70 |
-
|
71 |
-
---
|
72 |
-
|
73 |
-
### **Why This Works in Markdown**
|
74 |
-
- **Indentation:** Uses spaces or tabs to represent hierarchy.
|
75 |
-
- **Symbols:** Uses `βββ` and `βββ` to visually represent the tree structure.
|
76 |
-
- **Readability:** The structure is clean and easy to follow in Markdown.
|
77 |
-
|
78 |
-
---
|
79 |
-
|
80 |
-
### **How to Use in Hugging Face README**
|
81 |
-
1. Copy the Markdown-compatible hierarchy above.
|
82 |
-
2. Paste it into your Hugging Face README file.
|
83 |
-
3. Save the changes.
|
84 |
-
|
85 |
-
This will display the hierarchy correctly in the README without disrupting the formatting.
|
86 |
-
|
87 |
-
---
|
88 |
-
|
89 |
-
|
90 |
-
```markdown
|
91 |
-
### Project File Hierarchy
|
92 |
-
|
93 |
-
app.py
|
94 |
-
β
|
95 |
-
βββ frontend/gradio_app.py
|
96 |
-
β
|
97 |
-
βββ frontend/input_handlers.py
|
98 |
-
β
|
99 |
-
βββ backend/jewelry_recomm_service.py
|
100 |
-
β β
|
101 |
-
β βββ backend/supportingfiles/model_loader.py
|
102 |
-
β β βββ config.py (INDEX_PATH, METADATA_PATH, DEVICE)
|
103 |
-
β β
|
104 |
-
β βββ backend/supportingfiles/image_processor.py
|
105 |
-
β β βββ config.py (get_image_transform, DEVICE)
|
106 |
-
β β
|
107 |
-
β βββ backend/supportingfiles/recommender.py
|
108 |
-
β βββ config.py (DEFAULT_NUM_RECOMMENDATIONS)
|
109 |
-
β
|
110 |
-
βββ utils/formatter.py (Formats output)
|
111 |
-
β
|
112 |
-
βββ config.py (Standalone configuration file)
|
|
|
14 |
|
15 |
|
16 |
|
17 |
+
---
|
18 |
#### project work flow and pipelining:
|
19 |
|
20 |
```markdown
|
|
|
47 |
|
48 |
---
|
49 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|