[Bot] Update API inference documentation

.github/workflows/api_inference_generate_documentation.yml

@@ -0,0 +1,66 @@
+name: Update API Inference Documentation
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - regenerate-api-inference-docs
+  # schedule:
+  #   - cron: "0 3 * * *" # Every day at 3am
+
+concurrency:
+  group: api_inference_generate_documentation
+  cancel-in-progress: true
+
+jobs:
+  pull_request:
+    runs-on: ubuntu-latest
+    steps:
+      # Setup
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "20"
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          run_install: |
+            - recursive: true
+              cwd: ./scripts/api-inference
+              args: [--frozen-lockfile]
+          package_json_file: ./scripts/api-inference/package.json
+      - name: Update huggingface/tasks package
+        working-directory: ./scripts/api-inference
+        run: |
+          pnpm update @huggingface/tasks@latest
+      # Generate
+      - name: Generate API inference documentation
+        run: pnpm run generate
+        working-directory: ./scripts/api-inference
+
+      # Check changes
+      - name: Check changes
+        run: git status
+
+      # Create or update Pull Request
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ secrets.TOKEN_INFERENCE_SYNC_BOT }}
+          commit-message: Update API inference documentation (automated)
+          branch: update-api-inference-docs-automated-pr
+          delete-branch: true
+          title: "[Bot] Update API inference documentation"
+          body: |
+            This PR automatically regenerates the API inference documentation by running:
+            ```sh
+            cd scripts/api-inference
+            pnpm run generate
+            ```
+
+            This PR was automatically created by the [Update API Inference Documentation workflow](https://github.com/huggingface/hub-docs/blob/main/.github/workflows/api_inference_generate_documentation.yml).
+
+            Please review the changes before merging.
+          reviewers: |
+            Wauplin
+            hanouticelina

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 = "";
 

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(

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

scripts/api-inference/package.json

@@ -1,5 +1,6 @@
 {
   "name": "api-inference-generator",
+  "packageManager": "[email protected]",
   "version": "1.0.0",
   "description": "",
   "main": "index.js",
@@ -13,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",