text generation inference infos

README.md

@@ -151,6 +151,40 @@ for i, t in enumerate(generated_text):
     print(f"{i}:\n{t}\n")
 ```
 
+## Text generation inference
+
+The hosted inference API is powered by [Text Generation Inference](https://github.com/huggingface/text-generation-inference). To query the model, you can use the following code snippet. The key is to pass images as fetchable URLs with the markdown syntax:
+```
+from text_generation import Client
+
+API_TOKEN = "<YOUR_API_TOKEN>"
+API_URL = "https://api-inference.huggingface.co/models/HuggingFaceM4/idefics-80b-instruct"
+DECODING_STRATEGY = "Greedy"
+QUERY = "User: What is in this image?![](https://upload.wikimedia.org/wikipedia/commons/8/86/Id%C3%A9fix.JPG)<end_of_utterance>\nAssistant:"
+
+client = Client(
+    base_url=API_URL,
+    headers={"x-use-cache": "0", "Authorization": f"Bearer {API_TOKEN}"},
+)
+generation_args = {
+    "max_new_tokens": 256,
+    "repetition_penalty": 1.0,
+    "stop_sequences": ["<end_of_utterance>", "\nUser:"],
+}
+
+if DECODING_STRATEGY == "Greedy":
+    generation_args["do_sample"] = False
+elif DECODING_STRATEGY == "Top P Sampling":
+    generation_args["temperature"] = 1.
+    generation_args["do_sample"] = True
+    generation_args["top_p"] = 0.95
+    
+generated_text = client.generate(prompt=QUERY, **generation_args)  
+print(generated_text)
+```
+
+Note that we currently only host the inference for the instructed models.
+
 # Training Details
 
 ## IDEFICS