README.md

---
tags:
  - vision
  - image-to-image
  - endpoints-template
inference: false
pipeline_tag: image-to-image
base_model: timbrooks/instruct-pix2pix
library_name: generic
---

# Fork of [timbrooks/instruct-pix2pix](https://huggingface.co/timbrooks/instruct-pix2pix) for an `image-to-image` Inference endpoint.

This repository implements a `custom` task for `image-to-image` with instructions for 🤗 Inference Endpoints. The code for the customized 
pipeline is in the handler.py.

To use deploy this model an Inference Endpoint you have to select `Custom` as task to use the `handler.py` file. 

### expected Request payload

```json
{
  "inputs": encoded_image,
  "parameters": {
    "parameters": {
      "prompt": "what would it look like if it were snowing big time",
      "negative_prompt": "", //default empty
      "num_inference_steps": 10, //default 10 
      "image_guidance_scale": 1.1, //default 1.5 
      "guidance_scale": 9 //default 7.5
    }
  }
}
```

`encoded_image` is a base64 encoded image.