[Bot] Update API inference documentation (#1489)

* Add ci workflow to auto-generate api inference doc * Update token * add permissions section * change pnpm installation gh action * fix pnpm installation * change working directory * revert * hopefully good * trying with other versions * new tests * pnpm version * do not update .lock file * don't update lock file * fix * explicit package.json * fix lock file * implcit * explicit * update pnpm ? * daily cron job * update huggingface/tasks before generating docs * run workflow on this branch to test * Update API inference documentation (automated) --------- Co-authored-by: Celina Hanouti <[email protected]> Co-authored-by: Wauplin <[email protected]> Co-authored-by: hanouticelina <[email protected]>
huggingface · Nov 18, 2024 · 296b2ea · 296b2ea
1 parent 00462a5
commit 296b2ea
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 34 deletions.
diff --git a/docs/api-inference/tasks/chat-completion.md b/docs/api-inference/tasks/chat-completion.md
@@ -79,7 +79,7 @@ curl 'https://api-inference.huggingface.co/models/google/gemma-2-2b-it/v1/chat/c
 </curl>
 
 <python>
-With huggingface_hub client:
+Using `huggingface_hub`:
 ```py
 from huggingface_hub import InferenceClient
 
@@ -103,7 +103,7 @@ for chunk in stream:
     print(chunk.choices[0].delta.content, end="")
 ```
 
-With openai client:
+Using `openai`:
 ```py
 from openai import OpenAI
 
@@ -134,11 +134,11 @@ To use the Python client, see `huggingface_hub`'s [package reference](https://hu
 </python>
 
 <js>
-With huggingface_hub client:
+Using `huggingface.js`:
 ```js
-import { HfInference } from "@huggingface/inference"
+import { HfInference } from "@huggingface/inference";
 
-const client = new HfInference("hf_***")
+const client = new HfInference("hf_***");
 
 let out = "";
 
@@ -162,14 +162,14 @@ for await (const chunk of stream) {
 }
 ```
 
-With openai client:
+Using `openai`:
 ```js
-import { OpenAI } from "openai"
+import { OpenAI } from "openai";
 
 const client = new OpenAI({
 	baseURL: "https://api-inference.huggingface.co/v1/",
     apiKey: "hf_***"
-})
+});
 
 let out = "";
 
@@ -237,7 +237,7 @@ curl 'https://api-inference.huggingface.co/models/meta-llama/Llama-3.2-11B-Visio
 </curl>
 
 <python>
-With huggingface_hub client:
+Using `huggingface_hub`:
 ```py
 from huggingface_hub import InferenceClient
 
@@ -272,7 +272,7 @@ for chunk in stream:
     print(chunk.choices[0].delta.content, end="")
 ```
 
-With openai client:
+Using `openai`:
 ```py
 from openai import OpenAI
 
@@ -314,11 +314,11 @@ To use the Python client, see `huggingface_hub`'s [package reference](https://hu
 </python>
 
 <js>
-With huggingface_hub client:
+Using `huggingface.js`:
 ```js
-import { HfInference } from "@huggingface/inference"
+import { HfInference } from "@huggingface/inference";
 
-const client = new HfInference("hf_***")
+const client = new HfInference("hf_***");
 
 let out = "";
 
@@ -353,14 +353,14 @@ for await (const chunk of stream) {
 }
 ```
 
-With openai client:
+Using `openai`:
 ```js
-import { OpenAI } from "openai"
+import { OpenAI } from "openai";
 
 const client = new OpenAI({
 	baseURL: "https://api-inference.huggingface.co/v1/",
     apiKey: "hf_***"
-})
+});
 
 let out = "";
 

diff --git a/docs/api-inference/tasks/image-text-to-text.md b/docs/api-inference/tasks/image-text-to-text.md
@@ -45,13 +45,8 @@ curl https://api-inference.huggingface.co/models/meta-llama/Llama-3.2-11B-Vision
 </curl>
 
 <python>
-With huggingface_hub client:
+Using `huggingface_hub`:
 ```py
-import requests
-
-API_URL = "https://api-inference.huggingface.co/models/meta-llama/Llama-3.2-11B-Vision-Instruct"
-headers = {"Authorization": "Bearer hf_***"}
-
 from huggingface_hub import InferenceClient
 
 client = InferenceClient(api_key="hf_***")
@@ -69,13 +64,8 @@ for chunk in stream:
     print(chunk.choices[0].delta.content, end="")
 ```
 
-With openai client:
+Using `openai`:
 ```py
-import requests
-
-API_URL = "https://api-inference.huggingface.co/models/meta-llama/Llama-3.2-11B-Vision-Instruct"
-headers = {"Authorization": "Bearer hf_***"}
-
 from openai import OpenAI
 
 client = OpenAI(

diff --git a/docs/api-inference/tasks/text-to-image.md b/docs/api-inference/tasks/text-to-image.md
@@ -45,6 +45,16 @@ curl https://api-inference.huggingface.co/models/black-forest-labs/FLUX.1-dev \
 </curl>
 
 <python>
+Using `huggingface_hub`:
+```py
+from huggingface_hub import InferenceClient
+client = InferenceClient("black-forest-labs/FLUX.1-dev", token="hf_***")
+
+# output is a PIL.Image object
+image = client.text_to_image("Astronaut riding a horse")
+```
+
+Using `requests`:
 ```py
 import requests
 
@@ -57,6 +67,7 @@ def query(payload):
 image_bytes = query({
 	"inputs": "Astronaut riding a horse",
 })
+
 # You can access the image with PIL.Image for example
 import io
 from PIL import Image

diff --git a/scripts/api-inference/package.json b/scripts/api-inference/package.json
@@ -14,7 +14,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@huggingface/tasks": "^0.12.15",
+    "@huggingface/tasks": "^0.13.3",
     "@types/node": "^22.5.0",
     "handlebars": "^4.7.8",
     "node": "^20.17.0",

diff --git a/scripts/api-inference/pnpm-lock.yaml b/scripts/api-inference/pnpm-lock.yaml