@huggingface/tasks 0.13.1-test → 0.13.1-test2

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

@@ -0,0 +1,66 @@
+/**
+ * Inference code generated from the JSON schema spec in ./spec
+ *
+ * Using src/scripts/inference-codegen
+ */
+/**
+ * Inputs for Zero Shot Object Detection inference
+ */
+export interface ZeroShotObjectDetectionInput {
+	/**
+	 * The input image data, with candidate labels
+	 */
+	inputs: ZeroShotObjectDetectionInputData;
+	/**
+	 * Additional inference parameters
+	 */
+	parameters?: {
+		[key: string]: unknown;
+	};
+	[property: string]: unknown;
+}
+/**
+ * The input image data, with candidate labels
+ */
+export interface ZeroShotObjectDetectionInputData {
+	/**
+	 * The candidate labels for this image
+	 */
+	candidateLabels: string[];
+	/**
+	 * The image data to generate bounding boxes from
+	 */
+	image: unknown;
+	[property: string]: unknown;
+}
+/**
+ * The predicted bounding box. Coordinates are relative to the top left corner of the input
+ * image.
+ */
+export interface BoundingBox {
+	xmax: number;
+	xmin: number;
+	ymax: number;
+	ymin: number;
+	[property: string]: unknown;
+}
+export type ZeroShotObjectDetectionOutput = ZeroShotObjectDetectionOutputElement[];
+/**
+ * Outputs of inference for the Zero Shot Object Detection task
+ */
+export interface ZeroShotObjectDetectionOutputElement {
+	/**
+	 * The predicted bounding box. Coordinates are relative to the top left corner of the input
+	 * image.
+	 */
+	box: BoundingBox;
+	/**
+	 * A candidate label
+	 */
+	label: string;
+	/**
+	 * The associated score / probability
+	 */
+	score: number;
+	[property: string]: unknown;
+}

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

@@ -0,0 +1,40 @@
+{
+	"$id": "/inference/schemas/zero-shot-object-detection/input.json",
+	"$schema": "http://json-schema.org/draft-06/schema#",
+	"description": "Inputs for Zero Shot Object Detection inference",
+	"title": "ZeroShotObjectDetectionInput",
+	"type": "object",
+	"properties": {
+		"inputs": {
+			"description": "The input image data, with candidate labels",
+			"type": "object",
+			"title": "ZeroShotObjectDetectionInputData",
+			"properties": {
+				"image": {
+					"description": "The image data to generate bounding boxes from"
+				},
+				"candidateLabels": {
+					"description": "The candidate labels for this image",
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				}
+			},
+			"required": ["image", "candidateLabels"]
+		},
+		"parameters": {
+			"description": "Additional inference parameters",
+			"$ref": "#/$defs/ZeroShotObjectDetectionParameters"
+		}
+	},
+	"$defs": {
+		"ZeroShotObjectDetectionParameters": {
+			"title": "ZeroShotObjectDetectionParameters",
+			"description": "Additional inference parameters for Zero Shot Object Detection",
+			"type": "object",
+			"properties": {}
+		}
+	},
+	"required": ["inputs"]
+}

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

@@ -0,0 +1,47 @@
+{
+	"$id": "/inference/schemas/zero-shot-object-detection/output.json",
+	"$schema": "http://json-schema.org/draft-06/schema#",
+	"description": "Outputs of inference for the Zero Shot Object Detection task",
+	"title": "ZeroShotObjectDetectionOutput",
+	"type": "array",
+	"items": {
+		"type": "object",
+		"title": "ZeroShotObjectDetectionOutputElement",
+		"properties": {
+			"label": {
+				"type": "string",
+				"description": "A candidate label"
+			},
+			"score": {
+				"type": "number",
+				"description": "The associated score / probability"
+			},
+			"box": {
+				"$ref": "#/$defs/BoundingBox",
+				"description": "The predicted bounding box. Coordinates are relative to the top left corner of the input image."
+			}
+		},
+		"required": ["box", "label", "score"]
+	},
+	"$defs": {
+		"BoundingBox": {
+			"title": "BoundingBox",
+			"type": "object",
+			"properties": {
+				"xmin": {
+					"type": "integer"
+				},
+				"xmax": {
+					"type": "integer"
+				},
+				"ymin": {
+					"type": "integer"
+				},
+				"ymax": {
+					"type": "integer"
+				}
+			},
+			"required": ["xmin", "xmax", "ymin", "ymax"]
+		}
+	}
+}

package/src/tokenizer-data.ts

@@ -0,0 +1,32 @@
+export const SPECIAL_TOKENS_ATTRIBUTES = [
+	"bos_token",
+	"eos_token",
+	"unk_token",
+	"sep_token",
+	"pad_token",
+	"cls_token",
+	"mask_token",
+	// additional_special_tokens (TODO)
+] as const;
+
+/**
+ * Public interface for a tokenizer's special tokens mapping
+ */
+export interface AddedToken {
+	__type: "AddedToken";
+	content?: string;
+	lstrip?: boolean;
+	normalized?: boolean;
+	rstrip?: boolean;
+	single_word?: boolean;
+}
+export type SpecialTokensMap = {
+	[key in (typeof SPECIAL_TOKENS_ATTRIBUTES)[number]]?: string | AddedToken | null;
+};
+/**
+ * Public interface for tokenizer config
+ */
+export interface TokenizerConfig extends SpecialTokensMap {
+	use_default_system_prompt?: boolean;
+	chat_template?: string | Array<{ name: string; template: string }>;
+}

package/src/widget-example.ts

@@ -0,0 +1,125 @@
+/**
+ * See default-widget-inputs.ts for the default widget inputs, this files only contains the types
+ */
+
+import type { ChatCompletionInputMessage } from "./tasks/index.js";
+
+type TableData = Record<string, (string | number)[]>;
+
+//#region outputs
+export type WidgetExampleOutputLabels = Array<{ label: string; score: number }>;
+export interface WidgetExampleOutputAnswerScore {
+	answer: string;
+	score: number;
+}
+export interface WidgetExampleOutputText {
+	text: string;
+}
+export interface WidgetExampleOutputUrl {
+	url: string;
+}
+
+export type WidgetExampleOutput =
+	| WidgetExampleOutputLabels
+	| WidgetExampleOutputAnswerScore
+	| WidgetExampleOutputText
+	| WidgetExampleOutputUrl;
+//#endregion
+
+export interface WidgetExampleBase<TOutput> {
+	example_title?: string;
+	group?: string;
+	/**
+	 * Potential overrides to API parameters for this specific example
+	 * (takes precedences over the model card metadata's inference.parameters)
+	 */
+	parameters?: {
+		/// token-classification
+		aggregation_strategy?: string;
+		/// text-generation
+		top_k?: number;
+		top_p?: number;
+		temperature?: number;
+		max_new_tokens?: number;
+		do_sample?: boolean;
+		/// text-to-image
+		negative_prompt?: string;
+		guidance_scale?: number;
+		num_inference_steps?: number;
+	};
+	/**
+	 * Optional output
+	 */
+	output?: TOutput;
+}
+
+export interface WidgetExampleChatInput<TOutput = WidgetExampleOutput> extends WidgetExampleBase<TOutput> {
+	messages: ChatCompletionInputMessage[];
+}
+
+export interface WidgetExampleTextInput<TOutput = WidgetExampleOutput> extends WidgetExampleBase<TOutput> {
+	text: string;
+}
+
+export interface WidgetExampleTextAndContextInput<TOutput = WidgetExampleOutput>
+	extends WidgetExampleTextInput<TOutput> {
+	context: string;
+}
+
+export interface WidgetExampleTextAndTableInput<TOutput = WidgetExampleOutput> extends WidgetExampleTextInput<TOutput> {
+	table: TableData;
+}
+
+export interface WidgetExampleAssetInput<TOutput = WidgetExampleOutput> extends WidgetExampleBase<TOutput> {
+	src: string;
+}
+export interface WidgetExampleAssetAndPromptInput<TOutput = WidgetExampleOutput>
+	extends WidgetExampleAssetInput<TOutput> {
+	prompt: string;
+}
+
+export type WidgetExampleAssetAndTextInput<TOutput = WidgetExampleOutput> = WidgetExampleAssetInput<TOutput> &
+	WidgetExampleTextInput<TOutput>;
+
+export type WidgetExampleAssetAndZeroShotInput<TOutput = WidgetExampleOutput> = WidgetExampleAssetInput<TOutput> &
+	WidgetExampleZeroShotTextInput<TOutput>;
+
+export interface WidgetExampleStructuredDataInput<TOutput = WidgetExampleOutput> extends WidgetExampleBase<TOutput> {
+	structured_data: TableData;
+}
+
+export interface WidgetExampleTableDataInput<TOutput = WidgetExampleOutput> extends WidgetExampleBase<TOutput> {
+	table: TableData;
+}
+
+export interface WidgetExampleZeroShotTextInput<TOutput = WidgetExampleOutput> extends WidgetExampleTextInput<TOutput> {
+	text: string;
+	candidate_labels: string;
+	multi_class: boolean;
+}
+
+export interface WidgetExampleSentenceSimilarityInput<TOutput = WidgetExampleOutput>
+	extends WidgetExampleBase<TOutput> {
+	source_sentence: string;
+	sentences: string[];
+}
+
+//#endregion
+
+export type WidgetExample<TOutput = WidgetExampleOutput> =
+	| WidgetExampleChatInput<TOutput>
+	| WidgetExampleTextInput<TOutput>
+	| WidgetExampleTextAndContextInput<TOutput>
+	| WidgetExampleTextAndTableInput<TOutput>
+	| WidgetExampleAssetInput<TOutput>
+	| WidgetExampleAssetAndPromptInput<TOutput>
+	| WidgetExampleAssetAndTextInput<TOutput>
+	| WidgetExampleAssetAndZeroShotInput<TOutput>
+	| WidgetExampleStructuredDataInput<TOutput>
+	| WidgetExampleTableDataInput<TOutput>
+	| WidgetExampleZeroShotTextInput<TOutput>
+	| WidgetExampleSentenceSimilarityInput<TOutput>;
+
+type KeysOfUnion<T> = T extends unknown ? keyof T : never;
+
+export type WidgetExampleAttribute = KeysOfUnion<WidgetExample>;