@huggingface/tasks 0.13.0 → 0.13.1-test2

package/dist/esm/pipelines.js

@@ -0,0 +1,642 @@
+export const MODALITIES = ["multimodal", "nlp", "cv", "audio", "tabular", "rl", "other"];
+export const MODALITY_LABELS = {
+    multimodal: "Multimodal",
+    nlp: "Natural Language Processing",
+    audio: "Audio",
+    cv: "Computer Vision",
+    rl: "Reinforcement Learning",
+    tabular: "Tabular",
+    other: "Other",
+};
+/// Coarse-grained taxonomy of tasks
+///
+/// This type is used in multiple places in the Hugging Face
+/// ecosystem:
+///  - To determine which widget to show.
+///  - To determine which endpoint of Inference Endpoints to use.
+///  - As filters at the left of models and datasets page.
+///
+/// Note that this is sensitive to order.
+/// For each domain, the order should be of decreasing specificity.
+/// This will impact the default pipeline tag of a model when not
+/// specified.
+export const PIPELINE_DATA = {
+    "text-classification": {
+        name: "Text Classification",
+        subtasks: [
+            {
+                type: "acceptability-classification",
+                name: "Acceptability Classification",
+            },
+            {
+                type: "entity-linking-classification",
+                name: "Entity Linking Classification",
+            },
+            {
+                type: "fact-checking",
+                name: "Fact Checking",
+            },
+            {
+                type: "intent-classification",
+                name: "Intent Classification",
+            },
+            {
+                type: "language-identification",
+                name: "Language Identification",
+            },
+            {
+                type: "multi-class-classification",
+                name: "Multi Class Classification",
+            },
+            {
+                type: "multi-label-classification",
+                name: "Multi Label Classification",
+            },
+            {
+                type: "multi-input-text-classification",
+                name: "Multi-input Text Classification",
+            },
+            {
+                type: "natural-language-inference",
+                name: "Natural Language Inference",
+            },
+            {
+                type: "semantic-similarity-classification",
+                name: "Semantic Similarity Classification",
+            },
+            {
+                type: "sentiment-classification",
+                name: "Sentiment Classification",
+            },
+            {
+                type: "topic-classification",
+                name: "Topic Classification",
+            },
+            {
+                type: "semantic-similarity-scoring",
+                name: "Semantic Similarity Scoring",
+            },
+            {
+                type: "sentiment-scoring",
+                name: "Sentiment Scoring",
+            },
+            {
+                type: "sentiment-analysis",
+                name: "Sentiment Analysis",
+            },
+            {
+                type: "hate-speech-detection",
+                name: "Hate Speech Detection",
+            },
+            {
+                type: "text-scoring",
+                name: "Text Scoring",
+            },
+        ],
+        modality: "nlp",
+        color: "orange",
+    },
+    "token-classification": {
+        name: "Token Classification",
+        subtasks: [
+            {
+                type: "named-entity-recognition",
+                name: "Named Entity Recognition",
+            },
+            {
+                type: "part-of-speech",
+                name: "Part of Speech",
+            },
+            {
+                type: "parsing",
+                name: "Parsing",
+            },
+            {
+                type: "lemmatization",
+                name: "Lemmatization",
+            },
+            {
+                type: "word-sense-disambiguation",
+                name: "Word Sense Disambiguation",
+            },
+            {
+                type: "coreference-resolution",
+                name: "Coreference-resolution",
+            },
+        ],
+        modality: "nlp",
+        color: "blue",
+    },
+    "table-question-answering": {
+        name: "Table Question Answering",
+        modality: "nlp",
+        color: "green",
+    },
+    "question-answering": {
+        name: "Question Answering",
+        subtasks: [
+            {
+                type: "extractive-qa",
+                name: "Extractive QA",
+            },
+            {
+                type: "open-domain-qa",
+                name: "Open Domain QA",
+            },
+            {
+                type: "closed-domain-qa",
+                name: "Closed Domain QA",
+            },
+        ],
+        modality: "nlp",
+        color: "blue",
+    },
+    "zero-shot-classification": {
+        name: "Zero-Shot Classification",
+        modality: "nlp",
+        color: "yellow",
+    },
+    translation: {
+        name: "Translation",
+        modality: "nlp",
+        color: "green",
+    },
+    summarization: {
+        name: "Summarization",
+        subtasks: [
+            {
+                type: "news-articles-summarization",
+                name: "News Articles Summarization",
+            },
+            {
+                type: "news-articles-headline-generation",
+                name: "News Articles Headline Generation",
+            },
+        ],
+        modality: "nlp",
+        color: "indigo",
+    },
+    "feature-extraction": {
+        name: "Feature Extraction",
+        modality: "nlp",
+        color: "red",
+    },
+    "text-generation": {
+        name: "Text Generation",
+        subtasks: [
+            {
+                type: "dialogue-modeling",
+                name: "Dialogue Modeling",
+            },
+            {
+                type: "dialogue-generation",
+                name: "Dialogue Generation",
+            },
+            {
+                type: "conversational",
+                name: "Conversational",
+            },
+            {
+                type: "language-modeling",
+                name: "Language Modeling",
+            },
+        ],
+        modality: "nlp",
+        color: "indigo",
+    },
+    "text2text-generation": {
+        name: "Text2Text Generation",
+        subtasks: [
+            {
+                type: "text-simplification",
+                name: "Text simplification",
+            },
+            {
+                type: "explanation-generation",
+                name: "Explanation Generation",
+            },
+            {
+                type: "abstractive-qa",
+                name: "Abstractive QA",
+            },
+            {
+                type: "open-domain-abstractive-qa",
+                name: "Open Domain Abstractive QA",
+            },
+            {
+                type: "closed-domain-qa",
+                name: "Closed Domain QA",
+            },
+            {
+                type: "open-book-qa",
+                name: "Open Book QA",
+            },
+            {
+                type: "closed-book-qa",
+                name: "Closed Book QA",
+            },
+        ],
+        modality: "nlp",
+        color: "indigo",
+    },
+    "fill-mask": {
+        name: "Fill-Mask",
+        subtasks: [
+            {
+                type: "slot-filling",
+                name: "Slot Filling",
+            },
+            {
+                type: "masked-language-modeling",
+                name: "Masked Language Modeling",
+            },
+        ],
+        modality: "nlp",
+        color: "red",
+    },
+    "sentence-similarity": {
+        name: "Sentence Similarity",
+        modality: "nlp",
+        color: "yellow",
+    },
+    "text-to-speech": {
+        name: "Text-to-Speech",
+        modality: "audio",
+        color: "yellow",
+    },
+    "text-to-audio": {
+        name: "Text-to-Audio",
+        modality: "audio",
+        color: "yellow",
+    },
+    "automatic-speech-recognition": {
+        name: "Automatic Speech Recognition",
+        modality: "audio",
+        color: "yellow",
+    },
+    "audio-to-audio": {
+        name: "Audio-to-Audio",
+        modality: "audio",
+        color: "blue",
+    },
+    "audio-classification": {
+        name: "Audio Classification",
+        subtasks: [
+            {
+                type: "keyword-spotting",
+                name: "Keyword Spotting",
+            },
+            {
+                type: "speaker-identification",
+                name: "Speaker Identification",
+            },
+            {
+                type: "audio-intent-classification",
+                name: "Audio Intent Classification",
+            },
+            {
+                type: "audio-emotion-recognition",
+                name: "Audio Emotion Recognition",
+            },
+            {
+                type: "audio-language-identification",
+                name: "Audio Language Identification",
+            },
+        ],
+        modality: "audio",
+        color: "green",
+    },
+    "voice-activity-detection": {
+        name: "Voice Activity Detection",
+        modality: "audio",
+        color: "red",
+    },
+    "depth-estimation": {
+        name: "Depth Estimation",
+        modality: "cv",
+        color: "yellow",
+    },
+    "image-classification": {
+        name: "Image Classification",
+        subtasks: [
+            {
+                type: "multi-label-image-classification",
+                name: "Multi Label Image Classification",
+            },
+            {
+                type: "multi-class-image-classification",
+                name: "Multi Class Image Classification",
+            },
+        ],
+        modality: "cv",
+        color: "blue",
+    },
+    "object-detection": {
+        name: "Object Detection",
+        subtasks: [
+            {
+                type: "face-detection",
+                name: "Face Detection",
+            },
+            {
+                type: "vehicle-detection",
+                name: "Vehicle Detection",
+            },
+        ],
+        modality: "cv",
+        color: "yellow",
+    },
+    "image-segmentation": {
+        name: "Image Segmentation",
+        subtasks: [
+            {
+                type: "instance-segmentation",
+                name: "Instance Segmentation",
+            },
+            {
+                type: "semantic-segmentation",
+                name: "Semantic Segmentation",
+            },
+            {
+                type: "panoptic-segmentation",
+                name: "Panoptic Segmentation",
+            },
+        ],
+        modality: "cv",
+        color: "green",
+    },
+    "text-to-image": {
+        name: "Text-to-Image",
+        modality: "cv",
+        color: "yellow",
+    },
+    "image-to-text": {
+        name: "Image-to-Text",
+        subtasks: [
+            {
+                type: "image-captioning",
+                name: "Image Captioning",
+            },
+        ],
+        modality: "cv",
+        color: "red",
+    },
+    "image-to-image": {
+        name: "Image-to-Image",
+        subtasks: [
+            {
+                type: "image-inpainting",
+                name: "Image Inpainting",
+            },
+            {
+                type: "image-colorization",
+                name: "Image Colorization",
+            },
+            {
+                type: "super-resolution",
+                name: "Super Resolution",
+            },
+        ],
+        modality: "cv",
+        color: "indigo",
+    },
+    "image-to-video": {
+        name: "Image-to-Video",
+        modality: "cv",
+        color: "indigo",
+    },
+    "unconditional-image-generation": {
+        name: "Unconditional Image Generation",
+        modality: "cv",
+        color: "green",
+    },
+    "video-classification": {
+        name: "Video Classification",
+        modality: "cv",
+        color: "blue",
+    },
+    "reinforcement-learning": {
+        name: "Reinforcement Learning",
+        modality: "rl",
+        color: "red",
+    },
+    robotics: {
+        name: "Robotics",
+        modality: "rl",
+        subtasks: [
+            {
+                type: "grasping",
+                name: "Grasping",
+            },
+            {
+                type: "task-planning",
+                name: "Task Planning",
+            },
+        ],
+        color: "blue",
+    },
+    "tabular-classification": {
+        name: "Tabular Classification",
+        modality: "tabular",
+        subtasks: [
+            {
+                type: "tabular-multi-class-classification",
+                name: "Tabular Multi Class Classification",
+            },
+            {
+                type: "tabular-multi-label-classification",
+                name: "Tabular Multi Label Classification",
+            },
+        ],
+        color: "blue",
+    },
+    "tabular-regression": {
+        name: "Tabular Regression",
+        modality: "tabular",
+        subtasks: [
+            {
+                type: "tabular-single-column-regression",
+                name: "Tabular Single Column Regression",
+            },
+        ],
+        color: "blue",
+    },
+    "tabular-to-text": {
+        name: "Tabular to Text",
+        modality: "tabular",
+        subtasks: [
+            {
+                type: "rdf-to-text",
+                name: "RDF to text",
+            },
+        ],
+        color: "blue",
+        hideInModels: true,
+    },
+    "table-to-text": {
+        name: "Table to Text",
+        modality: "nlp",
+        color: "blue",
+        hideInModels: true,
+    },
+    "multiple-choice": {
+        name: "Multiple Choice",
+        subtasks: [
+            {
+                type: "multiple-choice-qa",
+                name: "Multiple Choice QA",
+            },
+            {
+                type: "multiple-choice-coreference-resolution",
+                name: "Multiple Choice Coreference Resolution",
+            },
+        ],
+        modality: "nlp",
+        color: "blue",
+        hideInModels: true,
+    },
+    "text-retrieval": {
+        name: "Text Retrieval",
+        subtasks: [
+            {
+                type: "document-retrieval",
+                name: "Document Retrieval",
+            },
+            {
+                type: "utterance-retrieval",
+                name: "Utterance Retrieval",
+            },
+            {
+                type: "entity-linking-retrieval",
+                name: "Entity Linking Retrieval",
+            },
+            {
+                type: "fact-checking-retrieval",
+                name: "Fact Checking Retrieval",
+            },
+        ],
+        modality: "nlp",
+        color: "indigo",
+        hideInModels: true,
+    },
+    "time-series-forecasting": {
+        name: "Time Series Forecasting",
+        modality: "tabular",
+        subtasks: [
+            {
+                type: "univariate-time-series-forecasting",
+                name: "Univariate Time Series Forecasting",
+            },
+            {
+                type: "multivariate-time-series-forecasting",
+                name: "Multivariate Time Series Forecasting",
+            },
+        ],
+        color: "blue",
+    },
+    "text-to-video": {
+        name: "Text-to-Video",
+        modality: "cv",
+        color: "green",
+    },
+    "image-text-to-text": {
+        name: "Image-Text-to-Text",
+        modality: "multimodal",
+        color: "red",
+        hideInDatasets: true,
+    },
+    "visual-question-answering": {
+        name: "Visual Question Answering",
+        subtasks: [
+            {
+                type: "visual-question-answering",
+                name: "Visual Question Answering",
+            },
+        ],
+        modality: "multimodal",
+        color: "red",
+    },
+    "document-question-answering": {
+        name: "Document Question Answering",
+        subtasks: [
+            {
+                type: "document-question-answering",
+                name: "Document Question Answering",
+            },
+        ],
+        modality: "multimodal",
+        color: "blue",
+        hideInDatasets: true,
+    },
+    "zero-shot-image-classification": {
+        name: "Zero-Shot Image Classification",
+        modality: "cv",
+        color: "yellow",
+    },
+    "graph-ml": {
+        name: "Graph Machine Learning",
+        modality: "other",
+        color: "green",
+    },
+    "mask-generation": {
+        name: "Mask Generation",
+        modality: "cv",
+        color: "indigo",
+    },
+    "zero-shot-object-detection": {
+        name: "Zero-Shot Object Detection",
+        modality: "cv",
+        color: "yellow",
+    },
+    "text-to-3d": {
+        name: "Text-to-3D",
+        modality: "cv",
+        color: "yellow",
+    },
+    "image-to-3d": {
+        name: "Image-to-3D",
+        modality: "cv",
+        color: "green",
+    },
+    "image-feature-extraction": {
+        name: "Image Feature Extraction",
+        modality: "cv",
+        color: "indigo",
+    },
+    "video-text-to-text": {
+        name: "Video-Text-to-Text",
+        modality: "multimodal",
+        color: "blue",
+        hideInDatasets: false,
+    },
+    "keypoint-detection": {
+        name: "Keypoint Detection",
+        subtasks: [
+            {
+                type: "pose-estimation",
+                name: "Pose Estimation",
+            },
+        ],
+        modality: "cv",
+        color: "red",
+        hideInDatasets: true,
+    },
+    "any-to-any": {
+        name: "Any-to-Any",
+        modality: "multimodal",
+        color: "yellow",
+        hideInDatasets: true,
+    },
+    other: {
+        name: "Other",
+        modality: "other",
+        color: "blue",
+        hideInModels: true,
+        hideInDatasets: true,
+    },
+};
+export const PIPELINE_TYPES = Object.keys(PIPELINE_DATA);
+export const SUBTASK_TYPES = Object.values(PIPELINE_DATA)
+    .flatMap((data) => ("subtasks" in data ? data.subtasks : []))
+    .map((s) => s.type);
+export const PIPELINE_TYPES_SET = new Set(PIPELINE_TYPES);

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

@@ -0,0 +1,14 @@
+import type { ChatCompletionInputMessage, GenerationParameters } from "../tasks/index.js";
+export declare function stringifyMessages(messages: ChatCompletionInputMessage[], opts?: {
+    indent?: string;
+    attributeKeyQuotes?: boolean;
+    customContentEscaper?: (str: string) => string;
+}): string;
+type PartialGenerationParameters = Partial<Pick<GenerationParameters, "temperature" | "max_tokens" | "top_p">>;
+export declare function stringifyGenerationConfig(config: PartialGenerationParameters, opts: {
+    indent: string;
+    attributeValueConnector: string;
+    attributeKeyQuotes?: boolean;
+}): string;
+export {};
+//# sourceMappingURL=common.d.ts.map

package/dist/esm/snippets/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/snippets/common.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAE1F,wBAAgB,iBAAiB,CAChC,QAAQ,EAAE,0BAA0B,EAAE,EACtC,IAAI,CAAC,EAAE;IACN,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,oBAAoB,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;CAC/C,GACC,MAAM,CAYR;AAED,KAAK,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,aAAa,GAAG,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC;AAE/G,wBAAgB,yBAAyB,CACxC,MAAM,EAAE,2BAA2B,EACnC,IAAI,EAAE;IACL,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB,EAAE,MAAM,CAAC;IAChC,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC7B,GACC,MAAM,CAMR"}

package/dist/esm/snippets/common.js

@@ -0,0 +1,19 @@
+export function stringifyMessages(messages, opts) {
+    let messagesStr = JSON.stringify(messages, null, "\t");
+    if (opts?.indent) {
+        messagesStr = messagesStr.replaceAll("\n", `\n${opts.indent}`);
+    }
+    if (!opts?.attributeKeyQuotes) {
+        messagesStr = messagesStr.replace(/"([^"]+)":/g, "$1:");
+    }
+    if (opts?.customContentEscaper) {
+        messagesStr = opts.customContentEscaper(messagesStr);
+    }
+    return messagesStr;
+}
+export function stringifyGenerationConfig(config, opts) {
+    const quote = opts.attributeKeyQuotes ? `"` : "";
+    return Object.entries(config)
+        .map(([key, val]) => `${quote}${key}${quote}${opts.attributeValueConnector}${val}`)
+        .join(`,${opts.indent}`);
+}

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

@@ -0,0 +1,17 @@
+import type { PipelineType } from "../pipelines.js";
+import type { ChatCompletionInputMessage, GenerationParameters } from "../tasks/index.js";
+import type { InferenceSnippet, ModelDataMinimal } from "./types.js";
+export declare const snippetBasic: (model: ModelDataMinimal, accessToken: string) => InferenceSnippet;
+export declare const snippetTextGeneration: (model: ModelDataMinimal, accessToken: string, 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, accessToken: string) => InferenceSnippet;
+export declare const snippetFile: (model: ModelDataMinimal, accessToken: string) => InferenceSnippet;
+export declare const curlSnippets: Partial<Record<PipelineType, (model: ModelDataMinimal, accessToken: string, opts?: Record<string, unknown>) => InferenceSnippet>>;
+export declare function getCurlInferenceSnippet(model: ModelDataMinimal, accessToken: string, opts?: Record<string, unknown>): InferenceSnippet;
+export declare function hasCurlInferenceSnippet(model: Pick<ModelDataMinimal, "pipeline_tag">): boolean;
+//# sourceMappingURL=curl.d.ts.map

package/dist/esm/snippets/curl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"curl.d.ts","sourceRoot":"","sources":["../../../src/snippets/curl.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;AAErE,eAAO,MAAM,YAAY,UAAW,gBAAgB,eAAe,MAAM,KAAG,gBAM1E,CAAC;AAEH,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,gBAkCF,CAAC;AAEF,eAAO,MAAM,6BAA6B,UAAW,gBAAgB,eAAe,MAAM,KAAG,gBAM3F,CAAC;AAEH,eAAO,MAAM,WAAW,UAAW,gBAAgB,eAAe,MAAM,KAAG,gBAKzE,CAAC;AAEH,eAAO,MAAM,YAAY,EAAE,OAAO,CACjC,MAAM,CACL,YAAY,EACZ,CAAC,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,gBAAgB,CAClG,CA0BD,CAAC;AAEF,wBAAgB,uBAAuB,CACtC,KAAK,EAAE,gBAAgB,EACvB,WAAW,EAAE,MAAM,EACnB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,gBAAgB,CAIlB;AAED,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,IAAI,CAAC,gBAAgB,EAAE,cAAc,CAAC,GAAG,OAAO,CAE9F"}