@huggingface/tasks 0.13.0-test2 → 0.13.0-test3

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AACjE,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAC9E,cAAc,SAAS,CAAC;AACxB,OAAO,EACN,aAAa,EACb,cAAc,EACd,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,QAAQ,EACb,UAAU,EACV,eAAe,EACf,aAAa,EACb,kBAAkB,GAClB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,8BAA8B,EAAE,sBAAsB,EAAE,2BAA2B,EAAE,MAAM,mBAAmB,CAAC;AACxH,YAAY,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC3E,YAAY,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChE,YAAY,EAAE,UAAU,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACtF,YAAY,EACX,aAAa,EACb,sBAAsB,EACtB,gCAAgC,EAChC,8BAA8B,EAC9B,kCAAkC,EAClC,uBAAuB,EACvB,sBAAsB,EACtB,oCAAoC,EACpC,gCAAgC,EAChC,2BAA2B,EAC3B,gCAAgC,EAChC,8BAA8B,EAC9B,sBAAsB,EACtB,8BAA8B,EAC9B,mBAAmB,EACnB,sBAAsB,EACtB,yBAAyB,EACzB,8BAA8B,EAC9B,uBAAuB,GACvB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAE7D,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,cAAc,QAAQ,CAAC;AAEvB,OAAO,EAAE,QAAQ,EAAE,CAAC;AAEpB,OAAO,EAAE,IAAI,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAC1D,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,YAAY,EAAE,QAAQ,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE3E,OAAO,EAAE,6BAA6B,EAAE,MAAM,qBAAqB,CAAC;AACpE,YAAY,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/library-to-tasks.d.cts

@@ -0,0 +1,11 @@
+import type { ModelLibraryKey } from "./model-libraries";
+import type { PipelineType } from "./pipelines";
+/**
+ * Mapping from library name to its supported tasks.
+ * Inference API (serverless) should be disabled for all other (library, task) pairs beyond this mapping.
+ * This mapping is partially generated automatically by "python-api-export-tasks" action in
+ * huggingface/api-inference-community repo upon merge. For transformers, the mapping is manually
+ * based on api-inference (hf_types.rs).
+ */
+export declare const LIBRARY_TASK_MAPPING: Partial<Record<ModelLibraryKey, PipelineType[]>>;
+//# sourceMappingURL=library-to-tasks.d.cts.map

package/dist/library-to-tasks.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"library-to-tasks.d.cts","sourceRoot":"","sources":["../src/library-to-tasks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEhD;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,EAAE,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,YAAY,EAAE,CAAC,CAiEjF,CAAC"}

package/dist/library-to-tasks.d.ts

@@ -0,0 +1,11 @@
+import type { ModelLibraryKey } from "./model-libraries";
+import type { PipelineType } from "./pipelines";
+/**
+ * Mapping from library name to its supported tasks.
+ * Inference API (serverless) should be disabled for all other (library, task) pairs beyond this mapping.
+ * This mapping is partially generated automatically by "python-api-export-tasks" action in
+ * huggingface/api-inference-community repo upon merge. For transformers, the mapping is manually
+ * based on api-inference (hf_types.rs).
+ */
+export declare const LIBRARY_TASK_MAPPING: Partial<Record<ModelLibraryKey, PipelineType[]>>;
+//# sourceMappingURL=library-to-tasks.d.ts.map

package/dist/library-to-tasks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"library-to-tasks.d.ts","sourceRoot":"","sources":["../src/library-to-tasks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEhD;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,EAAE,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,YAAY,EAAE,CAAC,CAiEjF,CAAC"}

package/dist/local-apps.d.cts

@@ -0,0 +1,195 @@
+import type { ModelData } from "./model-data";
+import type { PipelineType } from "./pipelines";
+export interface LocalAppSnippet {
+    /**
+     * Title of the snippet
+     */
+    title: string;
+    /**
+     * Optional setup guide
+     */
+    setup?: string;
+    /**
+     * Content (or command) to be run
+     */
+    content: string | string[];
+}
+/**
+ * Elements configurable by a local app.
+ */
+export type LocalApp = {
+    /**
+     * Name that appears in buttons
+     */
+    prettyLabel: string;
+    /**
+     * Link to get more info about a local app (website etc)
+     */
+    docsUrl: string;
+    /**
+     * main category of app
+     */
+    mainTask: PipelineType;
+    /**
+     * Whether to display a pill "macOS-only"
+     */
+    macOSOnly?: boolean;
+    comingSoon?: boolean;
+    /**
+     * IMPORTANT: function to figure out whether to display the button on a model page's main "Use this model" dropdown.
+     */
+    displayOnModelPage: (model: ModelData) => boolean;
+} & ({
+    /**
+     * If the app supports deeplink, URL to open.
+     */
+    deeplink: (model: ModelData, filepath?: string) => URL;
+} | {
+    /**
+     * And if not (mostly llama.cpp), snippet to copy/paste in your terminal
+     * Support the placeholder {{GGUF_FILE}} that will be replaced by the gguf file path or the list of available files.
+     * Support the placeholder {{OLLAMA_TAG}} that will be replaced by the list of available quant tags or will be removed if there are no multiple quant files in a same repo.
+     */
+    snippet: (model: ModelData, filepath?: string) => string | string[] | LocalAppSnippet | LocalAppSnippet[];
+});
+declare function isTgiModel(model: ModelData): boolean;
+declare function isLlamaCppGgufModel(model: ModelData): boolean;
+/**
+ * Add your new local app here.
+ *
+ * This is open to new suggestions and awesome upcoming apps.
+ *
+ * /!\ IMPORTANT
+ *
+ * If possible, you need to support deeplinks and be as cross-platform as possible.
+ *
+ * Ping the HF team if we can help with anything!
+ */
+export declare const LOCAL_APPS: {
+    "llama.cpp": {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: typeof isLlamaCppGgufModel;
+        snippet: (model: ModelData, filepath?: string) => LocalAppSnippet[];
+    };
+    "node-llama-cpp": {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: typeof isLlamaCppGgufModel;
+        snippet: (model: ModelData, filepath?: string) => LocalAppSnippet[];
+    };
+    vllm: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: (model: ModelData) => boolean;
+        snippet: (model: ModelData) => LocalAppSnippet[];
+    };
+    tgi: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: typeof isTgiModel;
+        snippet: (model: ModelData) => LocalAppSnippet[];
+    };
+    lmstudio: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: (model: ModelData) => boolean;
+        deeplink: (model: ModelData, filepath: string | undefined) => URL;
+    };
+    localai: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: typeof isLlamaCppGgufModel;
+        snippet: (model: ModelData, filepath?: string) => LocalAppSnippet[];
+    };
+    jan: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: typeof isLlamaCppGgufModel;
+        deeplink: (model: ModelData) => URL;
+    };
+    backyard: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: typeof isLlamaCppGgufModel;
+        deeplink: (model: ModelData) => URL;
+    };
+    sanctum: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: typeof isLlamaCppGgufModel;
+        deeplink: (model: ModelData) => URL;
+    };
+    jellybox: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: (model: ModelData) => boolean;
+        deeplink: (model: ModelData) => URL;
+    };
+    msty: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: typeof isLlamaCppGgufModel;
+        deeplink: (model: ModelData) => URL;
+    };
+    recursechat: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        macOSOnly: true;
+        displayOnModelPage: typeof isLlamaCppGgufModel;
+        deeplink: (model: ModelData) => URL;
+    };
+    drawthings: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-to-image";
+        macOSOnly: true;
+        displayOnModelPage: (model: ModelData) => boolean;
+        deeplink: (model: ModelData) => URL;
+    };
+    diffusionbee: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-to-image";
+        macOSOnly: true;
+        displayOnModelPage: (model: ModelData) => boolean;
+        deeplink: (model: ModelData) => URL;
+    };
+    joyfusion: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-to-image";
+        macOSOnly: true;
+        displayOnModelPage: (model: ModelData) => boolean;
+        deeplink: (model: ModelData) => URL;
+    };
+    invoke: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-to-image";
+        displayOnModelPage: (model: ModelData) => boolean;
+        deeplink: (model: ModelData) => URL;
+    };
+    ollama: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: typeof isLlamaCppGgufModel;
+        snippet: (model: ModelData, filepath?: string) => string;
+    };
+};
+export type LocalAppKey = keyof typeof LOCAL_APPS;
+export {};
+//# sourceMappingURL=local-apps.d.cts.map

package/dist/local-apps.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-apps.d.cts","sourceRoot":"","sources":["../src/local-apps.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEhD,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAC;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,kBAAkB,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,OAAO,CAAC;CAClD,GAAG,CACD;IACA;;OAEG;IACH,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,GAAG,CAAC;CACtD,GACD;IACA;;;;OAIG;IACH,OAAO,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,MAAM,GAAG,MAAM,EAAE,GAAG,eAAe,GAAG,eAAe,EAAE,CAAC;CACzG,CACH,CAAC;AAqBF,iBAAS,UAAU,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAE7C;AAED,iBAAS,mBAAmB,CAAC,KAAK,EAAE,SAAS,WAE5C;AA+JD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU;;;;;;yBApKS,SAAS,aAAa,MAAM,KAAG,eAAe,EAAE;;;;;;;yBAqCzC,SAAS,aAAa,MAAM,KAAG,eAAe,EAAE;;;;;;oCAkJzD,SAAS;yBAjGX,SAAS,KAAG,eAAe,EAAE;;;;;;;yBAsC9B,SAAS,KAAG,eAAe,EAAE;;;;;;;;;;;;;;yBA7DzB,SAAS,aAAa,MAAM,KAAG,eAAe,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBATjD,SAAS,aAAa,MAAM,KAAG,MAAM;;CAsQ/B,CAAC;AAErC,MAAM,MAAM,WAAW,GAAG,MAAM,OAAO,UAAU,CAAC"}

package/dist/local-apps.d.ts

@@ -0,0 +1,195 @@
+import type { ModelData } from "./model-data";
+import type { PipelineType } from "./pipelines";
+export interface LocalAppSnippet {
+    /**
+     * Title of the snippet
+     */
+    title: string;
+    /**
+     * Optional setup guide
+     */
+    setup?: string;
+    /**
+     * Content (or command) to be run
+     */
+    content: string | string[];
+}
+/**
+ * Elements configurable by a local app.
+ */
+export type LocalApp = {
+    /**
+     * Name that appears in buttons
+     */
+    prettyLabel: string;
+    /**
+     * Link to get more info about a local app (website etc)
+     */
+    docsUrl: string;
+    /**
+     * main category of app
+     */
+    mainTask: PipelineType;
+    /**
+     * Whether to display a pill "macOS-only"
+     */
+    macOSOnly?: boolean;
+    comingSoon?: boolean;
+    /**
+     * IMPORTANT: function to figure out whether to display the button on a model page's main "Use this model" dropdown.
+     */
+    displayOnModelPage: (model: ModelData) => boolean;
+} & ({
+    /**
+     * If the app supports deeplink, URL to open.
+     */
+    deeplink: (model: ModelData, filepath?: string) => URL;
+} | {
+    /**
+     * And if not (mostly llama.cpp), snippet to copy/paste in your terminal
+     * Support the placeholder {{GGUF_FILE}} that will be replaced by the gguf file path or the list of available files.
+     * Support the placeholder {{OLLAMA_TAG}} that will be replaced by the list of available quant tags or will be removed if there are no multiple quant files in a same repo.
+     */
+    snippet: (model: ModelData, filepath?: string) => string | string[] | LocalAppSnippet | LocalAppSnippet[];
+});
+declare function isTgiModel(model: ModelData): boolean;
+declare function isLlamaCppGgufModel(model: ModelData): boolean;
+/**
+ * Add your new local app here.
+ *
+ * This is open to new suggestions and awesome upcoming apps.
+ *
+ * /!\ IMPORTANT
+ *
+ * If possible, you need to support deeplinks and be as cross-platform as possible.
+ *
+ * Ping the HF team if we can help with anything!
+ */
+export declare const LOCAL_APPS: {
+    "llama.cpp": {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: typeof isLlamaCppGgufModel;
+        snippet: (model: ModelData, filepath?: string) => LocalAppSnippet[];
+    };
+    "node-llama-cpp": {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: typeof isLlamaCppGgufModel;
+        snippet: (model: ModelData, filepath?: string) => LocalAppSnippet[];
+    };
+    vllm: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: (model: ModelData) => boolean;
+        snippet: (model: ModelData) => LocalAppSnippet[];
+    };
+    tgi: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: typeof isTgiModel;
+        snippet: (model: ModelData) => LocalAppSnippet[];
+    };
+    lmstudio: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: (model: ModelData) => boolean;
+        deeplink: (model: ModelData, filepath: string | undefined) => URL;
+    };
+    localai: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: typeof isLlamaCppGgufModel;
+        snippet: (model: ModelData, filepath?: string) => LocalAppSnippet[];
+    };
+    jan: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: typeof isLlamaCppGgufModel;
+        deeplink: (model: ModelData) => URL;
+    };
+    backyard: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: typeof isLlamaCppGgufModel;
+        deeplink: (model: ModelData) => URL;
+    };
+    sanctum: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: typeof isLlamaCppGgufModel;
+        deeplink: (model: ModelData) => URL;
+    };
+    jellybox: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: (model: ModelData) => boolean;
+        deeplink: (model: ModelData) => URL;
+    };
+    msty: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: typeof isLlamaCppGgufModel;
+        deeplink: (model: ModelData) => URL;
+    };
+    recursechat: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        macOSOnly: true;
+        displayOnModelPage: typeof isLlamaCppGgufModel;
+        deeplink: (model: ModelData) => URL;
+    };
+    drawthings: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-to-image";
+        macOSOnly: true;
+        displayOnModelPage: (model: ModelData) => boolean;
+        deeplink: (model: ModelData) => URL;
+    };
+    diffusionbee: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-to-image";
+        macOSOnly: true;
+        displayOnModelPage: (model: ModelData) => boolean;
+        deeplink: (model: ModelData) => URL;
+    };
+    joyfusion: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-to-image";
+        macOSOnly: true;
+        displayOnModelPage: (model: ModelData) => boolean;
+        deeplink: (model: ModelData) => URL;
+    };
+    invoke: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-to-image";
+        displayOnModelPage: (model: ModelData) => boolean;
+        deeplink: (model: ModelData) => URL;
+    };
+    ollama: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: typeof isLlamaCppGgufModel;
+        snippet: (model: ModelData, filepath?: string) => string;
+    };
+};
+export type LocalAppKey = keyof typeof LOCAL_APPS;
+export {};
+//# sourceMappingURL=local-apps.d.ts.map

package/dist/local-apps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-apps.d.ts","sourceRoot":"","sources":["../src/local-apps.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEhD,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAC;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,kBAAkB,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,OAAO,CAAC;CAClD,GAAG,CACD;IACA;;OAEG;IACH,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,GAAG,CAAC;CACtD,GACD;IACA;;;;OAIG;IACH,OAAO,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,MAAM,GAAG,MAAM,EAAE,GAAG,eAAe,GAAG,eAAe,EAAE,CAAC;CACzG,CACH,CAAC;AAqBF,iBAAS,UAAU,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAE7C;AAED,iBAAS,mBAAmB,CAAC,KAAK,EAAE,SAAS,WAE5C;AA+JD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU;;;;;;yBApKS,SAAS,aAAa,MAAM,KAAG,eAAe,EAAE;;;;;;;yBAqCzC,SAAS,aAAa,MAAM,KAAG,eAAe,EAAE;;;;;;oCAkJzD,SAAS;yBAjGX,SAAS,KAAG,eAAe,EAAE;;;;;;;yBAsC9B,SAAS,KAAG,eAAe,EAAE;;;;;;;;;;;;;;yBA7DzB,SAAS,aAAa,MAAM,KAAG,eAAe,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBATjD,SAAS,aAAa,MAAM,KAAG,MAAM;;CAsQ/B,CAAC;AAErC,MAAM,MAAM,WAAW,GAAG,MAAM,OAAO,UAAU,CAAC"}

package/dist/model-data.d.cts

@@ -0,0 +1,146 @@
+import type { PipelineType } from "./pipelines";
+import type { WidgetExample } from "./widget-example";
+import type { TokenizerConfig } from "./tokenizer-data";
+/**
+ * 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
+     * TODO(type it)
+     */
+    inference: string;
+    /**
+     * 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;
+            /**
+             * awq, gptq, aqlm, marlin, … Used by vLLM
+             */
+            quant_method?: string;
+        };
+        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[];
+        instance_prompt?: string | null;
+    };
+    /**
+     * Library name
+     * Example: transformers, SpeechBrain, Stanza, etc.
+     */
+    library_name?: string;
+    safetensors?: {
+        parameters: Record<string, number>;
+        total: number;
+        sharded: boolean;
+    };
+    gguf?: {
+        total: number;
+        architecture?: string;
+        context_length?: number;
+    };
+}
+/**
+ * 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.cts.map

package/dist/model-data.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-data.d.cts","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;;GAEG;AACH,MAAM,WAAW,SAAS;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;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;YACvB;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;SACtB,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;QAC/B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAChC,CAAC;IACF;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE;QACb,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACnC,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,OAAO,CAAC;KACjB,CAAC;IACF,IAAI,CAAC,EAAE;QACN,KAAK,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,cAAc,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;CACF;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"}