@huggingface/tasks 0.3.4 → 0.4.0

package/dist/index.cjs

@@ -4222,7 +4222,7 @@ model = joblib.load(
 };
 var sklearn = (model) => {
   if (model.tags?.includes("skops")) {
-    const skopsmodelFile = model.config?.sklearn?.filename;
+    const skopsmodelFile = model.config?.sklearn?.model?.file;
     const skopssaveFormat = model.config?.sklearn?.model_format;
     if (!skopsmodelFile) {
       return [`# \u26A0\uFE0F Model filename not specified in config.json`];
@@ -4292,7 +4292,7 @@ var speechBrainMethod = (speechbrainInterface) => {
   }
 };
 var speechbrain = (model) => {
-  const speechbrainInterface = model.config?.speechbrain?.interface;
+  const speechbrainInterface = model.config?.speechbrain?.speechbrain_interface;
   if (speechbrainInterface === void 0) {
     return [`# interface not specified in config.json`];
   }
@@ -4370,7 +4370,7 @@ var peftTask = (peftTaskType) => {
   }
 };
 var peft = (model) => {
-  const { base_model_name: peftBaseModel, task_type: peftTaskType } = model.config?.peft ?? {};
+  const { base_model_name_or_path: peftBaseModel, task_type: peftTaskType } = model.config?.peft ?? {};
   const pefttask = peftTask(peftTaskType);
   if (!pefttask) {
     return [`Task type is invalid.`];

package/dist/index.d.ts

@@ -444,6 +444,13 @@ interface WidgetExampleBase<TOutput> {
      */
     output?: TOutput;
 }
+interface ChatMessage {
+    role: "user" | "assistant" | "system";
+    content: string;
+}
+interface WidgetExampleChatInput<TOutput = WidgetExampleOutput> extends WidgetExampleBase<TOutput> {
+    messages: ChatMessage[];
+}
 interface WidgetExampleTextInput<TOutput = WidgetExampleOutput> extends WidgetExampleBase<TOutput> {
     text: string;
 }
@@ -476,7 +483,7 @@ interface WidgetExampleSentenceSimilarityInput<TOutput = WidgetExampleOutput> ex
     source_sentence: string;
     sentences: string[];
 }
-type WidgetExample<TOutput = WidgetExampleOutput> = WidgetExampleTextInput<TOutput> | WidgetExampleTextAndContextInput<TOutput> | WidgetExampleTextAndTableInput<TOutput> | WidgetExampleAssetInput<TOutput> | WidgetExampleAssetAndPromptInput<TOutput> | WidgetExampleAssetAndTextInput<TOutput> | WidgetExampleAssetAndZeroShotInput<TOutput> | WidgetExampleStructuredDataInput<TOutput> | WidgetExampleTableDataInput<TOutput> | WidgetExampleZeroShotTextInput<TOutput> | WidgetExampleSentenceSimilarityInput<TOutput>;
+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;
 type WidgetExampleAttribute = KeysOfUnion<WidgetExample>;
 
@@ -532,24 +539,46 @@ interface ModelData {
     /**
      * this dictionary has useful information about the model configuration
      */
-    config?: Record<string, unknown> & {
+    config?: {
+        architectures?: string[];
+        /**
+         * Dict of AutoModel or Auto… class name to local import path in the repo
+         */
+        auto_map?: {
+            /**
+             * String Property
+             */
+            [x: string]: string;
+        };
+        model_type?: string;
+        quantization_config?: {
+            bits?: number;
+            load_in_4bit?: boolean;
+            load_in_8bit?: boolean;
+        };
+        tokenizer_config?: TokenizerConfig;
         adapter_transformers?: {
-            model_class?: string;
             model_name?: string;
+            model_class?: string;
+        };
+        diffusers?: {
+            _class_name?: string;
         };
-        architectures?: string[];
         sklearn?: {
-            filename?: string;
+            model?: {
+                file?: string;
+            };
             model_format?: string;
         };
         speechbrain?: {
-            interface?: string;
+            speechbrain_interface?: string;
+            vocoder_interface?: string;
+            vocoder_model_id?: string;
         };
         peft?: {
-            base_model_name?: string;
+            base_model_name_or_path?: string;
             task_type?: string;
         };
-        tokenizer_config?: TokenizerConfig;
     };
     /**
      * all the model tags
@@ -3219,4 +3248,4 @@ declare namespace index {
   };
 }
 
-export { ALL_DISPLAY_MODEL_LIBRARY_KEYS, ALL_MODEL_LIBRARY_KEYS, AudioClassificationInput, AudioClassificationOutput, AudioClassificationOutputElement, AudioClassificationParameters, AutomaticSpeechRecognitionInput, AutomaticSpeechRecognitionOutput, AutomaticSpeechRecognitionOutputChunk, AutomaticSpeechRecognitionParameters, BoundingBox, ClassificationOutputTransform$1 as ClassificationOutputTransform, DepthEstimationInput, DepthEstimationOutput, DocumentQuestionAnsweringInput, DocumentQuestionAnsweringInputData, DocumentQuestionAnsweringOutput, DocumentQuestionAnsweringOutputElement, DocumentQuestionAnsweringParameters, EarlyStoppingUnion$2 as EarlyStoppingUnion, ExampleRepo, FeatureExtractionInput, FeatureExtractionOutput, FillMaskInput, FillMaskOutput, FillMaskOutputElement, FillMaskParameters, FinishReason, GenerationParameters$2 as GenerationParameters, ImageClassificationInput, ImageClassificationOutput, ImageClassificationOutputElement, ImageClassificationParameters, ImageSegmentationInput, ImageSegmentationOutput, ImageSegmentationOutputElement, ImageSegmentationParameters, ImageSegmentationSubtask, ImageToImageInput, ImageToImageOutput, ImageToImageParameters, ImageToTextInput, ImageToTextOutput, ImageToTextParameters, InferenceDisplayability, LIBRARY_TASK_MAPPING_EXCLUDING_TRANSFORMERS, LibraryUiElement, MAPPING_DEFAULT_WIDGET, MODALITIES, MODALITY_LABELS, MODEL_LIBRARIES_UI_ELEMENTS, Modality, ModelData, ModelLibraryKey, ObjectDetectionInput, ObjectDetectionOutput, ObjectDetectionOutputElement, ObjectDetectionParameters, PIPELINE_DATA, PIPELINE_TYPES, PIPELINE_TYPES_SET, PipelineData, PipelineType, PrefillToken, QuestionAnsweringInput, QuestionAnsweringInputData, QuestionAnsweringOutput, QuestionAnsweringOutputElement, QuestionAnsweringParameters, SPECIAL_TOKENS_ATTRIBUTES, SUBTASK_TYPES, SentenceSimilarityInput, SentenceSimilarityInputData, SentenceSimilarityOutput, SpecialTokensMap, SummarizationInput, SummarizationOutput, TASKS_DATA, TASKS_MODEL_LIBRARIES, TableQuestionAnsweringInput, TableQuestionAnsweringInputData, TableQuestionAnsweringOutput, TableQuestionAnsweringOutputElement, TargetSize$1 as TargetSize, TaskData, TaskDataCustom, TaskDemo, TaskDemoEntry, Text2TextGenerationParameters, Text2TextGenerationTruncationStrategy, TextClassificationInput, TextClassificationOutput, TextClassificationOutputElement, TextClassificationParameters, TextGenerationInput, TextGenerationOutput, TextGenerationOutputDetails, TextGenerationParameters, TextGenerationSequenceDetails, TextToAudioParameters, TextToImageInput, TextToImageOutput, TextToImageParameters, TextToSpeechInput, TextToSpeechOutput, Token, TokenClassificationAggregationStrategy, TokenClassificationInput, TokenClassificationOutput, TokenClassificationOutputElement, TokenClassificationParameters, TokenizerConfig, TransformersInfo, TranslationInput, TranslationOutput, VideoClassificationInput, VideoClassificationOutput, VideoClassificationOutputElement, VideoClassificationParameters, VisualQuestionAnsweringInput, VisualQuestionAnsweringInputData, VisualQuestionAnsweringOutput, VisualQuestionAnsweringOutputElement, VisualQuestionAnsweringParameters, WidgetExample, WidgetExampleAssetAndPromptInput, WidgetExampleAssetAndTextInput, WidgetExampleAssetAndZeroShotInput, WidgetExampleAssetInput, WidgetExampleAttribute, WidgetExampleOutput, WidgetExampleOutputAnswerScore, WidgetExampleOutputLabels, WidgetExampleOutputText, WidgetExampleOutputUrl, WidgetExampleSentenceSimilarityInput, WidgetExampleStructuredDataInput, WidgetExampleTableDataInput, WidgetExampleTextAndContextInput, WidgetExampleTextAndTableInput, WidgetExampleTextInput, WidgetExampleZeroShotTextInput, WidgetType, WordBox, ZeroShotClassificationInput, ZeroShotClassificationInputData, ZeroShotClassificationOutput, ZeroShotClassificationOutputElement, ZeroShotClassificationParameters, ZeroShotImageClassificationInput, ZeroShotImageClassificationInputData, ZeroShotImageClassificationOutput, ZeroShotImageClassificationOutputElement, ZeroShotImageClassificationParameters, ZeroShotObjectDetectionInput, ZeroShotObjectDetectionInputData, ZeroShotObjectDetectionOutput, ZeroShotObjectDetectionOutputElement, index as snippets };
+export { ALL_DISPLAY_MODEL_LIBRARY_KEYS, ALL_MODEL_LIBRARY_KEYS, AudioClassificationInput, AudioClassificationOutput, AudioClassificationOutputElement, AudioClassificationParameters, AutomaticSpeechRecognitionInput, AutomaticSpeechRecognitionOutput, AutomaticSpeechRecognitionOutputChunk, AutomaticSpeechRecognitionParameters, BoundingBox, ChatMessage, ClassificationOutputTransform$1 as ClassificationOutputTransform, DepthEstimationInput, DepthEstimationOutput, DocumentQuestionAnsweringInput, DocumentQuestionAnsweringInputData, DocumentQuestionAnsweringOutput, DocumentQuestionAnsweringOutputElement, DocumentQuestionAnsweringParameters, EarlyStoppingUnion$2 as EarlyStoppingUnion, ExampleRepo, FeatureExtractionInput, FeatureExtractionOutput, FillMaskInput, FillMaskOutput, FillMaskOutputElement, FillMaskParameters, FinishReason, GenerationParameters$2 as GenerationParameters, ImageClassificationInput, ImageClassificationOutput, ImageClassificationOutputElement, ImageClassificationParameters, ImageSegmentationInput, ImageSegmentationOutput, ImageSegmentationOutputElement, ImageSegmentationParameters, ImageSegmentationSubtask, ImageToImageInput, ImageToImageOutput, ImageToImageParameters, ImageToTextInput, ImageToTextOutput, ImageToTextParameters, InferenceDisplayability, LIBRARY_TASK_MAPPING_EXCLUDING_TRANSFORMERS, LibraryUiElement, MAPPING_DEFAULT_WIDGET, MODALITIES, MODALITY_LABELS, MODEL_LIBRARIES_UI_ELEMENTS, Modality, ModelData, ModelLibraryKey, ObjectDetectionInput, ObjectDetectionOutput, ObjectDetectionOutputElement, ObjectDetectionParameters, PIPELINE_DATA, PIPELINE_TYPES, PIPELINE_TYPES_SET, PipelineData, PipelineType, PrefillToken, QuestionAnsweringInput, QuestionAnsweringInputData, QuestionAnsweringOutput, QuestionAnsweringOutputElement, QuestionAnsweringParameters, SPECIAL_TOKENS_ATTRIBUTES, SUBTASK_TYPES, SentenceSimilarityInput, SentenceSimilarityInputData, SentenceSimilarityOutput, SpecialTokensMap, SummarizationInput, SummarizationOutput, TASKS_DATA, TASKS_MODEL_LIBRARIES, TableQuestionAnsweringInput, TableQuestionAnsweringInputData, TableQuestionAnsweringOutput, TableQuestionAnsweringOutputElement, TargetSize$1 as TargetSize, TaskData, TaskDataCustom, TaskDemo, TaskDemoEntry, Text2TextGenerationParameters, Text2TextGenerationTruncationStrategy, TextClassificationInput, TextClassificationOutput, TextClassificationOutputElement, TextClassificationParameters, TextGenerationInput, TextGenerationOutput, TextGenerationOutputDetails, TextGenerationParameters, TextGenerationSequenceDetails, TextToAudioParameters, TextToImageInput, TextToImageOutput, TextToImageParameters, TextToSpeechInput, TextToSpeechOutput, Token, TokenClassificationAggregationStrategy, TokenClassificationInput, TokenClassificationOutput, TokenClassificationOutputElement, TokenClassificationParameters, TokenizerConfig, TransformersInfo, TranslationInput, TranslationOutput, VideoClassificationInput, VideoClassificationOutput, VideoClassificationOutputElement, VideoClassificationParameters, VisualQuestionAnsweringInput, VisualQuestionAnsweringInputData, VisualQuestionAnsweringOutput, VisualQuestionAnsweringOutputElement, VisualQuestionAnsweringParameters, WidgetExample, WidgetExampleAssetAndPromptInput, WidgetExampleAssetAndTextInput, WidgetExampleAssetAndZeroShotInput, WidgetExampleAssetInput, WidgetExampleAttribute, WidgetExampleChatInput, WidgetExampleOutput, WidgetExampleOutputAnswerScore, WidgetExampleOutputLabels, WidgetExampleOutputText, WidgetExampleOutputUrl, WidgetExampleSentenceSimilarityInput, WidgetExampleStructuredDataInput, WidgetExampleTableDataInput, WidgetExampleTextAndContextInput, WidgetExampleTextAndTableInput, WidgetExampleTextInput, WidgetExampleZeroShotTextInput, WidgetType, WordBox, ZeroShotClassificationInput, ZeroShotClassificationInputData, ZeroShotClassificationOutput, ZeroShotClassificationOutputElement, ZeroShotClassificationParameters, ZeroShotImageClassificationInput, ZeroShotImageClassificationInputData, ZeroShotImageClassificationOutput, ZeroShotImageClassificationOutputElement, ZeroShotImageClassificationParameters, ZeroShotObjectDetectionInput, ZeroShotObjectDetectionInputData, ZeroShotObjectDetectionOutput, ZeroShotObjectDetectionOutputElement, index as snippets };

package/dist/index.js

@@ -4187,7 +4187,7 @@ model = joblib.load(
 };
 var sklearn = (model) => {
   if (model.tags?.includes("skops")) {
-    const skopsmodelFile = model.config?.sklearn?.filename;
+    const skopsmodelFile = model.config?.sklearn?.model?.file;
     const skopssaveFormat = model.config?.sklearn?.model_format;
     if (!skopsmodelFile) {
       return [`# \u26A0\uFE0F Model filename not specified in config.json`];
@@ -4257,7 +4257,7 @@ var speechBrainMethod = (speechbrainInterface) => {
   }
 };
 var speechbrain = (model) => {
-  const speechbrainInterface = model.config?.speechbrain?.interface;
+  const speechbrainInterface = model.config?.speechbrain?.speechbrain_interface;
   if (speechbrainInterface === void 0) {
     return [`# interface not specified in config.json`];
   }
@@ -4335,7 +4335,7 @@ var peftTask = (peftTaskType) => {
   }
 };
 var peft = (model) => {
-  const { base_model_name: peftBaseModel, task_type: peftTaskType } = model.config?.peft ?? {};
+  const { base_model_name_or_path: peftBaseModel, task_type: peftTaskType } = model.config?.peft ?? {};
   const pefttask = peftTask(peftTaskType);
   if (!pefttask) {
     return [`Task type is invalid.`];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@huggingface/tasks",
   "packageManager": "pnpm@8.10.5",
-  "version": "0.3.4",
+  "version": "0.4.0",
   "description": "List of ML tasks for huggingface.co/tasks",
   "repository": "https://github.com/huggingface/huggingface.js.git",
   "publishConfig": {

package/src/index.ts

@@ -19,12 +19,14 @@ export type { LibraryUiElement, ModelLibraryKey } from "./model-libraries";
 export type { ModelData, TransformersInfo } from "./model-data";
 export type { SpecialTokensMap, TokenizerConfig } from "./tokenizer-data";
 export type {
+	ChatMessage,
 	WidgetExample,
 	WidgetExampleAttribute,
 	WidgetExampleAssetAndPromptInput,
 	WidgetExampleAssetAndTextInput,
 	WidgetExampleAssetAndZeroShotInput,
 	WidgetExampleAssetInput,
+	WidgetExampleChatInput,
 	WidgetExampleSentenceSimilarityInput,
 	WidgetExampleStructuredDataInput,
 	WidgetExampleTableDataInput,

package/src/model-data.ts

@@ -40,21 +40,46 @@ export interface ModelData {
 	/**
 	 * this dictionary has useful information about the model configuration
 	 */
-	config?: Record<string, unknown> & {
-		adapter_transformers?: { model_class?: string; model_name?: string };
+	config?: {
 		architectures?: string[];
+		/**
+		 * Dict of AutoModel or Auto… class name to local import path in the repo
+		 */
+		auto_map?: {
+			/**
+			 * String Property
+			 */
+			[x: string]: string;
+		};
+		model_type?: string;
+		quantization_config?: {
+			bits?: number;
+			load_in_4bit?: boolean;
+			load_in_8bit?: boolean;
+		};
+		tokenizer_config?: TokenizerConfig;
+		adapter_transformers?: {
+			model_name?: string;
+			model_class?: string;
+		};
+		diffusers?: {
+			_class_name?: string;
+		};
 		sklearn?: {
-			filename?: string;
+			model?: {
+				file?: string;
+			};
 			model_format?: string;
 		};
 		speechbrain?: {
-			interface?: string;
+			speechbrain_interface?: string;
+			vocoder_interface?: string;
+			vocoder_model_id?: string;
 		};
 		peft?: {
-			base_model_name?: string;
+			base_model_name_or_path?: string;
 			task_type?: string;
 		};
-		tokenizer_config?: TokenizerConfig;
 	};
 	/**
 	 * all the model tags

package/src/model-libraries-snippets.ts

@@ -293,7 +293,7 @@ model = joblib.load(
 
 export const sklearn = (model: ModelData): string[] => {
 	if (model.tags?.includes("skops")) {
-		const skopsmodelFile = model.config?.sklearn?.filename;
+		const skopsmodelFile = model.config?.sklearn?.model?.file;
 		const skopssaveFormat = model.config?.sklearn?.model_format;
 		if (!skopsmodelFile) {
 			return [`# ⚠️ Model filename not specified in config.json`];
@@ -372,7 +372,7 @@ const speechBrainMethod = (speechbrainInterface: string) => {
 };
 
 export const speechbrain = (model: ModelData): string[] => {
-	const speechbrainInterface = model.config?.speechbrain?.interface;
+	const speechbrainInterface = model.config?.speechbrain?.speechbrain_interface;
 	if (speechbrainInterface === undefined) {
 		return [`# interface not specified in config.json`];
 	}
@@ -465,7 +465,7 @@ const peftTask = (peftTaskType?: string) => {
 };
 
 export const peft = (model: ModelData): string[] => {
-	const { base_model_name: peftBaseModel, task_type: peftTaskType } = model.config?.peft ?? {};
+	const { base_model_name_or_path: peftBaseModel, task_type: peftTaskType } = model.config?.peft ?? {};
 	const pefttask = peftTask(peftTaskType);
 	if (!pefttask) {
 		return [`Task type is invalid.`];

package/src/widget-example.ts

@@ -51,6 +51,15 @@ export interface WidgetExampleBase<TOutput> {
 	output?: TOutput;
 }
 
+export interface ChatMessage {
+	role: "user" | "assistant" | "system";
+	content: string;
+}
+
+export interface WidgetExampleChatInput<TOutput = WidgetExampleOutput> extends WidgetExampleBase<TOutput> {
+	messages: ChatMessage[];
+}
+
 export interface WidgetExampleTextInput<TOutput = WidgetExampleOutput> extends WidgetExampleBase<TOutput> {
 	text: string;
 }
@@ -101,6 +110,7 @@ export interface WidgetExampleSentenceSimilarityInput<TOutput = WidgetExampleOut
 //#endregion
 
 export type WidgetExample<TOutput = WidgetExampleOutput> =
+	| WidgetExampleChatInput<TOutput>
 	| WidgetExampleTextInput<TOutput>
 	| WidgetExampleTextAndContextInput<TOutput>
 	| WidgetExampleTextAndTableInput<TOutput>