@huggingface/tasks 0.14.0 → 0.15.0

package/dist/esm/snippets/js.js

@@ -1,7 +1,45 @@
+import { openAIbaseUrl } from "../inference-providers.js";
 import { stringifyGenerationConfig, stringifyMessages } from "./common.js";
 import { getModelInputSnippet } from "./inputs.js";
-export const snippetBasic = (model, accessToken) => ({
-    content: `async function query(data) {
+const HFJS_METHODS = {
+    "text-classification": "textClassification",
+    "token-classification": "tokenClassification",
+    "table-question-answering": "tableQuestionAnswering",
+    "question-answering": "questionAnswering",
+    translation: "translation",
+    summarization: "summarization",
+    "feature-extraction": "featureExtraction",
+    "text-generation": "textGeneration",
+    "text2text-generation": "textGeneration",
+    "fill-mask": "fillMask",
+    "sentence-similarity": "sentenceSimilarity",
+};
+export const snippetBasic = (model, accessToken, provider) => {
+    return [
+        ...(model.pipeline_tag && model.pipeline_tag in HFJS_METHODS
+            ? [
+                {
+                    client: "huggingface.js",
+                    content: `\
+import { HfInference } from "@huggingface/inference";
+
+const client = new HfInference("${accessToken || `{API_TOKEN}`}");
+
+const output = await client.${HFJS_METHODS[model.pipeline_tag]}({
+	model: "${model.id}",
+	inputs: ${getModelInputSnippet(model)},
+	provider: "${provider}",
+});
+
+console.log(output)
+`,
+                },
+            ]
+            : []),
+        {
+            client: "fetch",
+            content: `\
+async function query(data) {
 	const response = await fetch(
 		"https://api-inference.huggingface.co/models/${model.id}",
 		{
@@ -20,8 +58,10 @@ export const snippetBasic = (model, accessToken) => ({
 query({"inputs": ${getModelInputSnippet(model)}}).then((response) => {
 	console.log(JSON.stringify(response));
 });`,
-});
-export const snippetTextGeneration = (model, accessToken, opts) => {
+        },
+    ];
+};
+export const snippetTextGeneration = (model, accessToken, provider, 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;
@@ -50,6 +90,7 @@ let out = "";
 const stream = client.chatCompletionStream({
 	model: "${model.id}",
 	messages: ${messagesStr},
+	provider: "${provider}",
 	${configStr}
 });
 
@@ -66,8 +107,8 @@ for await (const chunk of stream) {
                     content: `import { OpenAI } from "openai";
 
 const client = new OpenAI({
-	baseURL: "https://api-inference.huggingface.co/v1/",
-    apiKey: "${accessToken || `{API_TOKEN}`}"
+	baseURL: "${openAIbaseUrl(provider)}",
+	apiKey: "${accessToken || `{API_TOKEN}`}"
 });
 
 let out = "";
@@ -100,6 +141,7 @@ const client = new HfInference("${accessToken || `{API_TOKEN}`}");
 const chatCompletion = await client.chatCompletion({
 	model: "${model.id}",
 	messages: ${messagesStr},
+	provider: "${provider}",
 	${configStr}
 });
 
@@ -110,8 +152,8 @@ console.log(chatCompletion.choices[0].message);`,
                     content: `import { OpenAI } from "openai";
 
 const client = new OpenAI({
-    baseURL: "https://api-inference.huggingface.co/v1/",
-    apiKey: "${accessToken || `{API_TOKEN}`}"
+	baseURL: "${openAIbaseUrl(provider)}",
+	apiKey: "${accessToken || `{API_TOKEN}`}"
 });
 
 const chatCompletion = await client.chat.completions.create({
@@ -126,32 +168,58 @@ console.log(chatCompletion.choices[0].message);`,
         }
     }
     else {
-        return snippetBasic(model, accessToken);
+        return snippetBasic(model, accessToken, provider);
     }
 };
-export 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),
+export const snippetZeroShotClassification = (model, accessToken) => {
+    return [
+        {
+            client: "fetch",
+            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;
 		}
-	);
-	const result = await response.json();
-	return result;
-}
+		
+		query({"inputs": ${getModelInputSnippet(model)}, "parameters": {"candidate_labels": ["refund", "legal", "faq"]}}).then((response) => {
+			console.log(JSON.stringify(response));
+		});`,
+        },
+    ];
+};
+export const snippetTextToImage = (model, accessToken, provider) => {
+    return [
+        {
+            client: "huggingface.js",
+            content: `\
+import { HfInference } from "@huggingface/inference";
 
-query({"inputs": ${getModelInputSnippet(model)}, "parameters": {"candidate_labels": ["refund", "legal", "faq"]}}).then((response) => {
-	console.log(JSON.stringify(response));
-});`,
+const client = new HfInference("${accessToken || `{API_TOKEN}`}");
+
+const image = await client.textToImage({
+	model: "${model.id}",
+	inputs: ${getModelInputSnippet(model)},
+	parameters: { num_inference_steps: 5 },
+	provider: "${provider}",
 });
-export const snippetTextToImage = (model, accessToken) => ({
-    content: `async function query(data) {
+/// Use the generated image (it's a Blob)
+`,
+        },
+        ...(provider === "hf-inference"
+            ? [
+                {
+                    client: "fetch",
+                    content: `async function query(data) {
 	const response = await fetch(
 		"https://api-inference.huggingface.co/models/${model.id}",
 		{
@@ -169,8 +237,15 @@ export const snippetTextToImage = (model, accessToken) => ({
 query({"inputs": ${getModelInputSnippet(model)}}).then((response) => {
 	// Use image
 });`,
-});
-export const snippetTextToAudio = (model, accessToken) => {
+                },
+            ]
+            : []),
+    ];
+};
+export const snippetTextToAudio = (model, accessToken, provider) => {
+    if (provider !== "hf-inference") {
+        return [];
+    }
     const commonSnippet = `async function query(data) {
 		const response = await fetch(
 			"https://api-inference.huggingface.co/models/${model.id}",
@@ -184,21 +259,26 @@ export const snippetTextToAudio = (model, accessToken) => {
 			}
 		);`;
     if (model.library_name === "transformers") {
-        return {
-            content: commonSnippet +
-                `
+        return [
+            {
+                client: "fetch",
+                content: commonSnippet +
+                    `
 			const result = await response.blob();
 			return result;
 		}
 		query({"inputs": ${getModelInputSnippet(model)}}).then((response) => {
 			// Returns a byte object of the Audio wavform. Use it directly!
 		});`,
-        };
+            },
+        ];
     }
     else {
-        return {
-            content: commonSnippet +
-                `
+        return [
+            {
+                client: "fetch",
+                content: commonSnippet +
+                    `
 			const result = await response.json();
 			return result;
 		}
@@ -206,11 +286,41 @@ export const snippetTextToAudio = (model, accessToken) => {
 		query({"inputs": ${getModelInputSnippet(model)}}).then((response) => {
 			console.log(JSON.stringify(response));
 		});`,
-        };
+            },
+        ];
     }
 };
-export const snippetFile = (model, accessToken) => ({
-    content: `async function query(filename) {
+export const snippetAutomaticSpeechRecognition = (model, accessToken, provider) => {
+    return [
+        {
+            client: "huggingface.js",
+            content: `\
+import { HfInference } from "@huggingface/inference";
+
+const client = new HfInference("${accessToken || `{API_TOKEN}`}");
+
+const data = fs.readFileSync(${getModelInputSnippet(model)});
+
+const output = await client.automaticSpeechRecognition({
+	data,
+	model: "${model.id}",
+	provider: "${provider}",
+});
+
+console.log(output);
+`,
+        },
+        ...(provider === "hf-inference" ? snippetFile(model, accessToken, provider) : []),
+    ];
+};
+export const snippetFile = (model, accessToken, provider) => {
+    if (provider !== "hf-inference") {
+        return [];
+    }
+    return [
+        {
+            client: "fetch",
+            content: `async function query(filename) {
 	const data = fs.readFileSync(filename);
 	const response = await fetch(
 		"https://api-inference.huggingface.co/models/${model.id}",
@@ -230,9 +340,11 @@ export const snippetFile = (model, accessToken) => ({
 query(${getModelInputSnippet(model)}).then((response) => {
 	console.log(JSON.stringify(response));
 });`,
-});
+        },
+    ];
+};
 export const jsSnippets = {
-    // Same order as in js/src/lib/interfaces/Types.ts
+    // Same order as in tasks/src/pipelines.ts
     "text-classification": snippetBasic,
     "token-classification": snippetBasic,
     "table-question-answering": snippetBasic,
@@ -246,7 +358,7 @@ export const jsSnippets = {
     "text2text-generation": snippetBasic,
     "fill-mask": snippetBasic,
     "sentence-similarity": snippetBasic,
-    "automatic-speech-recognition": snippetFile,
+    "automatic-speech-recognition": snippetAutomaticSpeechRecognition,
     "text-to-image": snippetTextToImage,
     "text-to-speech": snippetTextToAudio,
     "text-to-audio": snippetTextToAudio,
@@ -257,11 +369,8 @@ export const jsSnippets = {
     "object-detection": snippetFile,
     "image-segmentation": snippetFile,
 };
-export function getJsInferenceSnippet(model, accessToken, opts) {
+export function getJsInferenceSnippet(model, accessToken, provider, opts) {
     return model.pipeline_tag && model.pipeline_tag in jsSnippets
-        ? jsSnippets[model.pipeline_tag]?.(model, accessToken, opts) ?? { content: "" }
-        : { content: "" };
-}
-export function hasJsInferenceSnippet(model) {
-    return !!model.pipeline_tag && model.pipeline_tag in jsSnippets;
+        ? jsSnippets[model.pipeline_tag]?.(model, accessToken, provider, opts) ?? []
+        : [];
 }

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

@@ -1,22 +1,22 @@
+import { type InferenceProvider } from "../inference-providers.js";
 import type { PipelineType } from "../pipelines.js";
 import type { ChatCompletionInputMessage, GenerationParameters } from "../tasks/index.js";
 import type { InferenceSnippet, ModelDataMinimal } from "./types.js";
-export declare const snippetConversational: (model: ModelDataMinimal, accessToken: string, opts?: {
+export declare const snippetConversational: (model: ModelDataMinimal, accessToken: string, provider: InferenceProvider, opts?: {
     streaming?: boolean;
     messages?: ChatCompletionInputMessage[];
     temperature?: GenerationParameters["temperature"];
     max_tokens?: GenerationParameters["max_tokens"];
     top_p?: GenerationParameters["top_p"];
 }) => InferenceSnippet[];
-export declare const snippetZeroShotClassification: (model: ModelDataMinimal) => InferenceSnippet;
-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, accessToken: string) => InferenceSnippet[];
-export declare const snippetTabular: (model: ModelDataMinimal) => InferenceSnippet;
-export declare const snippetTextToAudio: (model: ModelDataMinimal) => InferenceSnippet;
-export declare const snippetDocumentQuestionAnswering: (model: ModelDataMinimal) => InferenceSnippet;
-export declare const pythonSnippets: Partial<Record<PipelineType, (model: ModelDataMinimal, accessToken: string, opts?: Record<string, unknown>) => InferenceSnippet | InferenceSnippet[]>>;
-export declare function getPythonInferenceSnippet(model: ModelDataMinimal, accessToken: string, opts?: Record<string, unknown>): InferenceSnippet | InferenceSnippet[];
-export declare function hasPythonInferenceSnippet(model: ModelDataMinimal): boolean;
+export declare const snippetZeroShotClassification: (model: ModelDataMinimal) => InferenceSnippet[];
+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, accessToken: string, provider: InferenceProvider) => InferenceSnippet[];
+export declare const snippetTabular: (model: ModelDataMinimal) => InferenceSnippet[];
+export declare const snippetTextToAudio: (model: ModelDataMinimal) => InferenceSnippet[];
+export declare const snippetDocumentQuestionAnswering: (model: ModelDataMinimal) => InferenceSnippet[];
+export declare const pythonSnippets: Partial<Record<PipelineType, (model: ModelDataMinimal, accessToken: string, provider: InferenceProvider, opts?: Record<string, unknown>) => InferenceSnippet[]>>;
+export declare function getPythonInferenceSnippet(model: ModelDataMinimal, accessToken: string, provider: InferenceProvider, opts?: Record<string, unknown>): InferenceSnippet[];
 //# sourceMappingURL=python.d.ts.map

package/dist/esm/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;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"}
+{"version":3,"file":"python.d.ts","sourceRoot":"","sources":["../../../src/snippets/python.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkD,KAAK,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AACnH,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;AAWrE,eAAO,MAAM,qBAAqB,UAC1B,gBAAgB,eACV,MAAM,YACT,iBAAiB,SACpB;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,EA+FlB,CAAC;AAEF,eAAO,MAAM,6BAA6B,UAAW,gBAAgB,KAAG,gBAAgB,EAcvF,CAAC;AAEF,eAAO,MAAM,kCAAkC,UAAW,gBAAgB,KAAG,gBAAgB,EAoB5F,CAAC;AAEF,eAAO,MAAM,YAAY,UAAW,gBAAgB,KAAG,gBAAgB,EAatE,CAAC;AAEF,eAAO,MAAM,WAAW,UAAW,gBAAgB,KAAG,gBAAgB,EAarE,CAAC;AAEF,eAAO,MAAM,kBAAkB,UACvB,gBAAgB,eACV,MAAM,YACT,iBAAiB,KACzB,gBAAgB,EAqDlB,CAAC;AAEF,eAAO,MAAM,cAAc,UAAW,gBAAgB,KAAG,gBAAgB,EAYxE,CAAC;AAEF,eAAO,MAAM,kBAAkB,UAAW,gBAAgB,KAAG,gBAAgB,EAqC5E,CAAC;AAEF,eAAO,MAAM,gCAAgC,UAAW,gBAAgB,KAAG,gBAAgB,EAgB1F,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,OAAO,CACnC,MAAM,CACL,YAAY,EACZ,CACC,KAAK,EAAE,gBAAgB,EACvB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,iBAAiB,EAC3B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC1B,gBAAgB,EAAE,CACvB,CA8BD,CAAC;AAEF,wBAAgB,yBAAyB,CACxC,KAAK,EAAE,gBAAgB,EACvB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,iBAAiB,EAC3B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,gBAAgB,EAAE,CA+BpB"}