benisonjac commited on
Commit
3aefa78
·
verified ·
1 Parent(s): c323748

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +74 -13
README.md CHANGED
@@ -1,13 +1,74 @@
1
- ---
2
- title: Shoe Generator Hosting
3
- emoji: 🖼
4
- colorFrom: purple
5
- colorTo: red
6
- sdk: gradio
7
- sdk_version: 5.25.2
8
- app_file: app.py
9
- pinned: false
10
- short_description: Our GenAI Project on Text to Image Generation of Shoes
11
- ---
12
-
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Stable Diffusion v1.5 Finetuned on Zappos Shoes (LoRA)
2
+
3
+ This is a finetuned version of Stable Diffusion v1.5, trained with LoRA on the Zappos Shoes Dataset.
4
+ The model is specialized in generating realistic shoe images such as sneakers, boots, and sandals.
5
+
6
+ ## Model Description
7
+
8
+ - **Base model**: [Stable Diffusion v1.5](https://huggingface.co/runwayml/stable-diffusion-v1-5)
9
+ - **Finetuning method**: LoRA
10
+ - **Dataset**: [UT Zappos50K Shoes Dataset](http://vision.cs.utexas.edu/projects/finegrained/utzap50k/)
11
+ - **Primary use**: Generating realistic images of shoes
12
+ - **Optimal hardware**: GPU (for fast inference), but this demo runs on CPU in Hugging Face Spaces
13
+
14
+ ## Example Usage
15
+
16
+ ### Text-to-Image Prompt
17
+
18
+ ```python
19
+ from huggingface_hub import InferenceClient
20
+
21
+ client = InferenceClient("your-username/shoe-generator")
22
+
23
+ image = client.text_to_image("a photo of a high-top sneaker, futuristic design")
24
+ image.save("sneaker.png")
25
+ ```
26
+
27
+ ### Example Prompt
28
+ ```
29
+ a photo of a high-top sneaker, futuristic design
30
+ ```
31
+
32
+ ## Running Locally
33
+
34
+ ### Clone the repo
35
+ ```bash
36
+ git clone https://huggingface.co/your-username/shoe-generator
37
+ cd shoe-generator
38
+ ```
39
+
40
+ ### Install dependencies
41
+ ```bash
42
+ pip install -r requirements.txt
43
+ ```
44
+
45
+ ### Run the app
46
+ ```bash
47
+ python app.py
48
+ ```
49
+
50
+ ### Access the demo
51
+ Open [http://localhost:7860](http://localhost:7860) in your browser.
52
+
53
+ ## Demo (Hugging Face Space)
54
+
55
+ If you want to try it online, you can run the Space here:
56
+ 👉 [Live Demo on Hugging Face Spaces](https://huggingface.co/spaces/your-username/shoe-generator)
57
+
58
+ ## Limitations
59
+
60
+ - Works best for shoe-specific prompts (sneakers, sandals, boots).
61
+ - May not generalize well to unrelated objects.
62
+ - CPU inference is slow compared to GPU.
63
+
64
+ ## License
65
+
66
+ - **Base model license**: [CreativeML Open RAIL-M](https://huggingface.co/spaces/CompVis/stable-diffusion-license)
67
+ - **Dataset**: [UT Zappos50K](http://vision.cs.utexas.edu/projects/finegrained/utzap50k/) (research only)
68
+ - This model is for research and educational purposes only.
69
+
70
+ ## Acknowledgements
71
+
72
+ - [CompVis & RunwayML](https://huggingface.co/runwayml) for Stable Diffusion
73
+ - [UT Austin](http://vision.cs.utexas.edu/) for Zappos50K dataset
74
+ - Hugging Face for hosting