@huggingface/tasks 0.9.0 → 0.10.0

package/dist/src/model-data.d.ts

@@ -0,0 +1,144 @@
+import type { PipelineType } from "./pipelines";
+import type { WidgetExample } from "./widget-example";
+import type { TokenizerConfig } from "./tokenizer-data";
+export declare enum InferenceDisplayability {
+    /**
+     * Yes
+     */
+    Yes = "Yes",
+    /**
+     * And then, all the possible reasons why it's no:
+     */
+    ExplicitOptOut = "ExplicitOptOut",
+    CustomCode = "CustomCode",
+    LibraryNotDetected = "LibraryNotDetected",
+    PipelineNotDetected = "PipelineNotDetected",
+    PipelineLibraryPairNotSupported = "PipelineLibraryPairNotSupported"
+}
+/**
+ * Public interface for model metadata
+ */
+export interface ModelData {
+    /**
+     * id of model (e.g. 'user/repo_name')
+     */
+    id: string;
+    /**
+     * Whether or not to enable inference widget for this model
+     */
+    inference: InferenceDisplayability;
+    /**
+     * is this model private?
+     */
+    private?: boolean;
+    /**
+     * this dictionary has useful information about the model configuration
+     */
+    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?: {
+            model?: {
+                file?: string;
+            };
+            model_format?: string;
+        };
+        speechbrain?: {
+            speechbrain_interface?: string;
+            vocoder_interface?: string;
+            vocoder_model_id?: string;
+        };
+        peft?: {
+            base_model_name_or_path?: string;
+            task_type?: string;
+        };
+    };
+    /**
+     * all the model tags
+     */
+    tags: string[];
+    /**
+     * transformers-specific info to display in the code sample.
+     */
+    transformersInfo?: TransformersInfo;
+    /**
+     * Pipeline type
+     */
+    pipeline_tag?: PipelineType | undefined;
+    /**
+     * for relevant models, get mask token
+     */
+    mask_token?: string | undefined;
+    /**
+     * Example data that will be fed into the widget.
+     *
+     * can be set in the model card metadata (under `widget`),
+     * or by default in `DefaultWidget.ts`
+     */
+    widgetData?: WidgetExample[] | undefined;
+    /**
+     * Parameters that will be used by the widget when calling Inference API (serverless)
+     * https://huggingface.co/docs/api-inference/detailed_parameters
+     *
+     * can be set in the model card metadata (under `inference/parameters`)
+     * Example:
+     * inference:
+     *     parameters:
+     *         key: val
+     */
+    cardData?: {
+        inference?: boolean | {
+            parameters?: Record<string, unknown>;
+        };
+        base_model?: string | string[];
+    };
+    /**
+     * Library name
+     * Example: transformers, SpeechBrain, Stanza, etc.
+     */
+    library_name?: string;
+}
+/**
+ * transformers-specific info to display in the code sample.
+ */
+export interface TransformersInfo {
+    /**
+     * e.g. AutoModelForSequenceClassification
+     */
+    auto_model: string;
+    /**
+     * if set in config.json's auto_map
+     */
+    custom_class?: string;
+    /**
+     * e.g. text-classification
+     */
+    pipeline_tag?: PipelineType;
+    /**
+     * e.g. "AutoTokenizer" | "AutoFeatureExtractor" | "AutoProcessor"
+     */
+    processor?: string;
+}
+//# sourceMappingURL=model-data.d.ts.map

package/dist/src/model-data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-data.d.ts","sourceRoot":"","sources":["../../src/model-data.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD,oBAAY,uBAAuB;IAClC;;OAEG;IACH,GAAG,QAAQ;IACX;;OAEG;IACH,cAAc,mBAAmB;IACjC,UAAU,eAAe;IACzB,kBAAkB,uBAAuB;IACzC,mBAAmB,wBAAwB;IAC3C,+BAA+B,oCAAoC;CACnE;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,SAAS,EAAE,uBAAuB,CAAC;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE;QACR,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;QACzB;;WAEG;QACH,QAAQ,CAAC,EAAE;YACV;;eAEG;YACH,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;SACpB,CAAC;QACF,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,mBAAmB,CAAC,EAAE;YACrB,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,YAAY,CAAC,EAAE,OAAO,CAAC;YACvB,YAAY,CAAC,EAAE,OAAO,CAAC;SACvB,CAAC;QACF,gBAAgB,CAAC,EAAE,eAAe,CAAC;QACnC,oBAAoB,CAAC,EAAE;YACtB,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB,WAAW,CAAC,EAAE,MAAM,CAAC;SACrB,CAAC;QACF,SAAS,CAAC,EAAE;YACX,WAAW,CAAC,EAAE,MAAM,CAAC;SACrB,CAAC;QACF,OAAO,CAAC,EAAE;YACT,KAAK,CAAC,EAAE;gBACP,IAAI,CAAC,EAAE,MAAM,CAAC;aACd,CAAC;YACF,YAAY,CAAC,EAAE,MAAM,CAAC;SACtB,CAAC;QACF,WAAW,CAAC,EAAE;YACb,qBAAqB,CAAC,EAAE,MAAM,CAAC;YAC/B,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;SAC1B,CAAC;QACF,IAAI,CAAC,EAAE;YACN,uBAAuB,CAAC,EAAE,MAAM,CAAC;YACjC,SAAS,CAAC,EAAE,MAAM,CAAC;SACnB,CAAC;KACF,CAAC;IACF;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAC;IACf;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC;;OAEG;IACH,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,aAAa,EAAE,GAAG,SAAS,CAAC;IACzC;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE;QACV,SAAS,CAAC,EACP,OAAO,GACP;YACA,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SACpC,CAAC;QACL,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;KAC/B,CAAC;IACF;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB"}

package/dist/src/model-libraries-downloads.d.ts

@@ -0,0 +1,26 @@
+/**
+ * This file contains the (simplified) types used
+ * to represent queries that are made to Elastic
+ * in order to count number of model downloads
+ *
+ * Read this doc about download stats on the Hub:
+ *
+ * https://huggingface.co/docs/hub/models-download-stats
+ *
+ * see also:
+ * https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html
+ */
+export type ElasticBoolQueryFilter = {
+    term?: {
+        path: string;
+    };
+} | {
+    terms?: {
+        path: string[];
+    };
+} | {
+    wildcard?: {
+        path: string;
+    };
+};
+//# sourceMappingURL=model-libraries-downloads.d.ts.map

package/dist/src/model-libraries-downloads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-libraries-downloads.d.ts","sourceRoot":"","sources":["../../src/model-libraries-downloads.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,MAAM,MAAM,sBAAsB,GAE/B;IAAE,IAAI,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAE3B;IAAE,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,EAAE,CAAA;KAAE,CAAA;CAAE,GAE9B;IAAE,QAAQ,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAAC"}

package/dist/src/model-libraries-snippets.d.ts

@@ -0,0 +1,43 @@
+import type { ModelData } from "./model-data";
+export declare const adapters: (model: ModelData) => string[];
+export declare const allennlp: (model: ModelData) => string[];
+export declare const asteroid: (model: ModelData) => string[];
+export declare const bertopic: (model: ModelData) => string[];
+export declare const diffusers: (model: ModelData) => string[];
+export declare const espnetTTS: (model: ModelData) => string[];
+export declare const espnetASR: (model: ModelData) => string[];
+export declare const espnet: (model: ModelData) => string[];
+export declare const fairseq: (model: ModelData) => string[];
+export declare const flair: (model: ModelData) => string[];
+export declare const gliner: (model: ModelData) => string[];
+export declare const keras: (model: ModelData) => string[];
+export declare const keras_nlp: (model: ModelData) => string[];
+export declare const open_clip: (model: ModelData) => string[];
+export declare const paddlenlp: (model: ModelData) => string[];
+export declare const pyannote_audio_pipeline: (model: ModelData) => string[];
+export declare const pyannote_audio: (model: ModelData) => string[];
+export declare const tensorflowtts: (model: ModelData) => string[];
+export declare const timm: (model: ModelData) => string[];
+export declare const sklearn: (model: ModelData) => string[];
+export declare const fastai: (model: ModelData) => string[];
+export declare const sampleFactory: (model: ModelData) => string[];
+export declare const sentenceTransformers: (model: ModelData) => string[];
+export declare const setfit: (model: ModelData) => string[];
+export declare const spacy: (model: ModelData) => string[];
+export declare const span_marker: (model: ModelData) => string[];
+export declare const stanza: (model: ModelData) => string[];
+export declare const speechbrain: (model: ModelData) => string[];
+export declare const transformers: (model: ModelData) => string[];
+export declare const transformersJS: (model: ModelData) => string[];
+export declare const peft: (model: ModelData) => string[];
+export declare const fasttext: (model: ModelData) => string[];
+export declare const stableBaselines3: (model: ModelData) => string[];
+export declare const mlAgents: (model: ModelData) => string[];
+export declare const sentis: () => string[];
+export declare const voicecraft: (model: ModelData) => string[];
+export declare const mlx: (model: ModelData) => string[];
+export declare const mlxim: (model: ModelData) => string[];
+export declare const nemo: (model: ModelData) => string[];
+export declare const pythae: (model: ModelData) => string[];
+export declare const audiocraft: (model: ModelData) => string[];
+//# sourceMappingURL=model-libraries-snippets.d.ts.map

package/dist/src/model-libraries-snippets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-libraries-snippets.d.ts","sourceRoot":"","sources":["../../src/model-libraries-snippets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAW9C,eAAO,MAAM,QAAQ,UAAW,SAAS,KAAG,MAAM,EAKjD,CAAC;AAkBF,eAAO,MAAM,QAAQ,UAAW,SAAS,KAAG,MAAM,EAKjD,CAAC;AAEF,eAAO,MAAM,QAAQ,UAAW,SAAS,KAAG,MAAM,EAIjD,CAAC;AAMF,eAAO,MAAM,QAAQ,UAAW,SAAS,KAAG,MAAM,EAIjD,CAAC;AA+BF,eAAO,MAAM,SAAS,UAAW,SAAS,KAAG,MAAM,EAUlD,CAAC;AAEF,eAAO,MAAM,SAAS,UAAW,SAAS,KAAG,MAAM,EAMlD,CAAC;AAEF,eAAO,MAAM,SAAS,UAAW,SAAS,KAAG,MAAM,EASlD,CAAC;AAIF,eAAO,MAAM,MAAM,UAAW,SAAS,KAAG,MAAM,EAO/C,CAAC;AAEF,eAAO,MAAM,OAAO,UAAW,SAAS,KAAG,MAAM,EAMhD,CAAC;AAEF,eAAO,MAAM,KAAK,UAAW,SAAS,KAAG,MAAM,EAI9C,CAAC;AAEF,eAAO,MAAM,MAAM,UAAW,SAAS,KAAG,MAAM,EAI/C,CAAC;AAEF,eAAO,MAAM,KAAK,UAAW,SAAS,KAAG,MAAM,EAK9C,CAAC;AAEF,eAAO,MAAM,SAAS,UAAW,SAAS,KAAG,MAAM,EASlD,CAAC;AAEF,eAAO,MAAM,SAAS,UAAW,SAAS,KAAG,MAAM,EAKlD,CAAC;AAEF,eAAO,MAAM,SAAS,UAAW,SAAS,KAAG,MAAM,EAsBlD,CAAC;AAEF,eAAO,MAAM,uBAAuB,UAAW,SAAS,KAAG,MAAM,EAehE,CAAC;AAiBF,eAAO,MAAM,cAAc,UAAW,SAAS,KAAG,MAAM,EAKvD,CAAC;AAyBF,eAAO,MAAM,aAAa,UAAW,SAAS,KAAG,MAAM,EAOtD,CAAC;AAEF,eAAO,MAAM,IAAI,UAAW,SAAS,KAAG,MAAM,EAI7C,CAAC;AAsCF,eAAO,MAAM,OAAO,UAAW,SAAS,KAAG,MAAM,EAehD,CAAC;AAEF,eAAO,MAAM,MAAM,UAAW,SAAS,KAAG,MAAM,EAI/C,CAAC;AAEF,eAAO,MAAM,aAAa,UAAW,SAAS,KAAG,MAAM,EAEtD,CAAC;AAEF,eAAO,MAAM,oBAAoB,UAAW,SAAS,KAAG,MAAM,EAI7D,CAAC;AAEF,eAAO,MAAM,MAAM,UAAW,SAAS,KAAG,MAAM,EAI/C,CAAC;AAEF,eAAO,MAAM,KAAK,UAAW,SAAS,KAAG,MAAM,EAU9C,CAAC;AAEF,eAAO,MAAM,WAAW,UAAW,SAAS,KAAG,MAAM,EAIpD,CAAC;AAEF,eAAO,MAAM,MAAM,UAAW,SAAS,KAAG,MAAM,EAK/C,CAAC;AAkBF,eAAO,MAAM,WAAW,UAAW,SAAS,KAAG,MAAM,EAkBpD,CAAC;AAEF,eAAO,MAAM,YAAY,UAAW,SAAS,KAAG,MAAM,EAwCrD,CAAC;AAEF,eAAO,MAAM,cAAc,UAAW,SAAS,KAAG,MAAM,EAcvD,CAAC;AAiBF,eAAO,MAAM,IAAI,UAAW,SAAS,KAAG,MAAM,EAkB7C,CAAC;AAEF,eAAO,MAAM,QAAQ,UAAW,SAAS,KAAG,MAAM,EAKjD,CAAC;AAEF,eAAO,MAAM,gBAAgB,UAAW,SAAS,KAAG,MAAM,EAMzD,CAAC;AAgBF,eAAO,MAAM,QAAQ,UAAW,SAAS,KAAG,MAAM,EAEjD,CAAC;AAEF,eAAO,MAAM,MAAM,QAA6B,MAAM,EAMrD,CAAC;AAEF,eAAO,MAAM,UAAU,UAAW,SAAS,KAAG,MAAM,EAInD,CAAC;AAEF,eAAO,MAAM,GAAG,UAAW,SAAS,KAAG,MAAM,EAK5C,CAAC;AAEF,eAAO,MAAM,KAAK,UAAW,SAAS,KAAG,MAAM,EAI9C,CAAC;AAEF,eAAO,MAAM,IAAI,UAAW,SAAS,KAAG,MAAM,EAQ7C,CAAC;AAEF,eAAO,MAAM,MAAM,UAAW,SAAS,KAAG,MAAM,EAI/C,CAAC;AA6BF,eAAO,MAAM,UAAU,UAAW,SAAS,KAAG,MAAM,EAUnD,CAAC"}