darsoarafa commited on
Commit
72b537d
·
verified ·
1 Parent(s): 7a8c10b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +63 -52
README.md CHANGED
@@ -1,52 +1,63 @@
1
- # Simple Virtual Try-On App using FASHN AI & Gradio
2
-
3
- This repository implements a simple virtual try-on app that uses the Gradio framework and the FASHN API as its backend.
4
-
5
- <p align="center">
6
- <img src="./assets/screenshot.png" alt="app screenshot">
7
- </p>
8
-
9
- ### Sign Up to FASHN
10
- This repository requires an API key from a FASHN account.
11
- Don't have an account yet? [Create an account](https://app.fashn.ai/).
12
-
13
- If you already have an account, go to Settings → API → `+ Create new API key`
14
-
15
- ### Setup
16
-
17
- 1. Clone this repository:
18
- ```bash
19
- git clone https://github.com/fashn-AI/tryon-gradio-app
20
- cd tryon-gradio-app
21
- ```
22
-
23
- 2. Install the required packages:
24
- ```bash
25
- pip install -r requirements.txt
26
- ```
27
-
28
- ### Usage
29
-
30
- 1. Set the environment variable `FASHN_API_KEY` to the API key you created on the FASHN platform.
31
- ```bash
32
- export FASHN_API_KEY="your-api-key"
33
- ```
34
- 2. Run the app:
35
- ```bash
36
- python app.py
37
- ```
38
-
39
- 3. Open your browser and go to `http://localhost:7860/` to see the app in action.
40
-
41
- If you wish to deploy the app or share it with others, you can use the `share` function in Gradio to generate a public link.
42
- More on this can be found in the [Gradio documentation](https://gradio.app/docs).
43
-
44
- ### Helpful Guides and Documentation
45
-
46
- To get the most out of the FASHN API, we recommend to read the following guides to better understand all node features and parameters:
47
- 1. [FASHN Features Guide: Part I (Model & Garment Controls)](https://fashn.ai/blog/getting-the-best-virtual-try-on-results-part-i)
48
- 2. [FASHN Features Guide: Part II (Sampling Controls)](https://fashn.ai/blog/getting-the-best-virtual-try-on-results-part-ii)
49
-
50
- You can also review the official [API Docs](https://docs.fashn.ai/) for a concise summary of each of the parameters function and usage.
51
-
52
-
 
 
 
 
 
 
 
 
 
 
 
 
1
+ metadata
2
+ title: Ammar Virtual Try-On
3
+ emoji: 👕
4
+ colorFrom: purple
5
+ colorTo: gray
6
+ sdk: gradio
7
+ sdk_version: 4.43.0
8
+ app_file: app.py
9
+ pinned: true
10
+ license: apache-2.0
11
+ disable_embedding: true
12
+ # Simple Virtual Try-On App using FASHN AI & Gradio
13
+
14
+ This repository implements a simple virtual try-on app that uses the Gradio framework and the FASHN API as its backend.
15
+
16
+ <p align="center">
17
+ <img src="./assets/screenshot.png" alt="app screenshot">
18
+ </p>
19
+
20
+ ### Sign Up to FASHN
21
+ This repository requires an API key from a FASHN account.
22
+ Don't have an account yet? [Create an account](https://app.fashn.ai/).
23
+
24
+ If you already have an account, go to Settings → API → `+ Create new API key`
25
+
26
+ ### Setup
27
+
28
+ 1. Clone this repository:
29
+ ```bash
30
+ git clone https://github.com/fashn-AI/tryon-gradio-app
31
+ cd tryon-gradio-app
32
+ ```
33
+
34
+ 2. Install the required packages:
35
+ ```bash
36
+ pip install -r requirements.txt
37
+ ```
38
+
39
+ ### Usage
40
+
41
+ 1. Set the environment variable `FASHN_API_KEY` to the API key you created on the FASHN platform.
42
+ ```bash
43
+ export FASHN_API_KEY="your-api-key"
44
+ ```
45
+ 2. Run the app:
46
+ ```bash
47
+ python app.py
48
+ ```
49
+
50
+ 3. Open your browser and go to `http://localhost:7860/` to see the app in action.
51
+
52
+ If you wish to deploy the app or share it with others, you can use the `share` function in Gradio to generate a public link.
53
+ More on this can be found in the [Gradio documentation](https://gradio.app/docs).
54
+
55
+ ### Helpful Guides and Documentation
56
+
57
+ To get the most out of the FASHN API, we recommend to read the following guides to better understand all node features and parameters:
58
+ 1. [FASHN Features Guide: Part I (Model & Garment Controls)](https://fashn.ai/blog/getting-the-best-virtual-try-on-results-part-i)
59
+ 2. [FASHN Features Guide: Part II (Sampling Controls)](https://fashn.ai/blog/getting-the-best-virtual-try-on-results-part-ii)
60
+
61
+ You can also review the official [API Docs](https://docs.fashn.ai/) for a concise summary of each of the parameters function and usage.
62
+
63
+