@huggingface/tasks 0.13.1 → 0.13.3

package/dist/commonjs/snippets/js.js

@@ -0,0 +1,278 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsSnippets = exports.snippetFile = exports.snippetTextToAudio = exports.snippetTextToImage = exports.snippetZeroShotClassification = exports.snippetTextGeneration = exports.snippetBasic = void 0;
+exports.getJsInferenceSnippet = getJsInferenceSnippet;
+exports.hasJsInferenceSnippet = hasJsInferenceSnippet;
+const common_js_1 = require("./common.js");
+const inputs_js_1 = require("./inputs.js");
+const snippetBasic = (model, accessToken) => ({
+    content: `async function query(data) {
+	const response = await fetch(
+		"https://api-inference.huggingface.co/models/${model.id}",
+		{
+			headers: {
+				Authorization: "Bearer ${accessToken || `{API_TOKEN}`}"
+				"Content-Type": "application/json",
+			},
+			method: "POST",
+			body: JSON.stringify(data),
+		}
+	);
+	const result = await response.json();
+	return result;
+}
+
+query({"inputs": ${(0, inputs_js_1.getModelInputSnippet)(model)}}).then((response) => {
+	console.log(JSON.stringify(response));
+});`,
+});
+exports.snippetBasic = snippetBasic;
+const snippetTextGeneration = (model, accessToken, opts) => {
+    if (model.tags.includes("conversational")) {
+        // Conversational model detected, so we display a code snippet that features the Messages API
+        const streaming = opts?.streaming ?? true;
+        const exampleMessages = (0, inputs_js_1.getModelInputSnippet)(model);
+        const messages = opts?.messages ?? exampleMessages;
+        const messagesStr = (0, common_js_1.stringifyMessages)(messages, { indent: "\t" });
+        const config = {
+            ...(opts?.temperature ? { temperature: opts.temperature } : undefined),
+            max_tokens: opts?.max_tokens ?? 500,
+            ...(opts?.top_p ? { top_p: opts.top_p } : undefined),
+        };
+        const configStr = (0, common_js_1.stringifyGenerationConfig)(config, {
+            indent: "\n\t",
+            attributeValueConnector: ": ",
+        });
+        if (streaming) {
+            return [
+                {
+                    client: "huggingface.js",
+                    content: `import { HfInference } from "@huggingface/inference";
+
+const client = new HfInference("${accessToken || `{API_TOKEN}`}");
+
+let out = "";
+
+const stream = client.chatCompletionStream({
+	model: "${model.id}",
+	messages: ${messagesStr},
+	${configStr}
+});
+
+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);
+	}  
+}`,
+                },
+                {
+                    client: "openai",
+                    content: `import { OpenAI } from "openai";
+
+const client = new OpenAI({
+	baseURL: "https://api-inference.huggingface.co/v1/",
+    apiKey: "${accessToken || `{API_TOKEN}`}"
+});
+
+let out = "";
+
+const stream = await client.chat.completions.create({
+	model: "${model.id}",
+	messages: ${messagesStr},
+	${configStr},
+	stream: true,
+});
+
+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);
+	}  
+}`,
+                },
+            ];
+        }
+        else {
+            return [
+                {
+                    client: "huggingface.js",
+                    content: `import { HfInference } from "@huggingface/inference";
+
+const client = new HfInference("${accessToken || `{API_TOKEN}`}");
+
+const chatCompletion = await client.chatCompletion({
+	model: "${model.id}",
+	messages: ${messagesStr},
+	${configStr}
+});
+
+console.log(chatCompletion.choices[0].message);`,
+                },
+                {
+                    client: "openai",
+                    content: `import { OpenAI } from "openai";
+
+const client = new OpenAI({
+    baseURL: "https://api-inference.huggingface.co/v1/",
+    apiKey: "${accessToken || `{API_TOKEN}`}"
+});
+
+const chatCompletion = await client.chat.completions.create({
+	model: "${model.id}",
+	messages: ${messagesStr},
+	${configStr}
+});
+
+console.log(chatCompletion.choices[0].message);`,
+                },
+            ];
+        }
+    }
+    else {
+        return (0, exports.snippetBasic)(model, accessToken);
+    }
+};
+exports.snippetTextGeneration = snippetTextGeneration;
+const snippetZeroShotClassification = (model, accessToken) => ({
+    content: `async function query(data) {
+	const response = await fetch(
+		"https://api-inference.huggingface.co/models/${model.id}",
+		{
+			headers: {
+				Authorization: "Bearer ${accessToken || `{API_TOKEN}`}"
+				"Content-Type": "application/json",
+			},
+			method: "POST",
+			body: JSON.stringify(data),
+		}
+	);
+	const result = await response.json();
+	return result;
+}
+
+query({"inputs": ${(0, inputs_js_1.getModelInputSnippet)(model)}, "parameters": {"candidate_labels": ["refund", "legal", "faq"]}}).then((response) => {
+	console.log(JSON.stringify(response));
+});`,
+});
+exports.snippetZeroShotClassification = snippetZeroShotClassification;
+const snippetTextToImage = (model, accessToken) => ({
+    content: `async function query(data) {
+	const response = await fetch(
+		"https://api-inference.huggingface.co/models/${model.id}",
+		{
+			headers: {
+				Authorization: "Bearer ${accessToken || `{API_TOKEN}`}"
+				"Content-Type": "application/json",
+			},
+			method: "POST",
+			body: JSON.stringify(data),
+		}
+	);
+	const result = await response.blob();
+	return result;
+}
+query({"inputs": ${(0, inputs_js_1.getModelInputSnippet)(model)}}).then((response) => {
+	// Use image
+});`,
+});
+exports.snippetTextToImage = snippetTextToImage;
+const snippetTextToAudio = (model, accessToken) => {
+    const commonSnippet = `async function query(data) {
+		const response = await fetch(
+			"https://api-inference.huggingface.co/models/${model.id}",
+			{
+				headers: {
+					Authorization: "Bearer ${accessToken || `{API_TOKEN}`}"
+					"Content-Type": "application/json",
+				},
+				method: "POST",
+				body: JSON.stringify(data),
+			}
+		);`;
+    if (model.library_name === "transformers") {
+        return {
+            content: commonSnippet +
+                `
+			const result = await response.blob();
+			return result;
+		}
+		query({"inputs": ${(0, inputs_js_1.getModelInputSnippet)(model)}}).then((response) => {
+			// Returns a byte object of the Audio wavform. Use it directly!
+		});`,
+        };
+    }
+    else {
+        return {
+            content: commonSnippet +
+                `
+			const result = await response.json();
+			return result;
+		}
+		
+		query({"inputs": ${(0, inputs_js_1.getModelInputSnippet)(model)}}).then((response) => {
+			console.log(JSON.stringify(response));
+		});`,
+        };
+    }
+};
+exports.snippetTextToAudio = snippetTextToAudio;
+const snippetFile = (model, accessToken) => ({
+    content: `async function query(filename) {
+	const data = fs.readFileSync(filename);
+	const response = await fetch(
+		"https://api-inference.huggingface.co/models/${model.id}",
+		{
+			headers: {
+				Authorization: "Bearer ${accessToken || `{API_TOKEN}`}"
+				"Content-Type": "application/json",
+			},
+			method: "POST",
+			body: data,
+		}
+	);
+	const result = await response.json();
+	return result;
+}
+
+query(${(0, inputs_js_1.getModelInputSnippet)(model)}).then((response) => {
+	console.log(JSON.stringify(response));
+});`,
+});
+exports.snippetFile = snippetFile;
+exports.jsSnippets = {
+    // Same order as in js/src/lib/interfaces/Types.ts
+    "text-classification": exports.snippetBasic,
+    "token-classification": exports.snippetBasic,
+    "table-question-answering": exports.snippetBasic,
+    "question-answering": exports.snippetBasic,
+    "zero-shot-classification": exports.snippetZeroShotClassification,
+    translation: exports.snippetBasic,
+    summarization: exports.snippetBasic,
+    "feature-extraction": exports.snippetBasic,
+    "text-generation": exports.snippetTextGeneration,
+    "image-text-to-text": exports.snippetTextGeneration,
+    "text2text-generation": exports.snippetBasic,
+    "fill-mask": exports.snippetBasic,
+    "sentence-similarity": exports.snippetBasic,
+    "automatic-speech-recognition": exports.snippetFile,
+    "text-to-image": exports.snippetTextToImage,
+    "text-to-speech": exports.snippetTextToAudio,
+    "text-to-audio": exports.snippetTextToAudio,
+    "audio-to-audio": exports.snippetFile,
+    "audio-classification": exports.snippetFile,
+    "image-classification": exports.snippetFile,
+    "image-to-text": exports.snippetFile,
+    "object-detection": exports.snippetFile,
+    "image-segmentation": exports.snippetFile,
+};
+function getJsInferenceSnippet(model, accessToken, opts) {
+    return model.pipeline_tag && model.pipeline_tag in exports.jsSnippets
+        ? exports.jsSnippets[model.pipeline_tag]?.(model, accessToken, opts) ?? { content: "" }
+        : { content: "" };
+}
+function hasJsInferenceSnippet(model) {
+    return !!model.pipeline_tag && model.pipeline_tag in exports.jsSnippets;
+}

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

@@ -0,0 +1,141 @@
+"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/{src → commonjs}/snippets/python.d.ts

@@ -12,7 +12,7 @@ export declare const snippetZeroShotClassification: (model: ModelDataMinimal) =>
 export declare const snippetZeroShotImageClassification: (model: ModelDataMinimal) => InferenceSnippet;
 export declare const snippetBasic: (model: ModelDataMinimal) => InferenceSnippet;
 export declare const snippetFile: (model: ModelDataMinimal) => InferenceSnippet;
-export declare const snippetTextToImage: (model: ModelDataMinimal) => InferenceSnippet;
+export declare const snippetTextToImage: (model: ModelDataMinimal, accessToken: string) => InferenceSnippet[];
 export declare const snippetTabular: (model: ModelDataMinimal) => InferenceSnippet;
 export declare const snippetTextToAudio: (model: ModelDataMinimal) => InferenceSnippet;
 export declare const snippetDocumentQuestionAnswering: (model: ModelDataMinimal) => InferenceSnippet;

package/dist/{src → commonjs}/snippets/python.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"python.d.ts","sourceRoot":"","sources":["../../../src/snippets/python.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,KAAK,EAAE,0BAA0B,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAG1F,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAErE,eAAO,MAAM,qBAAqB,UAC1B,gBAAgB,eACV,MAAM,SACZ;IACN,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,0BAA0B,EAAE,CAAC;IACxC,WAAW,CAAC,EAAE,oBAAoB,CAAC,aAAa,CAAC,CAAC;IAClD,UAAU,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,CAAC;IAChD,KAAK,CAAC,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;CACtC,KACC,gBAAgB,EAiGlB,CAAC;AAEF,eAAO,MAAM,6BAA6B,UAAW,gBAAgB,KAAG,gBAStE,CAAC;AAEH,eAAO,MAAM,kCAAkC,UAAW,gBAAgB,KAAG,gBAe3E,CAAC;AAEH,eAAO,MAAM,YAAY,UAAW,gBAAgB,KAAG,gBAQrD,CAAC;AAEH,eAAO,MAAM,WAAW,UAAW,gBAAgB,KAAG,gBAQpD,CAAC;AAEH,eAAO,MAAM,kBAAkB,UAAW,gBAAgB,KAAG,gBAW3D,CAAC;AAEH,eAAO,MAAM,cAAc,UAAW,gBAAgB,KAAG,gBAOvD,CAAC;AAEH,eAAO,MAAM,kBAAkB,UAAW,gBAAgB,KAAG,gBA+B5D,CAAC;AAEF,eAAO,MAAM,gCAAgC,UAAW,gBAAgB,KAAG,gBAWzE,CAAC;AAEH,eAAO,MAAM,cAAc,EAAE,OAAO,CACnC,MAAM,CACL,YAAY,EACZ,CACC,KAAK,EAAE,gBAAgB,EACvB,WAAW,EAAE,MAAM,EACnB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC1B,gBAAgB,GAAG,gBAAgB,EAAE,CAC1C,CA8BD,CAAC;AAEF,wBAAgB,yBAAyB,CACxC,KAAK,EAAE,gBAAgB,EACvB,WAAW,EAAE,MAAM,EACnB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,gBAAgB,GAAG,gBAAgB,EAAE,CAwBvC;AAED,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAE1E"}
+{"version":3,"file":"python.d.ts","sourceRoot":"","sources":["../../../src/snippets/python.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,KAAK,EAAE,0BAA0B,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAG1F,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAOrE,eAAO,MAAM,qBAAqB,UAC1B,gBAAgB,eACV,MAAM,SACZ;IACN,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,0BAA0B,EAAE,CAAC;IACxC,WAAW,CAAC,EAAE,oBAAoB,CAAC,aAAa,CAAC,CAAC;IAClD,UAAU,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,CAAC;IAChD,KAAK,CAAC,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;CACtC,KACC,gBAAgB,EAiGlB,CAAC;AAEF,eAAO,MAAM,6BAA6B,UAAW,gBAAgB,KAAG,gBAStE,CAAC;AAEH,eAAO,MAAM,kCAAkC,UAAW,gBAAgB,KAAG,gBAe3E,CAAC;AAEH,eAAO,MAAM,YAAY,UAAW,gBAAgB,KAAG,gBAQrD,CAAC;AAEH,eAAO,MAAM,WAAW,UAAW,gBAAgB,KAAG,gBAQpD,CAAC;AAEH,eAAO,MAAM,kBAAkB,UAAW,gBAAgB,eAAe,MAAM,KAAG,gBAAgB,EAqBjG,CAAC;AAEF,eAAO,MAAM,cAAc,UAAW,gBAAgB,KAAG,gBAOvD,CAAC;AAEH,eAAO,MAAM,kBAAkB,UAAW,gBAAgB,KAAG,gBA+B5D,CAAC;AAEF,eAAO,MAAM,gCAAgC,UAAW,gBAAgB,KAAG,gBAWzE,CAAC;AAEH,eAAO,MAAM,cAAc,EAAE,OAAO,CACnC,MAAM,CACL,YAAY,EACZ,CACC,KAAK,EAAE,gBAAgB,EACvB,WAAW,EAAE,MAAM,EACnB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC1B,gBAAgB,GAAG,gBAAgB,EAAE,CAC1C,CA8BD,CAAC;AAEF,wBAAgB,yBAAyB,CACxC,KAAK,EAAE,gBAAgB,EACvB,WAAW,EAAE,MAAM,EACnB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,gBAAgB,GAAG,gBAAgB,EAAE,CA0BvC;AAED,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAE1E"}