Nymbo commited on
Commit
a1b59e8
1 Parent(s): 13a1206

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +22 -1
README.md CHANGED
@@ -1,3 +1,24 @@
1
  ---
2
- license: mit
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ tags:
3
+ - text-to-image
4
+ library_name: generic
5
  ---
6
+
7
+ # Text To Image repository template
8
+
9
+ This is a template repository for text to image to support generic inference with Hugging Face Hub generic Inference API. There are two required steps
10
+ 1. Specify the requirements by defining a `requirements.txt` file.
11
+ 2. Implement the `pipeline.py` `__init__` and `__call__` methods. These methods are called by the Inference API. The `__init__` method should load the model and preload all the elements needed for inference (model, processors, tokenizers, etc.). This is only called once. The `__call__` method performs the actual inference. Make sure to follow the same input/output specifications defined in the template for the pipeline to work.
12
+
13
+ Example repos
14
+ * https://huggingface.co/osanseviero/BigGAN-deep-128/blob/main/pipeline.py
15
+
16
+ ## How to start
17
+ First create a repo in https://hf.co/new.
18
+ Then clone this template and push it to your repo.
19
+ ```
20
+ git clone https://huggingface.co/templates/text-to-image
21
+ cd text-to-image
22
+ git remote set-url origin https://huggingface.co/$YOUR_USER/$YOUR_REPO_NAME
23
+ git push --force
24
+ ```