@huggingface/tasks 0.13.5 → 0.13.6

package/src/tasks/table-question-answering/inference.ts

@@ -12,7 +12,7 @@ export interface TableQuestionAnsweringInput {
 	 */
 	inputs: TableQuestionAnsweringInputData;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Table Question Answering
 	 */
 	parameters?: {
 		[key: string]: unknown;

package/src/tasks/table-question-answering/spec/input.json

@@ -28,14 +28,13 @@
 			"required": ["table", "question"]
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Table Question Answering",
 			"$ref": "#/$defs/TableQuestionAnsweringParameters"
 		}
 	},
 	"$defs": {
 		"TableQuestionAnsweringParameters": {
 			"title": "TableQuestionAnsweringParameters",
-			"description": "Additional inference parameters for Table Question Answering",
 			"type": "object",
 			"properties": {}
 		}

package/src/tasks/text-classification/inference.ts

@@ -12,14 +12,12 @@ export interface TextClassificationInput {
 	 */
 	inputs: string;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Text Classification
 	 */
 	parameters?: TextClassificationParameters;
 	[property: string]: unknown;
 }
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Text Classification
  */
 export interface TextClassificationParameters {

package/src/tasks/text-classification/spec/input.json

@@ -10,14 +10,13 @@
 			"type": "string"
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Text Classification",
 			"$ref": "#/$defs/TextClassificationParameters"
 		}
 	},
 	"$defs": {
 		"TextClassificationParameters": {
 			"title": "TextClassificationParameters",
-			"description": "Additional inference parameters for Text Classification",
 			"type": "object",
 			"properties": {
 				"function_to_apply": {

package/src/tasks/text-to-audio/inference.ts

@@ -13,15 +13,13 @@ export interface TextToAudioInput {
 	 */
 	inputs: string;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Text To Audio
 	 */
 	parameters?: TextToAudioParameters;
 	[property: string]: unknown;
 }
 
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Text To Audio
  */
 export interface TextToAudioParameters {
@@ -34,8 +32,6 @@ export interface TextToAudioParameters {
 
 /**
  * Parametrization of the text generation process
- *
- * Ad-hoc parametrization of the text generation process
  */
 export interface GenerationParameters {
 	/**

package/src/tasks/text-to-audio/spec/input.json

@@ -10,14 +10,13 @@
 			"type": "string"
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Text To Audio",
 			"$ref": "#/$defs/TextToAudioParameters"
 		}
 	},
 	"$defs": {
 		"TextToAudioParameters": {
 			"title": "TextToAudioParameters",
-			"description": "Additional inference parameters for Text To Audio",
 			"type": "object",
 			"properties": {
 				"generation_parameters": {

package/src/tasks/text-to-image/inference.ts

@@ -13,15 +13,13 @@ export interface TextToImageInput {
 	 */
 	inputs: string;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Text To Image
 	 */
 	parameters?: TextToImageParameters;
 	[property: string]: unknown;
 }
 
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Text To Image
  */
 export interface TextToImageParameters {

package/src/tasks/text-to-image/spec/input.json

@@ -10,14 +10,13 @@
 			"type": "string"
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Text To Image",
 			"$ref": "#/$defs/TextToImageParameters"
 		}
 	},
 	"$defs": {
 		"TextToImageParameters": {
 			"title": "TextToImageParameters",
-			"description": "Additional inference parameters for Text To Image",
 			"type": "object",
 			"properties": {
 				"guidance_scale": {

package/src/tasks/text-to-speech/inference.ts

@@ -13,15 +13,13 @@ export interface TextToSpeechInput {
 	 */
 	inputs: string;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Text To Speech
 	 */
 	parameters?: TextToSpeechParameters;
 	[property: string]: unknown;
 }
 
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Text To Speech
  */
 export interface TextToSpeechParameters {
@@ -34,8 +32,6 @@ export interface TextToSpeechParameters {
 
 /**
  * Parametrization of the text generation process
- *
- * Ad-hoc parametrization of the text generation process
  */
 export interface GenerationParameters {
 	/**

package/src/tasks/text-to-speech/spec/input.json

@@ -10,14 +10,13 @@
 			"type": "string"
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Text To Speech",
 			"$ref": "#/$defs/TextToSpeechParameters"
 		}
 	},
 	"$defs": {
 		"TextToSpeechParameters": {
 			"title": "TextToSpeechParameters",
-			"description": "Additional inference parameters for Text To Speech",
 			"type": "object",
 			"properties": {
 				"generation_parameters": {

package/src/tasks/text2text-generation/inference.ts

@@ -13,15 +13,13 @@ export interface Text2TextGenerationInput {
 	 */
 	inputs: string;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Text2text Generation
 	 */
 	parameters?: Text2TextGenerationParameters;
 	[property: string]: unknown;
 }
 
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Text2text Generation
  */
 export interface Text2TextGenerationParameters {

package/src/tasks/text2text-generation/spec/input.json

@@ -10,14 +10,13 @@
 			"type": "string"
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Text2text Generation",
 			"$ref": "#/$defs/Text2textGenerationParameters"
 		}
 	},
 	"$defs": {
 		"Text2textGenerationParameters": {
 			"title": "Text2textGenerationParameters",
-			"description": "Additional inference parameters for Text2text Generation",
 			"type": "object",
 			"properties": {
 				"clean_up_tokenization_spaces": {

package/src/tasks/token-classification/inference.ts

@@ -12,14 +12,12 @@ export interface TokenClassificationInput {
 	 */
 	inputs: string;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Token Classification
 	 */
 	parameters?: TokenClassificationParameters;
 	[property: string]: unknown;
 }
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Token Classification
  */
 export interface TokenClassificationParameters {

package/src/tasks/token-classification/spec/input.json

@@ -10,14 +10,13 @@
 			"type": "string"
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Token Classification",
 			"$ref": "#/$defs/TokenClassificationParameters"
 		}
 	},
 	"$defs": {
 		"TokenClassificationParameters": {
 			"title": "TokenClassificationParameters",
-			"description": "Additional inference parameters for Token Classification",
 			"type": "object",
 			"properties": {
 				"ignore_labels": {

package/src/tasks/translation/inference.ts

@@ -13,15 +13,13 @@ export interface TranslationInput {
 	 */
 	inputs: string;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Translation
 	 */
 	parameters?: TranslationParameters;
 	[property: string]: unknown;
 }
 
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Translation
  */
 export interface TranslationParameters {

package/src/tasks/translation/spec/input.json

@@ -10,14 +10,13 @@
 			"type": "string"
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Translation",
 			"$ref": "#/$defs/TranslationParameters"
 		}
 	},
 	"$defs": {
 		"TranslationParameters": {
 			"title": "TranslationParameters",
-			"description": "Additional inference parameters for Translation",
 			"type": "object",
 			"properties": {
 				"src_lang": {

package/src/tasks/video-classification/inference.ts

@@ -12,14 +12,12 @@ export interface VideoClassificationInput {
 	 */
 	inputs: unknown;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Video Classification
 	 */
 	parameters?: VideoClassificationParameters;
 	[property: string]: unknown;
 }
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Video Classification
  */
 export interface VideoClassificationParameters {

package/src/tasks/video-classification/spec/input.json

@@ -9,14 +9,13 @@
 			"description": "The input video data"
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Video Classification",
 			"$ref": "#/$defs/VideoClassificationParameters"
 		}
 	},
 	"$defs": {
 		"VideoClassificationParameters": {
 			"title": "VideoClassificationParameters",
-			"description": "Additional inference parameters for Video Classification",
 			"type": "object",
 			"properties": {
 				"function_to_apply": {

package/src/tasks/visual-question-answering/inference.ts

@@ -12,7 +12,7 @@ export interface VisualQuestionAnsweringInput {
 	 */
 	inputs: VisualQuestionAnsweringInputData;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Visual Question Answering
 	 */
 	parameters?: VisualQuestionAnsweringParameters;
 	[property: string]: unknown;
@@ -32,8 +32,6 @@ export interface VisualQuestionAnsweringInputData {
 	[property: string]: unknown;
 }
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Visual Question Answering
  */
 export interface VisualQuestionAnsweringParameters {

package/src/tasks/visual-question-answering/spec/input.json

@@ -20,14 +20,13 @@
 			"required": ["question", "image"]
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Visual Question Answering",
 			"$ref": "#/$defs/VisualQuestionAnsweringParameters"
 		}
 	},
 	"$defs": {
 		"VisualQuestionAnsweringParameters": {
 			"title": "VisualQuestionAnsweringParameters",
-			"description": "Additional inference parameters for Visual Question Answering",
 			"type": "object",
 			"properties": {
 				"top_k": {

package/src/tasks/zero-shot-classification/inference.ts

@@ -12,14 +12,12 @@ export interface ZeroShotClassificationInput {
 	 */
 	inputs: string;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Zero Shot Classification
 	 */
 	parameters: ZeroShotClassificationParameters;
 	[property: string]: unknown;
 }
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Zero Shot Classification
  */
 export interface ZeroShotClassificationParameters {

package/src/tasks/zero-shot-classification/spec/input.json

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

package/src/tasks/zero-shot-image-classification/inference.ts

@@ -12,14 +12,12 @@ export interface ZeroShotImageClassificationInput {
 	 */
 	inputs: string;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Zero Shot Image Classification
 	 */
 	parameters: ZeroShotImageClassificationParameters;
 	[property: string]: unknown;
 }
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Zero Shot Image Classification
  */
 export interface ZeroShotImageClassificationParameters {

package/src/tasks/zero-shot-image-classification/spec/input.json

@@ -10,14 +10,13 @@
 			"description": "The input image data to classify as a base64-encoded string."
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Zero Shot Image Classification",
 			"$ref": "#/$defs/ZeroShotImageClassificationParameters"
 		}
 	},
 	"$defs": {
 		"ZeroShotImageClassificationParameters": {
 			"title": "ZeroShotImageClassificationParameters",
-			"description": "Additional inference parameters for Zero Shot Image Classification",
 			"type": "object",
 			"properties": {
 				"candidate_labels": {

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":""}