51 lines
2.1 KiB
Markdown
51 lines
2.1 KiB
Markdown
# FASHN Virtual Try-On Node for ComfyUI
|
|
|
|
This repository implements a ComfyUI node for the FASHN AI Virtual Try-On API.
|
|
|
|
<p align="center">
|
|
<img src="screenshot.png" alt="workflow screenshot">
|
|
</p>
|
|
|
|
**Model image** - Generated in the FASHN AI platform <br> **Garment image** - https://www.urbanoutfitters.com/shop/kimchi-blue-katie-mesh-floral-graphic-long-sleeve-tee
|
|
|
|
### Sign Up to FASHN
|
|
This node requires an API key from a FASHN account.
|
|
Don't have an account yet? [Create an account](https://app.fashn.ai/).
|
|
|
|
If you already have an account, go to Settings → API → `+ Create new API key`
|
|
|
|
### Setup
|
|
|
|
You can install this node in 2 ways:
|
|
1. ComfyUI Manager — Search for `FASHN Virtual Try-On` and click `install` <br> —— or ——
|
|
2. Clone the repository into your `custom_nodes` folder in ComfyUI
|
|
```bash
|
|
cd custom_nodes
|
|
git clone https://github.com/fashn-AI/ComfyUI-FASHN.git
|
|
```
|
|
|
|
### Using the API Key
|
|
|
|
You can provide the API key to the node in 2 ways:
|
|
|
|
1. [Recommended] Set the environment variable `FASHN_API_KEY` to the API key you created on the FASHN platform. <br> —— or ——
|
|
2. Directly paste the API key into the node's `fashn_api_key` field. <br> *This is less recommended because you might accidentally expose your API key when sharing your workflow.*
|
|
|
|
### Quick Start
|
|
|
|
An example workflow, as shown in the screenshot above, is provided in a `workflow.json` file in this repository. Alternatively, you can drag-and-drop the following image into ComfyUI:
|
|
|
|
<p align="center">
|
|
<img src="workflow.png" alt="workflow">
|
|
</p>
|
|
|
|
### Helpful Guides and Documentation
|
|
|
|
To get the most out of the FASHN API, we recommend to read the following guides to better understand all node features and parameters:
|
|
1. [FASHN Features Guide: Part I (Model & Garment Controls)](https://fashn.ai/blog/getting-the-best-virtual-try-on-results-part-i)
|
|
2. [FASHN Features Guide: Part II (Sampling Controls)](https://fashn.ai/blog/getting-the-best-virtual-try-on-results-part-ii)
|
|
|
|
You can also review the official [API Docs](https://docs.fashn.ai/) for a concise summary of each of the parameters function and usage.
|
|
|
|
|