@huggingface/tasks 0.13.5 → 0.13.7

package/src/tasks/zero-shot-object-detection/inference.ts

@@ -12,14 +12,12 @@ export interface ZeroShotObjectDetectionInput {
 	 */
 	inputs: string;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Zero Shot Object Detection
 	 */
 	parameters: ZeroShotObjectDetectionParameters;
 	[property: string]: unknown;
 }
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Zero Shot Object Detection
  */
 export interface ZeroShotObjectDetectionParameters {

package/src/tasks/zero-shot-object-detection/spec/input.json

@@ -10,14 +10,13 @@
 			"type": "string"
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Zero Shot Object Detection",
 			"$ref": "#/$defs/ZeroShotObjectDetectionParameters"
 		}
 	},
 	"$defs": {
 		"ZeroShotObjectDetectionParameters": {
 			"title": "ZeroShotObjectDetectionParameters",
-			"description": "Additional inference parameters for Zero Shot Object Detection",
 			"type": "object",
 			"properties": {
 				"candidate_labels": {

package/dist/commonjs/snippets/curl.spec.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=curl.spec.d.ts.map

package/dist/commonjs/snippets/curl.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"curl.spec.d.ts","sourceRoot":"","sources":["../../../src/snippets/curl.spec.ts"],"names":[],"mappings":""}

package/dist/commonjs/snippets/curl.spec.js

@@ -1,89 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const vitest_1 = require("vitest");
-const curl_js_1 = require("./curl.js");
-(0, vitest_1.describe)("inference API snippets", () => {
-    (0, vitest_1.it)("conversational llm", async () => {
-        const model = {
-            id: "meta-llama/Llama-3.1-8B-Instruct",
-            pipeline_tag: "text-generation",
-            tags: ["conversational"],
-            inference: "",
-        };
-        const snippet = (0, curl_js_1.getCurlInferenceSnippet)(model, "api_token");
-        (0, vitest_1.expect)(snippet.content)
-            .toEqual(`curl 'https://api-inference.huggingface.co/models/meta-llama/Llama-3.1-8B-Instruct/v1/chat/completions' \\
--H "Authorization: Bearer api_token" \\
--H 'Content-Type: application/json' \\
---data '{
-    "model": "meta-llama/Llama-3.1-8B-Instruct",
-    "messages": [
-		{
-			"role": "user",
-			"content": "What is the capital of France?"
-		}
-	],
-    "max_tokens": 500,
-    "stream": true
-}'`);
-    });
-    (0, vitest_1.it)("conversational llm non-streaming", async () => {
-        const model = {
-            id: "meta-llama/Llama-3.1-8B-Instruct",
-            pipeline_tag: "text-generation",
-            tags: ["conversational"],
-            inference: "",
-        };
-        const snippet = (0, curl_js_1.getCurlInferenceSnippet)(model, "api_token", { streaming: false });
-        (0, vitest_1.expect)(snippet.content)
-            .toEqual(`curl 'https://api-inference.huggingface.co/models/meta-llama/Llama-3.1-8B-Instruct/v1/chat/completions' \\
--H "Authorization: Bearer api_token" \\
--H 'Content-Type: application/json' \\
---data '{
-    "model": "meta-llama/Llama-3.1-8B-Instruct",
-    "messages": [
-		{
-			"role": "user",
-			"content": "What is the capital of France?"
-		}
-	],
-    "max_tokens": 500,
-    "stream": false
-}'`);
-    });
-    (0, vitest_1.it)("conversational vlm", async () => {
-        const model = {
-            id: "meta-llama/Llama-3.2-11B-Vision-Instruct",
-            pipeline_tag: "image-text-to-text",
-            tags: ["conversational"],
-            inference: "",
-        };
-        const snippet = (0, curl_js_1.getCurlInferenceSnippet)(model, "api_token");
-        (0, vitest_1.expect)(snippet.content)
-            .toEqual(`curl 'https://api-inference.huggingface.co/models/meta-llama/Llama-3.2-11B-Vision-Instruct/v1/chat/completions' \\
--H "Authorization: Bearer api_token" \\
--H 'Content-Type: application/json' \\
---data '{
-    "model": "meta-llama/Llama-3.2-11B-Vision-Instruct",
-    "messages": [
-		{
-			"role": "user",
-			"content": [
-				{
-					"type": "text",
-					"text": "Describe this image in one sentence."
-				},
-				{
-					"type": "image_url",
-					"image_url": {
-						"url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg"
-					}
-				}
-			]
-		}
-	],
-    "max_tokens": 500,
-    "stream": true
-}'`);
-    });
-});

package/dist/commonjs/snippets/js.spec.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=js.spec.d.ts.map

package/dist/commonjs/snippets/js.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"js.spec.d.ts","sourceRoot":"","sources":["../../../src/snippets/js.spec.ts"],"names":[],"mappings":""}

package/dist/commonjs/snippets/js.spec.js

@@ -1,141 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const vitest_1 = require("vitest");
-const js_js_1 = require("./js.js");
-(0, vitest_1.describe)("inference API snippets", () => {
-    (0, vitest_1.it)("conversational llm", async () => {
-        const model = {
-            id: "meta-llama/Llama-3.1-8B-Instruct",
-            pipeline_tag: "text-generation",
-            tags: ["conversational"],
-            inference: "",
-        };
-        const snippet = (0, js_js_1.getJsInferenceSnippet)(model, "api_token");
-        (0, vitest_1.expect)(snippet[0].content).toEqual(`import { HfInference } from "@huggingface/inference";
-
-const client = new HfInference("api_token");
-
-let out = "";
-
-const stream = client.chatCompletionStream({
-	model: "meta-llama/Llama-3.1-8B-Instruct",
-	messages: [
-		{
-			role: "user",
-			content: "What is the capital of France?"
-		}
-	],
-	max_tokens: 500
-});
-
-for await (const chunk of stream) {
-	if (chunk.choices && chunk.choices.length > 0) {
-		const newContent = chunk.choices[0].delta.content;
-		out += newContent;
-		console.log(newContent);
-	}  
-}`);
-    });
-    (0, vitest_1.it)("conversational llm non-streaming", async () => {
-        const model = {
-            id: "meta-llama/Llama-3.1-8B-Instruct",
-            pipeline_tag: "text-generation",
-            tags: ["conversational"],
-            inference: "",
-        };
-        const snippet = (0, js_js_1.getJsInferenceSnippet)(model, "api_token", { streaming: false });
-        (0, vitest_1.expect)(snippet[0].content).toEqual(`import { HfInference } from "@huggingface/inference";
-
-const client = new HfInference("api_token");
-
-const chatCompletion = await client.chatCompletion({
-	model: "meta-llama/Llama-3.1-8B-Instruct",
-	messages: [
-		{
-			role: "user",
-			content: "What is the capital of France?"
-		}
-	],
-	max_tokens: 500
-});
-
-console.log(chatCompletion.choices[0].message);`);
-    });
-    (0, vitest_1.it)("conversational vlm", async () => {
-        const model = {
-            id: "meta-llama/Llama-3.2-11B-Vision-Instruct",
-            pipeline_tag: "image-text-to-text",
-            tags: ["conversational"],
-            inference: "",
-        };
-        const snippet = (0, js_js_1.getJsInferenceSnippet)(model, "api_token");
-        (0, vitest_1.expect)(snippet[0].content).toEqual(`import { HfInference } from "@huggingface/inference";
-
-const client = new HfInference("api_token");
-
-let out = "";
-
-const stream = client.chatCompletionStream({
-	model: "meta-llama/Llama-3.2-11B-Vision-Instruct",
-	messages: [
-		{
-			role: "user",
-			content: [
-				{
-					type: "text",
-					text: "Describe this image in one sentence."
-				},
-				{
-					type: "image_url",
-					image_url: {
-						url: "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg"
-					}
-				}
-			]
-		}
-	],
-	max_tokens: 500
-});
-
-for await (const chunk of stream) {
-	if (chunk.choices && chunk.choices.length > 0) {
-		const newContent = chunk.choices[0].delta.content;
-		out += newContent;
-		console.log(newContent);
-	}  
-}`);
-    });
-    (0, vitest_1.it)("conversational llm", async () => {
-        const model = {
-            id: "meta-llama/Llama-3.1-8B-Instruct",
-            pipeline_tag: "text-generation",
-            tags: ["conversational"],
-            inference: "",
-        };
-        const snippet = (0, js_js_1.getJsInferenceSnippet)(model, "api_token");
-        (0, vitest_1.expect)(snippet[0].content).toEqual(`import { HfInference } from "@huggingface/inference";
-
-const client = new HfInference("api_token");
-
-let out = "";
-
-const stream = client.chatCompletionStream({
-	model: "meta-llama/Llama-3.1-8B-Instruct",
-	messages: [
-		{
-			role: "user",
-			content: "What is the capital of France?"
-		}
-	],
-	max_tokens: 500
-});
-
-for await (const chunk of stream) {
-	if (chunk.choices && chunk.choices.length > 0) {
-		const newContent = chunk.choices[0].delta.content;
-		out += newContent;
-		console.log(newContent);
-	}  
-}`);
-    });
-});

package/dist/commonjs/snippets/python.spec.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=python.spec.d.ts.map

package/dist/commonjs/snippets/python.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"python.spec.d.ts","sourceRoot":"","sources":["../../../src/snippets/python.spec.ts"],"names":[],"mappings":""}

package/dist/commonjs/snippets/python.spec.js

@@ -1,135 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const vitest_1 = require("vitest");
-const python_js_1 = require("./python.js");
-(0, vitest_1.describe)("inference API snippets", () => {
-    (0, vitest_1.it)("conversational llm", async () => {
-        const model = {
-            id: "meta-llama/Llama-3.1-8B-Instruct",
-            pipeline_tag: "text-generation",
-            tags: ["conversational"],
-            inference: "",
-        };
-        const snippet = (0, python_js_1.getPythonInferenceSnippet)(model, "api_token");
-        (0, vitest_1.expect)(snippet[0].content).toEqual(`from huggingface_hub import InferenceClient
-
-client = InferenceClient(api_key="api_token")
-
-messages = [
-	{
-		"role": "user",
-		"content": "What is the capital of France?"
-	}
-]
-
-stream = client.chat.completions.create(
-    model="meta-llama/Llama-3.1-8B-Instruct", 
-	messages=messages, 
-	max_tokens=500,
-	stream=True
-)
-
-for chunk in stream:
-    print(chunk.choices[0].delta.content, end="")`);
-    });
-    (0, vitest_1.it)("conversational llm non-streaming", async () => {
-        const model = {
-            id: "meta-llama/Llama-3.1-8B-Instruct",
-            pipeline_tag: "text-generation",
-            tags: ["conversational"],
-            inference: "",
-        };
-        const snippet = (0, python_js_1.getPythonInferenceSnippet)(model, "api_token", { streaming: false });
-        (0, vitest_1.expect)(snippet[0].content).toEqual(`from huggingface_hub import InferenceClient
-
-client = InferenceClient(api_key="api_token")
-
-messages = [
-	{
-		"role": "user",
-		"content": "What is the capital of France?"
-	}
-]
-
-completion = client.chat.completions.create(
-    model="meta-llama/Llama-3.1-8B-Instruct", 
-	messages=messages, 
-	max_tokens=500
-)
-
-print(completion.choices[0].message)`);
-    });
-    (0, vitest_1.it)("conversational vlm", async () => {
-        const model = {
-            id: "meta-llama/Llama-3.2-11B-Vision-Instruct",
-            pipeline_tag: "image-text-to-text",
-            tags: ["conversational"],
-            inference: "",
-        };
-        const snippet = (0, python_js_1.getPythonInferenceSnippet)(model, "api_token");
-        (0, vitest_1.expect)(snippet[0].content).toEqual(`from huggingface_hub import InferenceClient
-
-client = InferenceClient(api_key="api_token")
-
-messages = [
-	{
-		"role": "user",
-		"content": [
-			{
-				"type": "text",
-				"text": "Describe this image in one sentence."
-			},
-			{
-				"type": "image_url",
-				"image_url": {
-					"url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg"
-				}
-			}
-		]
-	}
-]
-
-stream = client.chat.completions.create(
-    model="meta-llama/Llama-3.2-11B-Vision-Instruct", 
-	messages=messages, 
-	max_tokens=500,
-	stream=True
-)
-
-for chunk in stream:
-    print(chunk.choices[0].delta.content, end="")`);
-    });
-    (0, vitest_1.it)("text-to-image", async () => {
-        const model = {
-            id: "black-forest-labs/FLUX.1-schnell",
-            pipeline_tag: "text-to-image",
-            tags: [],
-            inference: "",
-        };
-        const snippets = (0, python_js_1.getPythonInferenceSnippet)(model, "api_token");
-        (0, vitest_1.expect)(snippets.length).toEqual(2);
-        (0, vitest_1.expect)(snippets[0].client).toEqual("huggingface_hub");
-        (0, vitest_1.expect)(snippets[0].content).toEqual(`from huggingface_hub import InferenceClient
-client = InferenceClient("black-forest-labs/FLUX.1-schnell", token="api_token")
-
-# output is a PIL.Image object
-image = client.text_to_image("Astronaut riding a horse")`);
-        (0, vitest_1.expect)(snippets[1].client).toEqual("requests");
-        (0, vitest_1.expect)(snippets[1].content).toEqual(`import requests
-
-API_URL = "https://api-inference.huggingface.co/models/black-forest-labs/FLUX.1-schnell"
-headers = {"Authorization": "Bearer api_token"}
-
-def query(payload):
-	response = requests.post(API_URL, headers=headers, json=payload)
-	return response.content
-image_bytes = query({
-	"inputs": "Astronaut riding a horse",
-})
-
-# You can access the image with PIL.Image for example
-import io
-from PIL import Image
-image = Image.open(io.BytesIO(image_bytes))`);
-    });
-});

package/dist/esm/snippets/curl.spec.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=curl.spec.d.ts.map

package/dist/esm/snippets/curl.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"curl.spec.d.ts","sourceRoot":"","sources":["../../../src/snippets/curl.spec.ts"],"names":[],"mappings":""}

package/dist/esm/snippets/curl.spec.js

@@ -1,87 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { getCurlInferenceSnippet } from "./curl.js";
-describe("inference API snippets", () => {
-    it("conversational llm", async () => {
-        const model = {
-            id: "meta-llama/Llama-3.1-8B-Instruct",
-            pipeline_tag: "text-generation",
-            tags: ["conversational"],
-            inference: "",
-        };
-        const snippet = getCurlInferenceSnippet(model, "api_token");
-        expect(snippet.content)
-            .toEqual(`curl 'https://api-inference.huggingface.co/models/meta-llama/Llama-3.1-8B-Instruct/v1/chat/completions' \\
--H "Authorization: Bearer api_token" \\
--H 'Content-Type: application/json' \\
---data '{
-    "model": "meta-llama/Llama-3.1-8B-Instruct",
-    "messages": [
-		{
-			"role": "user",
-			"content": "What is the capital of France?"
-		}
-	],
-    "max_tokens": 500,
-    "stream": true
-}'`);
-    });
-    it("conversational llm non-streaming", async () => {
-        const model = {
-            id: "meta-llama/Llama-3.1-8B-Instruct",
-            pipeline_tag: "text-generation",
-            tags: ["conversational"],
-            inference: "",
-        };
-        const snippet = getCurlInferenceSnippet(model, "api_token", { streaming: false });
-        expect(snippet.content)
-            .toEqual(`curl 'https://api-inference.huggingface.co/models/meta-llama/Llama-3.1-8B-Instruct/v1/chat/completions' \\
--H "Authorization: Bearer api_token" \\
--H 'Content-Type: application/json' \\
---data '{
-    "model": "meta-llama/Llama-3.1-8B-Instruct",
-    "messages": [
-		{
-			"role": "user",
-			"content": "What is the capital of France?"
-		}
-	],
-    "max_tokens": 500,
-    "stream": false
-}'`);
-    });
-    it("conversational vlm", async () => {
-        const model = {
-            id: "meta-llama/Llama-3.2-11B-Vision-Instruct",
-            pipeline_tag: "image-text-to-text",
-            tags: ["conversational"],
-            inference: "",
-        };
-        const snippet = getCurlInferenceSnippet(model, "api_token");
-        expect(snippet.content)
-            .toEqual(`curl 'https://api-inference.huggingface.co/models/meta-llama/Llama-3.2-11B-Vision-Instruct/v1/chat/completions' \\
--H "Authorization: Bearer api_token" \\
--H 'Content-Type: application/json' \\
---data '{
-    "model": "meta-llama/Llama-3.2-11B-Vision-Instruct",
-    "messages": [
-		{
-			"role": "user",
-			"content": [
-				{
-					"type": "text",
-					"text": "Describe this image in one sentence."
-				},
-				{
-					"type": "image_url",
-					"image_url": {
-						"url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg"
-					}
-				}
-			]
-		}
-	],
-    "max_tokens": 500,
-    "stream": true
-}'`);
-    });
-});

package/dist/esm/snippets/js.spec.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=js.spec.d.ts.map

package/dist/esm/snippets/js.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"js.spec.d.ts","sourceRoot":"","sources":["../../../src/snippets/js.spec.ts"],"names":[],"mappings":""}

package/dist/esm/snippets/js.spec.js

@@ -1,139 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { getJsInferenceSnippet } from "./js.js";
-describe("inference API snippets", () => {
-    it("conversational llm", async () => {
-        const model = {
-            id: "meta-llama/Llama-3.1-8B-Instruct",
-            pipeline_tag: "text-generation",
-            tags: ["conversational"],
-            inference: "",
-        };
-        const snippet = getJsInferenceSnippet(model, "api_token");
-        expect(snippet[0].content).toEqual(`import { HfInference } from "@huggingface/inference";
-
-const client = new HfInference("api_token");
-
-let out = "";
-
-const stream = client.chatCompletionStream({
-	model: "meta-llama/Llama-3.1-8B-Instruct",
-	messages: [
-		{
-			role: "user",
-			content: "What is the capital of France?"
-		}
-	],
-	max_tokens: 500
-});
-
-for await (const chunk of stream) {
-	if (chunk.choices && chunk.choices.length > 0) {
-		const newContent = chunk.choices[0].delta.content;
-		out += newContent;
-		console.log(newContent);
-	}  
-}`);
-    });
-    it("conversational llm non-streaming", async () => {
-        const model = {
-            id: "meta-llama/Llama-3.1-8B-Instruct",
-            pipeline_tag: "text-generation",
-            tags: ["conversational"],
-            inference: "",
-        };
-        const snippet = getJsInferenceSnippet(model, "api_token", { streaming: false });
-        expect(snippet[0].content).toEqual(`import { HfInference } from "@huggingface/inference";
-
-const client = new HfInference("api_token");
-
-const chatCompletion = await client.chatCompletion({
-	model: "meta-llama/Llama-3.1-8B-Instruct",
-	messages: [
-		{
-			role: "user",
-			content: "What is the capital of France?"
-		}
-	],
-	max_tokens: 500
-});
-
-console.log(chatCompletion.choices[0].message);`);
-    });
-    it("conversational vlm", async () => {
-        const model = {
-            id: "meta-llama/Llama-3.2-11B-Vision-Instruct",
-            pipeline_tag: "image-text-to-text",
-            tags: ["conversational"],
-            inference: "",
-        };
-        const snippet = getJsInferenceSnippet(model, "api_token");
-        expect(snippet[0].content).toEqual(`import { HfInference } from "@huggingface/inference";
-
-const client = new HfInference("api_token");
-
-let out = "";
-
-const stream = client.chatCompletionStream({
-	model: "meta-llama/Llama-3.2-11B-Vision-Instruct",
-	messages: [
-		{
-			role: "user",
-			content: [
-				{
-					type: "text",
-					text: "Describe this image in one sentence."
-				},
-				{
-					type: "image_url",
-					image_url: {
-						url: "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg"
-					}
-				}
-			]
-		}
-	],
-	max_tokens: 500
-});
-
-for await (const chunk of stream) {
-	if (chunk.choices && chunk.choices.length > 0) {
-		const newContent = chunk.choices[0].delta.content;
-		out += newContent;
-		console.log(newContent);
-	}  
-}`);
-    });
-    it("conversational llm", async () => {
-        const model = {
-            id: "meta-llama/Llama-3.1-8B-Instruct",
-            pipeline_tag: "text-generation",
-            tags: ["conversational"],
-            inference: "",
-        };
-        const snippet = getJsInferenceSnippet(model, "api_token");
-        expect(snippet[0].content).toEqual(`import { HfInference } from "@huggingface/inference";
-
-const client = new HfInference("api_token");
-
-let out = "";
-
-const stream = client.chatCompletionStream({
-	model: "meta-llama/Llama-3.1-8B-Instruct",
-	messages: [
-		{
-			role: "user",
-			content: "What is the capital of France?"
-		}
-	],
-	max_tokens: 500
-});
-
-for await (const chunk of stream) {
-	if (chunk.choices && chunk.choices.length > 0) {
-		const newContent = chunk.choices[0].delta.content;
-		out += newContent;
-		console.log(newContent);
-	}  
-}`);
-    });
-});

package/dist/esm/snippets/python.spec.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=python.spec.d.ts.map

package/dist/esm/snippets/python.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"python.spec.d.ts","sourceRoot":"","sources":["../../../src/snippets/python.spec.ts"],"names":[],"mappings":""}