@huggingface/tasks 0.2.2 → 0.3.0

package/src/tasks/automatic-speech-recognition/spec/input.json

@@ -5,7 +5,7 @@
 	"title": "AutomaticSpeechRecognitionInput",
 	"type": "object",
 	"properties": {
-		"data": {
+		"inputs": {
 			"description": "The input audio data"
 		},
 		"parameters": {
@@ -19,7 +19,7 @@
 			"description": "Additional inference parameters for Automatic Speech Recognition",
 			"type": "object",
 			"properties": {
-				"returnTimestamps": {
+				"return_timestamps": {
 					"type": "boolean",
 					"description": "Whether to output corresponding timestamps with the generated text"
 				},
@@ -30,5 +30,5 @@
 			}
 		}
 	},
-	"required": ["data"]
+	"required": ["inputs"]
 }

package/src/tasks/automatic-speech-recognition/spec/output.json

@@ -3,34 +3,36 @@
 	"$schema": "http://json-schema.org/draft-06/schema#",
 	"description": "Outputs of inference for the Automatic Speech Recognition task",
 	"title": "AutomaticSpeechRecognitionOutput",
-	"type": "array",
-	"items": {
-		"type": "object",
-		"properties": {
-			"text": {
-				"type": "string",
-				"description": "The recognized text."
-			},
-			"chunks": {
-				"type": "array",
-				"description": "When returnTimestamps is enabled, chunks contains a list of audio chunks identified by the model.",
-				"items": {
-					"type": "object",
-					"title": "AutomaticSpeechRecognitionOutputChunk",
-					"properties": {
-						"text": { "type": "string", "description": "A chunk of text identified by the model" },
-						"timestamps": {
-							"type": "array",
-							"description": "The start and end timestamps corresponding with the text",
-							"items": { "type": "number" },
-							"minLength": 2,
-							"maxLength": 2
-						}
+	"type": "object",
+	"properties": {
+		"text": {
+			"type": "string",
+			"description": "The recognized text."
+		},
+		"chunks": {
+			"type": "array",
+			"description": "When returnTimestamps is enabled, chunks contains a list of audio chunks identified by the model.",
+			"items": {
+				"type": "object",
+				"title": "AutomaticSpeechRecognitionOutputChunk",
+				"properties": {
+					"text": {
+						"type": "string",
+						"description": "A chunk of text identified by the model"
 					},
-					"required": ["text", "timestamps"]
-				}
+					"timestamps": {
+						"type": "array",
+						"description": "The start and end timestamps corresponding with the text",
+						"items": {
+							"type": "number"
+						},
+						"minLength": 2,
+						"maxLength": 2
+					}
+				},
+				"required": ["text", "timestamps"]
 			}
-		},
-		"required": ["text"]
-	}
+		}
+	},
+	"required": ["text"]
 }

package/src/tasks/common-definitions.json

@@ -43,63 +43,71 @@
 					"type": "number",
 					"description": "The value used to modulate the next token probabilities."
 				},
-				"topK": {
+				"top_k": {
 					"type": "integer",
 					"description": "The number of highest probability vocabulary tokens to keep for top-k-filtering."
 				},
-				"topP": {
+				"top_p": {
 					"type": "number",
 					"description": "If set to float < 1, only the smallest set of most probable tokens with probabilities that add up to top_p or higher are kept for generation."
 				},
-				"typicalP": {
+				"typical_p": {
 					"type": "number",
 					"description": " Local typicality measures how similar the conditional probability of predicting a target token next is to the expected conditional probability of predicting a random token next, given the partial text already generated. If set to float < 1, the smallest set of the most locally typical tokens with probabilities that add up to typical_p or higher are kept for generation. See [this paper](https://hf.co/papers/2202.00666) for more details."
 				},
-				"epsilonCutoff": {
+				"epsilon_cutoff": {
 					"type": "number",
 					"description": "If set to float strictly between 0 and 1, only tokens with a conditional probability greater than epsilon_cutoff will be sampled. In the paper, suggested values range from 3e-4 to 9e-4, depending on the size of the model. See [Truncation Sampling as Language Model Desmoothing](https://hf.co/papers/2210.15191) for more details."
 				},
-				"etaCutoff": {
+				"eta_cutoff": {
 					"type": "number",
 					"description": "Eta sampling is a hybrid of locally typical sampling and epsilon sampling. If set to float strictly between 0 and 1, a token is only considered if it is greater than either eta_cutoff or sqrt(eta_cutoff) * exp(-entropy(softmax(next_token_logits))). The latter term is intuitively the expected next token probability, scaled by sqrt(eta_cutoff). In the paper, suggested values range from 3e-4 to 2e-3, depending on the size of the model. See [Truncation Sampling as Language Model Desmoothing](https://hf.co/papers/2210.15191) for more details."
 				},
-				"maxLength": {
+				"max_length": {
 					"type": "integer",
 					"description": "The maximum length (in tokens) of the generated text, including the input."
 				},
-				"maxNewTokens": {
+				"max_new_tokens": {
 					"type": "integer",
 					"description": "The maximum number of tokens to generate. Takes precedence over maxLength."
 				},
-				"minLength": {
+				"min_length": {
 					"type": "integer",
 					"description": "The minimum length (in tokens) of the generated text, including the input."
 				},
-				"minNewTokens": {
+				"min_new_tokens": {
 					"type": "integer",
 					"description": "The minimum number of tokens to generate. Takes precedence over maxLength."
 				},
-				"doSample": {
+				"do_sample": {
 					"type": "boolean",
 					"description": "Whether to use sampling instead of greedy decoding when generating new tokens."
 				},
-				"earlyStopping": {
+				"early_stopping": {
 					"description": "Controls the stopping condition for beam-based methods.",
-					"oneOf": [{ "type": "boolean" }, { "const": "never", "type": "string" }]
-				},
-				"numBeams": {
+					"oneOf": [
+						{
+							"type": "boolean"
+						},
+						{
+							"const": "never",
+							"type": "string"
+						}
+					]
+				},
+				"num_beams": {
 					"type": "integer",
 					"description": "Number of beams to use for beam search."
 				},
-				"numBeamGroups": {
+				"num_beam_groups": {
 					"type": "integer",
 					"description": "Number of groups to divide num_beams into in order to ensure diversity among different groups of beams. See [this paper](https://hf.co/papers/1610.02424) for more details."
 				},
-				"penaltyAlpha": {
+				"penalty_alpha": {
 					"type": "number",
 					"description": "The value balances the model confidence and the degeneration penalty in contrastive search decoding."
 				},
-				"useCache": {
+				"use_cache": {
 					"type": "boolean",
 					"description": "Whether the model should use the past last key/values attentions to speed up decoding"
 				}

package/src/tasks/depth-estimation/inference.ts

@@ -4,8 +4,6 @@
  * Using src/scripts/inference-codegen
  */
 
-export type DepthEstimationOutput = unknown[];
-
 /**
  * Inputs for Depth Estimation inference
  */
@@ -13,23 +11,25 @@ export interface DepthEstimationInput {
 	/**
 	 * The input image data
 	 */
-	data: unknown;
+	inputs: unknown;
 	/**
 	 * Additional inference parameters
 	 */
-	parameters?: DepthEstimationParameters;
+	parameters?: { [key: string]: unknown };
 	[property: string]: unknown;
 }
 
 /**
- * Additional inference parameters
- *
- * Additional inference parameters for Depth Estimation
+ * Outputs of inference for the Depth Estimation task
  */
-export interface DepthEstimationParameters {
+export interface DepthEstimationOutput {
+	/**
+	 * The predicted depth as an image
+	 */
+	depth?: unknown;
 	/**
-	 * When specified, limits the output to the top K most probable classes.
+	 * The predicted depth as a tensor
 	 */
-	topK?: number;
+	predicted_depth?: unknown;
 	[property: string]: unknown;
 }

package/src/tasks/depth-estimation/spec/input.json

@@ -5,7 +5,7 @@
 	"title": "DepthEstimationInput",
 	"type": "object",
 	"properties": {
-		"data": {
+		"inputs": {
 			"description": "The input image data"
 		},
 		"parameters": {
@@ -18,13 +18,8 @@
 			"title": "DepthEstimationParameters",
 			"description": "Additional inference parameters for Depth Estimation",
 			"type": "object",
-			"properties": {
-				"topK": {
-					"type": "integer",
-					"description": "When specified, limits the output to the top K most probable classes."
-				}
-			}
+			"properties": {}
 		}
 	},
-	"required": ["data"]
+	"required": ["inputs"]
 }

package/src/tasks/depth-estimation/spec/output.json

@@ -3,8 +3,14 @@
 	"$schema": "http://json-schema.org/draft-06/schema#",
 	"description": "Outputs of inference for the Depth Estimation task",
 	"title": "DepthEstimationOutput",
-	"type": "array",
-	"items": {
-		"description": "The output depth labels"
+
+	"type": "object",
+	"properties": {
+		"predicted_depth": {
+			"description": "The predicted depth as a tensor"
+		},
+		"depth": {
+			"description": "The predicted depth as an image"
+		}
 	}
 }

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

@@ -10,7 +10,7 @@ export interface DocumentQuestionAnsweringInput {
 	/**
 	 * One (document, question) pair to answer
 	 */
-	data: DocumentQuestionAnsweringInputData;
+	inputs: DocumentQuestionAnsweringInputData;
 	/**
 	 * Additional inference parameters
 	 */
@@ -42,11 +42,11 @@ export interface DocumentQuestionAnsweringParameters {
 	 * be split in several chunks with some overlap. This argument controls the size of that
 	 * overlap.
 	 */
-	docStride?: number;
+	doc_stride?: number;
 	/**
 	 * Whether to accept impossible as an answer
 	 */
-	handleImpossibleAnswer?: boolean;
+	handle_impossible_answer?: boolean;
 	/**
 	 * Language to use while running OCR. Defaults to english.
 	 */
@@ -55,27 +55,27 @@ export interface DocumentQuestionAnsweringParameters {
 	 * The maximum length of predicted answers (e.g., only answers with a shorter length are
 	 * considered).
 	 */
-	maxAnswerLen?: number;
+	max_answer_len?: number;
 	/**
 	 * The maximum length of the question after tokenization. It will be truncated if needed.
 	 */
-	maxQuestionLen?: number;
+	max_question_len?: number;
 	/**
 	 * The maximum length of the total sentence (context + question) in tokens of each chunk
 	 * passed to the model. The context will be split in several chunks (using doc_stride as
 	 * overlap) if needed.
 	 */
-	maxSeqLen?: number;
+	max_seq_len?: number;
 	/**
 	 * The number of answers to return (will be chosen by order of likelihood). Can return less
 	 * than top_k answers if there are not enough options available within the context.
 	 */
-	topK?: number;
+	top_k?: number;
 	/**
 	 * A list of words and bounding boxes (normalized 0->1000). If provided, the inference will
 	 * skip the OCR step and use the provided bounding boxes instead.
 	 */
-	wordBoxes?: WordBox[];
+	word_boxes?: WordBox[];
 	[property: string]: unknown;
 }
 export type WordBox = number[] | string;
@@ -88,11 +88,19 @@ export interface DocumentQuestionAnsweringOutputElement {
 	 * The answer to the question.
 	 */
 	answer: string;
+	/**
+	 * The end word index of the answer (in the OCR’d version of the input or provided word
+	 * boxes).
+	 */
 	end: number;
 	/**
 	 * The probability associated to the answer.
 	 */
 	score: number;
+	/**
+	 * The start word index of the answer (in the OCR’d version of the input or provided word
+	 * boxes).
+	 */
 	start: number;
 	/**
 	 * The index of each word/box pair that is in the answer

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

@@ -5,7 +5,7 @@
 	"title": "DocumentQuestionAnsweringInput",
 	"type": "object",
 	"properties": {
-		"data": {
+		"inputs": {
 			"description": "One (document, question) pair to answer",
 			"type": "object",
 			"title": "DocumentQuestionAnsweringInputData",
@@ -31,11 +31,11 @@
 			"description": "Additional inference parameters for Document Question Answering",
 			"type": "object",
 			"properties": {
-				"docStride": {
+				"doc_stride": {
 					"type": "integer",
 					"description": "If the words in the document are too long to fit with the question for the model, it will be split in several chunks with some overlap. This argument controls the size of that overlap."
 				},
-				"handleImpossibleAnswer": {
+				"handle_impossible_answer": {
 					"type": "boolean",
 					"description": "Whether to accept impossible as an answer"
 				},
@@ -43,23 +43,23 @@
 					"type": "string",
 					"description": "Language to use while running OCR. Defaults to english."
 				},
-				"maxAnswerLen": {
+				"max_answer_len": {
 					"type": "integer",
 					"description": "The maximum length of predicted answers (e.g., only answers with a shorter length are considered)."
 				},
-				"maxSeqLen": {
+				"max_seq_len": {
 					"type": "integer",
 					"description": "The maximum length of the total sentence (context + question) in tokens of each chunk passed to the model. The context will be split in several chunks (using doc_stride as overlap) if needed."
 				},
-				"maxQuestionLen": {
+				"max_question_len": {
 					"type": "integer",
 					"description": "The maximum length of the question after tokenization. It will be truncated if needed."
 				},
-				"topK": {
+				"top_k": {
 					"type": "integer",
 					"description": "The number of answers to return (will be chosen by order of likelihood). Can return less than top_k answers if there are not enough options available within the context."
 				},
-				"wordBoxes": {
+				"word_boxes": {
 					"type": "array",
 					"description": "A list of words and bounding boxes (normalized 0->1000). If provided, the inference will skip the OCR step and use the provided bounding boxes instead.",
 					"items": {
@@ -81,5 +81,5 @@
 			}
 		}
 	},
-	"required": ["data"]
+	"required": ["inputs"]
 }

package/src/tasks/document-question-answering/spec/output.json

@@ -17,11 +17,11 @@
 			},
 			"start": {
 				"type": "integer",
-				"descrtiption": "The start word index of the answer (in the OCR’d version of the input or provided word boxes)."
+				"description": "The start word index of the answer (in the OCR\u2019d version of the input or provided word boxes)."
 			},
 			"end": {
 				"type": "integer",
-				"descrtiption": "The end word index of the answer (in the OCR’d version of the input or provided word boxes)."
+				"description": "The end word index of the answer (in the OCR\u2019d version of the input or provided word boxes)."
 			},
 			"words": {
 				"type": "array",

package/src/tasks/feature-extraction/inference.ts

@@ -13,7 +13,7 @@ export interface FeatureExtractionInput {
 	/**
 	 * The text to get the embeddings of
 	 */
-	data: string;
+	inputs: string;
 	/**
 	 * Additional inference parameters
 	 */

package/src/tasks/feature-extraction/spec/input.json

@@ -5,7 +5,7 @@
 	"title": "FeatureExtractionInput",
 	"type": "object",
 	"properties": {
-		"data": {
+		"inputs": {
 			"description": "The text to get the embeddings of",
 			"type": "string"
 		},
@@ -22,5 +22,5 @@
 			"properties": {}
 		}
 	},
-	"required": ["data"]
+	"required": ["inputs"]
 }

package/src/tasks/fill-mask/inference.ts

@@ -10,7 +10,7 @@ export interface FillMaskInput {
 	/**
 	 * The text with masked tokens
 	 */
-	data: string;
+	inputs: string;
 	/**
 	 * Additional inference parameters
 	 */
@@ -33,7 +33,7 @@ export interface FillMaskParameters {
 	/**
 	 * When passed, overrides the number of predictions to return.
 	 */
-	topK?: number;
+	top_k?: number;
 	[property: string]: unknown;
 }
 export type FillMaskOutput = FillMaskOutputElement[];
@@ -53,9 +53,10 @@ export interface FillMaskOutputElement {
 	 * The predicted token id (to replace the masked one).
 	 */
 	token: number;
+	tokenStr: unknown;
 	/**
 	 * The predicted token (to replace the masked one).
 	 */
-	tokenStr: string;
+	token_str?: string;
 	[property: string]: unknown;
 }

package/src/tasks/fill-mask/spec/input.json

@@ -5,7 +5,7 @@
 	"title": "FillMaskInput",
 	"type": "object",
 	"properties": {
-		"data": {
+		"inputs": {
 			"description": "The text with masked tokens",
 			"type": "string"
 		},
@@ -20,7 +20,7 @@
 			"description": "Additional inference parameters for Fill Mask",
 			"type": "object",
 			"properties": {
-				"topK": {
+				"top_k": {
 					"type": "integer",
 					"description": "When passed, overrides the number of predictions to return."
 				},
@@ -34,5 +34,5 @@
 			}
 		}
 	},
-	"required": ["data"]
+	"required": ["inputs"]
 }

package/src/tasks/fill-mask/spec/output.json

@@ -19,7 +19,7 @@
 				"type": "integer",
 				"description": "The predicted token id (to replace the masked one)."
 			},
-			"tokenStr": {
+			"token_str": {
 				"type": "string",
 				"description": "The predicted token (to replace the masked one)."
 			}

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

@@ -10,7 +10,7 @@ export interface ImageClassificationInput {
 	/**
 	 * The input image data
 	 */
-	data: unknown;
+	inputs: unknown;
 	/**
 	 * Additional inference parameters
 	 */
@@ -23,11 +23,11 @@ export interface ImageClassificationInput {
  * Additional inference parameters for Image Classification
  */
 export interface ImageClassificationParameters {
-	functionToApply?: ClassificationOutputTransform;
+	function_to_apply?: ClassificationOutputTransform;
 	/**
 	 * When specified, limits the output to the top K most probable classes.
 	 */
-	topK?: number;
+	top_k?: number;
 	[property: string]: unknown;
 }
 /**

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

@@ -5,7 +5,7 @@
 	"title": "ImageClassificationInput",
 	"type": "object",
 	"properties": {
-		"data": {
+		"inputs": {
 			"description": "The input image data"
 		},
 		"parameters": {
@@ -19,16 +19,16 @@
 			"description": "Additional inference parameters for Image Classification",
 			"type": "object",
 			"properties": {
-				"functionToApply": {
+				"function_to_apply": {
 					"title": "ImageClassificationOutputTransform",
 					"$ref": "/inference/schemas/common-definitions.json#/definitions/ClassificationOutputTransform"
 				},
-				"topK": {
+				"top_k": {
 					"type": "integer",
 					"description": "When specified, limits the output to the top K most probable classes."
 				}
 			}
 		}
 	},
-	"required": ["data"]
+	"required": ["inputs"]
 }

package/src/tasks/image-segmentation/inference.ts

@@ -10,7 +10,7 @@ export interface ImageSegmentationInput {
 	/**
 	 * The input image data
 	 */
-	data: unknown;
+	inputs: unknown;
 	/**
 	 * Additional inference parameters
 	 */
@@ -26,11 +26,11 @@ export interface ImageSegmentationParameters {
 	/**
 	 * Threshold to use when turning the predicted masks into binary values.
 	 */
-	maskThreshold?: number;
+	mask_threshold?: number;
 	/**
 	 * Mask overlap threshold to eliminate small, disconnected segments.
 	 */
-	overlapMaskAreaThreshold?: number;
+	overlap_mask_area_threshold?: number;
 	/**
 	 * Segmentation task to be performed, depending on model capabilities.
 	 */

package/src/tasks/image-segmentation/spec/input.json

@@ -5,7 +5,7 @@
 	"title": "ImageSegmentationInput",
 	"type": "object",
 	"properties": {
-		"data": {
+		"inputs": {
 			"description": "The input image data"
 		},
 		"parameters": {
@@ -19,11 +19,11 @@
 			"description": "Additional inference parameters for Image Segmentation",
 			"type": "object",
 			"properties": {
-				"maskThreshold": {
+				"mask_threshold": {
 					"type": "number",
 					"description": "Threshold to use when turning the predicted masks into binary values."
 				},
-				"overlapMaskAreaThreshold": {
+				"overlap_mask_area_threshold": {
 					"type": "number",
 					"description": "Mask overlap threshold to eliminate small, disconnected segments."
 				},
@@ -50,5 +50,5 @@
 			}
 		}
 	},
-	"required": ["data"]
+	"required": ["inputs"]
 }

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

@@ -11,7 +11,7 @@ export interface ImageToImageInput {
 	/**
 	 * The input image data
 	 */
-	data: unknown;
+	inputs: unknown;
 	/**
 	 * Additional inference parameters
 	 */
@@ -29,20 +29,20 @@ export interface ImageToImageParameters {
 	 * For diffusion models. A higher guidance scale value encourages the model to generate
 	 * images closely linked to the text prompt at the expense of lower image quality.
 	 */
-	guidanceScale?: number;
+	guidance_scale?: number;
 	/**
 	 * One or several prompt to guide what NOT to include in image generation.
 	 */
-	negativePrompt?: string[];
+	negative_prompt?: string[];
 	/**
 	 * For diffusion models. The number of denoising steps. More denoising steps usually lead to
 	 * a higher quality image at the expense of slower inference.
 	 */
-	numInferenceSteps?: number;
+	num_inference_steps?: number;
 	/**
 	 * The size in pixel of the output image
 	 */
-	targetSize?: TargetSize;
+	target_size?: TargetSize;
 	[property: string]: unknown;
 }