readme: ---
  license: creativeml-openrail-m
  tags:
  - stable-diffusion
  - stable-diffusion-diffusers
  - endpoints-template
  
  extra_gated_prompt: |-
    This model is open access and available to all, with a CreativeML OpenRAIL-M license further specifying rights and usage.
    The CreativeML OpenRAIL License specifies: 
  
    1. You can't use the model to deliberately produce nor share illegal or harmful outputs or content 
    2. CompVis claims no rights on the outputs you generate, you are free to use them and are accountable for their use which must not go against the provisions set in the license
    3. You may re-distribute the weights and use the model commercially and/or as a service. If you do, please be aware you have to include the same use restrictions as the ones in the license and share a copy of the CreativeML OpenRAIL-M to all your users (please read the license entirely and carefully)
    Please read the full license carefully here: https://huggingface.co/spaces/CompVis/stable-diffusion-license
  
  extra_gated_heading: Please read the LICENSE to access this model
  ---
  # Stable Diffusion v1-5 Custom Inference
  This repo is for running diffusion custom inference endpoints with `prompts` and an optional `image` as inputs (Unlike normal text-to-image inference). To 
  achieve this goal, this repo implements a `handler.py` script. For more information regarding custom inference, please visit 
  this [link](https://huggingface.co/docs/inference-endpoints/guides/custom_handler).
  For more information about the model, license and limitations please check the original [model card](https://huggingface.co/runwayml/stable-diffusion-v1-5)
  or diffusion [documentation](https://huggingface.co/docs/diffusers/index).
  
  ### Local test custom handler
  To test custom inference locally, please run the following command:
  ```commandline
   python local_request.py --prompts="whale in the universe" --image="test_image.jpg"
  ``` 
  **Note**: `--image` parameter is optional.
  
  
  