@huggingface/tasks 0.9.0 → 0.10.0

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

@@ -0,0 +1,490 @@
+import type { ModelData } from "./model-data";
+import type { ElasticBoolQueryFilter } from "./model-libraries-downloads";
+/**
+ * Elements configurable by a model library.
+ */
+export interface LibraryUiElement {
+    /**
+     * Pretty name of the library.
+     * displayed in tags, and on the main
+     * call-to-action button on the model page.
+     */
+    prettyLabel: string;
+    /**
+     * Repo name of the library's (usually on GitHub) code repo
+     */
+    repoName: string;
+    /**
+     * URL to library's (usually on GitHub) code repo
+     */
+    repoUrl: string;
+    /**
+     * URL to library's docs
+     */
+    docsUrl?: string;
+    /**
+     * Code snippet(s) displayed on model page
+     */
+    snippets?: (model: ModelData) => string[];
+    /**
+     * Elastic query used to count this library's model downloads
+     *
+     * By default, those files are counted:
+     * "config.json", "config.yaml", "hyperparams.yaml", "meta.yaml"
+     */
+    countDownloads?: ElasticBoolQueryFilter;
+    /**
+     * should we display this library in hf.co/models filter
+     * (only for popular libraries with > 100 models)
+     */
+    filter?: boolean;
+}
+/**
+ * Add your new library here.
+ *
+ * This is for modeling (= architectures) libraries, not for file formats (like ONNX, etc).
+ * (unlike libraries, file formats live in an enum inside the internal codebase.)
+ *
+ * Doc on how to add a library to the Hub:
+ *
+ * https://huggingface.co/docs/hub/models-adding-libraries
+ *
+ * /!\ IMPORTANT
+ *
+ * The key you choose is the tag your models have in their library_name on the Hub.
+ */
+export declare const MODEL_LIBRARIES_UI_ELEMENTS: {
+    "adapter-transformers": {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+        countDownloads: {
+            term: {
+                path: string;
+            };
+        };
+    };
+    allennlp: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+    };
+    asteroid: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+        countDownloads: {
+            term: {
+                path: string;
+            };
+        };
+    };
+    audiocraft: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: false;
+    };
+    bertopic: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+    };
+    diffusers: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+    };
+    doctr: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+    };
+    elm: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        filter: false;
+        countDownloads: {
+            wildcard: {
+                path: string;
+            };
+        };
+    };
+    espnet: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+    };
+    fairseq: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+    };
+    fastai: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+    };
+    fasttext: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+    };
+    flair: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+        countDownloads: {
+            term: {
+                path: string;
+            };
+        };
+    };
+    gliner: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: false;
+        countDownloads: {
+            term: {
+                path: string;
+            };
+        };
+    };
+    grok: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        filter: false;
+        countDownloads: {
+            terms: {
+                path: string[];
+            };
+        };
+    };
+    keras: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+        countDownloads: {
+            term: {
+                path: string;
+            };
+        };
+    };
+    "keras-nlp": {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+    };
+    k2: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+    };
+    mindspore: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+    };
+    "ml-agents": {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+        countDownloads: {
+            wildcard: {
+                path: string;
+            };
+        };
+    };
+    mlx: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+    };
+    "mlx-image": {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: false;
+        countDownloads: {
+            term: {
+                path: string;
+            };
+        };
+    };
+    nemo: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+        countDownloads: {
+            wildcard: {
+                path: string;
+            };
+        };
+    };
+    open_clip: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+        countDownloads: {
+            wildcard: {
+                path: string;
+            };
+        };
+    };
+    paddlenlp: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+        countDownloads: {
+            term: {
+                path: string;
+            };
+        };
+    };
+    peft: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+        countDownloads: {
+            term: {
+                path: string;
+            };
+        };
+    };
+    "pyannote-audio": {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+    };
+    pythae: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+    };
+    "sample-factory": {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+        countDownloads: {
+            term: {
+                path: string;
+            };
+        };
+    };
+    "sentence-transformers": {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+    };
+    setfit: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+    };
+    sklearn: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+        countDownloads: {
+            term: {
+                path: string;
+            };
+        };
+    };
+    spacy: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+        countDownloads: {
+            wildcard: {
+                path: string;
+            };
+        };
+    };
+    "span-marker": {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+    };
+    speechbrain: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+        countDownloads: {
+            term: {
+                path: string;
+            };
+        };
+    };
+    "stable-baselines3": {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+        countDownloads: {
+            wildcard: {
+                path: string;
+            };
+        };
+    };
+    stanza: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+        countDownloads: {
+            term: {
+                path: string;
+            };
+        };
+    };
+    tensorflowtts: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        snippets: (model: ModelData) => string[];
+    };
+    timm: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+        countDownloads: {
+            terms: {
+                path: string[];
+            };
+        };
+    };
+    transformers: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+    };
+    "transformers.js": {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+        filter: true;
+    };
+    "unity-sentis": {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        snippets: () => string[];
+        filter: true;
+        countDownloads: {
+            wildcard: {
+                path: string;
+            };
+        };
+    };
+    voicecraft: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        docsUrl: string;
+        snippets: (model: ModelData) => string[];
+    };
+    whisperkit: {
+        prettyLabel: string;
+        repoName: string;
+        repoUrl: string;
+        countDownloads: {
+            wildcard: {
+                path: string;
+            };
+        };
+    };
+};
+export type ModelLibraryKey = keyof typeof MODEL_LIBRARIES_UI_ELEMENTS;
+export declare const ALL_MODEL_LIBRARY_KEYS: ("sklearn" | "adapter-transformers" | "allennlp" | "asteroid" | "audiocraft" | "bertopic" | "diffusers" | "doctr" | "elm" | "espnet" | "fairseq" | "fastai" | "fasttext" | "flair" | "gliner" | "grok" | "keras" | "keras-nlp" | "k2" | "mindspore" | "ml-agents" | "mlx" | "mlx-image" | "nemo" | "open_clip" | "paddlenlp" | "peft" | "pyannote-audio" | "pythae" | "sample-factory" | "sentence-transformers" | "setfit" | "spacy" | "span-marker" | "speechbrain" | "stable-baselines3" | "stanza" | "tensorflowtts" | "timm" | "transformers" | "transformers.js" | "unity-sentis" | "voicecraft" | "whisperkit")[];
+export declare const ALL_DISPLAY_MODEL_LIBRARY_KEYS: ("sklearn" | "adapter-transformers" | "allennlp" | "asteroid" | "audiocraft" | "bertopic" | "diffusers" | "doctr" | "elm" | "espnet" | "fairseq" | "fastai" | "fasttext" | "flair" | "gliner" | "grok" | "keras" | "keras-nlp" | "k2" | "mindspore" | "ml-agents" | "mlx" | "mlx-image" | "nemo" | "open_clip" | "paddlenlp" | "peft" | "pyannote-audio" | "pythae" | "sample-factory" | "sentence-transformers" | "setfit" | "spacy" | "span-marker" | "speechbrain" | "stable-baselines3" | "stanza" | "tensorflowtts" | "timm" | "transformers" | "transformers.js" | "unity-sentis" | "voicecraft" | "whisperkit")[];
+//# sourceMappingURL=model-libraries.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"model-libraries.d.ts","sourceRoot":"","sources":["../../src/model-libraries.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAE1E;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,MAAM,EAAE,CAAC;IAC1C;;;;;OAKG;IACH,cAAc,CAAC,EAAE,sBAAsB,CAAC;IACxC;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;;;;;;;;;;;GAaG;AAEH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuXI,CAAC;AAE7C,MAAM,MAAM,eAAe,GAAG,MAAM,OAAO,2BAA2B,CAAC;AAEvE,eAAO,MAAM,sBAAsB,0lBAAgE,CAAC;AAEpG,eAAO,MAAM,8BAA8B,0lBAQ1B,CAAC"}