@huggingface/tasks 0.9.0 → 0.10.0

package/README.md

@@ -1,8 +1,18 @@
 # Tasks
 
-This package contains data used for https://huggingface.co/tasks.
+This package contains the definition files (written in Typescript) for the huggingface.co hub's:
+
+- **pipeline types** (a.k.a. **task types**) - used to determine which widget to display on the model page, and which inference API to run.
+- **default widget inputs** - when they aren't provided in the model card.
+- definitions and UI elements for **model libraries** (and soon for **dataset libraries**).
+
+Please add any missing ones to these definitions by opening a PR. Thanks 🔥
 
-## Philosophy behind Tasks
+⚠️ The hub's definitive doc is at https://huggingface.co/docs/hub.
+
+## Definition of Tasks
+
+This package also contains data used to define https://huggingface.co/tasks.
 
 The Task pages are made to lower the barrier of entry to understand a task that can be solved with machine learning and use or train a model to accomplish it. It's a collaborative documentation effort made to help out software developers, social scientists, or anyone with no background in machine learning that is interested in understanding how machine learning models can be used to solve a problem. 
 
@@ -19,16 +29,4 @@ We have a [`dataset`](https://huggingface.co/datasets/huggingfacejs/tasks) that
 
 This might seem overwhelming, but you don't necessarily need to add all of these in one pull request or on your own, you can simply contribute one section. Feel free to ask for help whenever you need. 
 
-## Other data
-
-This package contains the definition files (written in Typescript) for the huggingface.co hub's:
-
-- **pipeline types** a.k.a. **task types** (used to determine which widget to display on the model page, and which inference API to run)
-- **default widget inputs** (when they aren't provided in the model card)
-- definitions and UI elements for **model libraries** (and soon for **dataset libraries**).
-
-Please add to any of those definitions by opening a PR. Thanks 🔥
-
-⚠️ The hub's definitive doc is at https://huggingface.co/docs/hub.
-
 ## Feedback (feature requests, bugs, etc.) is super welcome 💙💚💛💜♥️🧡

package/dist/index.cjs

@@ -24,6 +24,7 @@ __export(src_exports, {
   ALL_MODEL_LIBRARY_KEYS: () => ALL_MODEL_LIBRARY_KEYS,
   InferenceDisplayability: () => InferenceDisplayability,
   LIBRARY_TASK_MAPPING: () => LIBRARY_TASK_MAPPING,
+  LOCAL_APPS: () => LOCAL_APPS,
   MAPPING_DEFAULT_WIDGET: () => MAPPING_DEFAULT_WIDGET,
   MODALITIES: () => MODALITIES,
   MODALITY_LABELS: () => MODALITY_LABELS,
@@ -4067,7 +4068,7 @@ predictor_input = {"passage": "My name is Wolfgang and I live in Berlin", "quest
 predictions = predictor.predict_json(predictor_input)`
 ];
 var allennlp = (model) => {
-  if (model.tags?.includes("question-answering")) {
+  if (model.tags.includes("question-answering")) {
     return allennlpQuestionAnswering(model);
   }
   return allennlpUnknown(model);
@@ -4111,11 +4112,11 @@ pipeline = DiffusionPipeline.from_pretrained("${get_base_diffusers_model(model)}
 pipeline.load_textual_inversion("${model.id}")`
 ];
 var diffusers = (model) => {
-  if (model.tags?.includes("controlnet")) {
+  if (model.tags.includes("controlnet")) {
     return diffusers_controlnet(model);
-  } else if (model.tags?.includes("lora")) {
+  } else if (model.tags.includes("lora")) {
     return diffusers_lora(model);
-  } else if (model.tags?.includes("textual_inversion")) {
+  } else if (model.tags.includes("textual_inversion")) {
     return diffusers_textual_inversion(model);
   } else {
     return diffusers_default(model);
@@ -4140,9 +4141,9 @@ text, *_ = model(speech)[0]`
 ];
 var espnetUnknown = () => [`unknown model type (must be text-to-speech or automatic-speech-recognition)`];
 var espnet = (model) => {
-  if (model.tags?.includes("text-to-speech")) {
+  if (model.tags.includes("text-to-speech")) {
     return espnetTTS(model);
-  } else if (model.tags?.includes("automatic-speech-recognition")) {
+  } else if (model.tags.includes("automatic-speech-recognition")) {
     return espnetASR(model);
   }
   return espnetUnknown();
@@ -4171,7 +4172,10 @@ model = from_pretrained_keras("${model.id}")
 `
 ];
 var keras_nlp = (model) => [
-  `import keras_nlp
+  `# Available backend options are: "jax", "tensorflow", "torch".
+os.environ["KERAS_BACKEND"] = "tensorflow"
+
+import keras_nlp
 
 tokenizer = keras_nlp.models.Tokenizer.from_preset("hf://${model.id}")
 backbone = keras_nlp.models.Backbone.from_preset("hf://${model.id}")
@@ -4237,7 +4241,7 @@ excerpt = Segment(start=2.0, end=5.0)
 inference.crop("file.wav", excerpt)`
 ];
 var pyannote_audio = (model) => {
-  if (model.tags?.includes("pyannote-audio-pipeline")) {
+  if (model.tags.includes("pyannote-audio-pipeline")) {
     return pyannote_audio_pipeline(model);
   }
   return pyannote_audio_model(model);
@@ -4263,9 +4267,9 @@ model = TFAutoModel.from_pretrained("${model.id}")
 `
 ];
 var tensorflowtts = (model) => {
-  if (model.tags?.includes("text-to-mel")) {
+  if (model.tags.includes("text-to-mel")) {
     return tensorflowttsTextToMel(model);
-  } else if (model.tags?.includes("mel-to-wav")) {
+  } else if (model.tags.includes("mel-to-wav")) {
     return tensorflowttsMelToWav(model);
   }
   return tensorflowttsUnknown(model);
@@ -4309,7 +4313,7 @@ model = joblib.load(
   ];
 };
 var sklearn = (model) => {
-  if (model.tags?.includes("skops")) {
+  if (model.tags.includes("skops")) {
     const skopsmodelFile = model.config?.sklearn?.model?.file;
     const skopssaveFormat = model.config?.sklearn?.model_format;
     if (!skopsmodelFile) {
@@ -4401,7 +4405,7 @@ var transformers = (model) => {
   if (!info) {
     return [`# \u26A0\uFE0F Type of model unknown`];
   }
-  const remote_code_snippet = model.tags?.includes(TAG_CUSTOM_CODE) ? ", trust_remote_code=True" : "";
+  const remote_code_snippet = model.tags.includes(TAG_CUSTOM_CODE) ? ", trust_remote_code=True" : "";
   let autoSnippet;
   if (info.processor) {
     const varName = info.processor === "AutoTokenizer" ? "tokenizer" : info.processor === "AutoFeatureExtractor" ? "extractor" : "processor";
@@ -4471,8 +4475,8 @@ var peft = (model) => {
 from transformers import AutoModelFor${pefttask}
 
 config = PeftConfig.from_pretrained("${model.id}")
-model = AutoModelFor${pefttask}.from_pretrained("${peftBaseModel}")
-model = PeftModel.from_pretrained(model, "${model.id}")`
+base_model = AutoModelFor${pefttask}.from_pretrained("${peftBaseModel}")
+model = PeftModel.from_pretrained(base_model, "${model.id}")`
   ];
 };
 var fasttext = (model) => [
@@ -4529,7 +4533,7 @@ model = create_model(${model.id})`
 ];
 var nemo = (model) => {
   let command = void 0;
-  if (model.tags?.includes("automatic-speech-recognition")) {
+  if (model.tags.includes("automatic-speech-recognition")) {
     command = nemoDomainResolver("ASR", model);
   }
   return command ?? [`# tag did not correspond to a valid NeMo domain.`];
@@ -4564,11 +4568,11 @@ descriptions = ['dog barking', 'sirene of an emergency vehicle', 'footsteps in a
 wav = model.generate(descriptions)  # generates 3 samples.`
 ];
 var audiocraft = (model) => {
-  if (model.tags?.includes("musicgen")) {
+  if (model.tags.includes("musicgen")) {
     return musicgen(model);
-  } else if (model.tags?.includes("audiogen")) {
+  } else if (model.tags.includes("audiogen")) {
     return audiogen(model);
-  } else if (model.tags?.includes("magnet")) {
+  } else if (model.tags.includes("magnet")) {
     return magnet(model);
   } else {
     return [`# Type of model unknown.`];
@@ -4635,6 +4639,15 @@ var MODEL_LIBRARIES_UI_ELEMENTS = {
     repoName: "doctr",
     repoUrl: "https://github.com/mindee/doctr"
   },
+  elm: {
+    prettyLabel: "ELM",
+    repoName: "elm",
+    repoUrl: "https://github.com/slicex-ai/elm",
+    filter: false,
+    countDownloads: {
+      wildcard: { path: "*/slicex_elm_config.json" }
+    }
+  },
   espnet: {
     prettyLabel: "ESPnet",
     repoName: "ESPnet",
@@ -5421,12 +5434,72 @@ function getJsInferenceSnippet(model, accessToken) {
 function hasJsInferenceSnippet(model) {
   return !!model.pipeline_tag && model.pipeline_tag in jsSnippets;
 }
+
+// src/local-apps.ts
+function isGgufModel(model) {
+  return model.tags.includes("gguf");
+}
+var snippetLlamacpp = (model) => {
+  return `./main 	--hf-repo ${model.id} 	-m file.gguf 	-p "I believe the meaning of life is " -n 128`;
+};
+var LOCAL_APPS = {
+  "llama.cpp": {
+    prettyLabel: "llama.cpp",
+    docsUrl: "https://github.com/ggerganov/llama.cpp",
+    mainTask: "text-generation",
+    displayOnModelPage: isGgufModel,
+    snippet: snippetLlamacpp
+  },
+  lmstudio: {
+    prettyLabel: "LM Studio",
+    docsUrl: "https://lmstudio.ai",
+    mainTask: "text-generation",
+    displayOnModelPage: isGgufModel,
+    deeplink: (model) => new URL(`lmstudio://open_from_hf?model=${model.id}`)
+  },
+  jan: {
+    prettyLabel: "Jan",
+    docsUrl: "https://jan.ai",
+    mainTask: "text-generation",
+    displayOnModelPage: isGgufModel,
+    deeplink: (model) => new URL(`jan://open_from_hf?model=${model.id}`)
+  },
+  faraday: {
+    prettyLabel: "Faraday",
+    docsUrl: "https://faraday.dev",
+    mainTask: "text-generation",
+    macOSOnly: true,
+    displayOnModelPage: isGgufModel,
+    deeplink: (model) => new URL(`faraday://open_from_hf?model=${model.id}`)
+  },
+  drawthings: {
+    prettyLabel: "Draw Things",
+    docsUrl: "https://drawthings.ai",
+    mainTask: "text-to-image",
+    macOSOnly: true,
+    /**
+     * random function, will need to refine the actual conditions:
+     */
+    displayOnModelPage: (model) => model.tags.includes("textual_inversion"),
+    deeplink: (model) => new URL(`drawthings://open_from_hf?model=${model.id}`)
+  },
+  diffusionbee: {
+    prettyLabel: "DiffusionBee",
+    docsUrl: "https://diffusionbee.com",
+    mainTask: "text-to-image",
+    macOSOnly: true,
+    comingSoon: true,
+    displayOnModelPage: (model) => model.library_name === "diffusers" && model.pipeline_tag === "text-to-image",
+    deeplink: (model) => new URL(`diffusionbee://open_from_hf?model=${model.id}`)
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ALL_DISPLAY_MODEL_LIBRARY_KEYS,
   ALL_MODEL_LIBRARY_KEYS,
   InferenceDisplayability,
   LIBRARY_TASK_MAPPING,
+  LOCAL_APPS,
   MAPPING_DEFAULT_WIDGET,
   MODALITIES,
   MODALITY_LABELS,

package/dist/index.js

@@ -4032,7 +4032,7 @@ predictor_input = {"passage": "My name is Wolfgang and I live in Berlin", "quest
 predictions = predictor.predict_json(predictor_input)`
 ];
 var allennlp = (model) => {
-  if (model.tags?.includes("question-answering")) {
+  if (model.tags.includes("question-answering")) {
     return allennlpQuestionAnswering(model);
   }
   return allennlpUnknown(model);
@@ -4076,11 +4076,11 @@ pipeline = DiffusionPipeline.from_pretrained("${get_base_diffusers_model(model)}
 pipeline.load_textual_inversion("${model.id}")`
 ];
 var diffusers = (model) => {
-  if (model.tags?.includes("controlnet")) {
+  if (model.tags.includes("controlnet")) {
     return diffusers_controlnet(model);
-  } else if (model.tags?.includes("lora")) {
+  } else if (model.tags.includes("lora")) {
     return diffusers_lora(model);
-  } else if (model.tags?.includes("textual_inversion")) {
+  } else if (model.tags.includes("textual_inversion")) {
     return diffusers_textual_inversion(model);
   } else {
     return diffusers_default(model);
@@ -4105,9 +4105,9 @@ text, *_ = model(speech)[0]`
 ];
 var espnetUnknown = () => [`unknown model type (must be text-to-speech or automatic-speech-recognition)`];
 var espnet = (model) => {
-  if (model.tags?.includes("text-to-speech")) {
+  if (model.tags.includes("text-to-speech")) {
     return espnetTTS(model);
-  } else if (model.tags?.includes("automatic-speech-recognition")) {
+  } else if (model.tags.includes("automatic-speech-recognition")) {
     return espnetASR(model);
   }
   return espnetUnknown();
@@ -4136,7 +4136,10 @@ model = from_pretrained_keras("${model.id}")
 `
 ];
 var keras_nlp = (model) => [
-  `import keras_nlp
+  `# Available backend options are: "jax", "tensorflow", "torch".
+os.environ["KERAS_BACKEND"] = "tensorflow"
+
+import keras_nlp
 
 tokenizer = keras_nlp.models.Tokenizer.from_preset("hf://${model.id}")
 backbone = keras_nlp.models.Backbone.from_preset("hf://${model.id}")
@@ -4202,7 +4205,7 @@ excerpt = Segment(start=2.0, end=5.0)
 inference.crop("file.wav", excerpt)`
 ];
 var pyannote_audio = (model) => {
-  if (model.tags?.includes("pyannote-audio-pipeline")) {
+  if (model.tags.includes("pyannote-audio-pipeline")) {
     return pyannote_audio_pipeline(model);
   }
   return pyannote_audio_model(model);
@@ -4228,9 +4231,9 @@ model = TFAutoModel.from_pretrained("${model.id}")
 `
 ];
 var tensorflowtts = (model) => {
-  if (model.tags?.includes("text-to-mel")) {
+  if (model.tags.includes("text-to-mel")) {
     return tensorflowttsTextToMel(model);
-  } else if (model.tags?.includes("mel-to-wav")) {
+  } else if (model.tags.includes("mel-to-wav")) {
     return tensorflowttsMelToWav(model);
   }
   return tensorflowttsUnknown(model);
@@ -4274,7 +4277,7 @@ model = joblib.load(
   ];
 };
 var sklearn = (model) => {
-  if (model.tags?.includes("skops")) {
+  if (model.tags.includes("skops")) {
     const skopsmodelFile = model.config?.sklearn?.model?.file;
     const skopssaveFormat = model.config?.sklearn?.model_format;
     if (!skopsmodelFile) {
@@ -4366,7 +4369,7 @@ var transformers = (model) => {
   if (!info) {
     return [`# \u26A0\uFE0F Type of model unknown`];
   }
-  const remote_code_snippet = model.tags?.includes(TAG_CUSTOM_CODE) ? ", trust_remote_code=True" : "";
+  const remote_code_snippet = model.tags.includes(TAG_CUSTOM_CODE) ? ", trust_remote_code=True" : "";
   let autoSnippet;
   if (info.processor) {
     const varName = info.processor === "AutoTokenizer" ? "tokenizer" : info.processor === "AutoFeatureExtractor" ? "extractor" : "processor";
@@ -4436,8 +4439,8 @@ var peft = (model) => {
 from transformers import AutoModelFor${pefttask}
 
 config = PeftConfig.from_pretrained("${model.id}")
-model = AutoModelFor${pefttask}.from_pretrained("${peftBaseModel}")
-model = PeftModel.from_pretrained(model, "${model.id}")`
+base_model = AutoModelFor${pefttask}.from_pretrained("${peftBaseModel}")
+model = PeftModel.from_pretrained(base_model, "${model.id}")`
   ];
 };
 var fasttext = (model) => [
@@ -4494,7 +4497,7 @@ model = create_model(${model.id})`
 ];
 var nemo = (model) => {
   let command = void 0;
-  if (model.tags?.includes("automatic-speech-recognition")) {
+  if (model.tags.includes("automatic-speech-recognition")) {
     command = nemoDomainResolver("ASR", model);
   }
   return command ?? [`# tag did not correspond to a valid NeMo domain.`];
@@ -4529,11 +4532,11 @@ descriptions = ['dog barking', 'sirene of an emergency vehicle', 'footsteps in a
 wav = model.generate(descriptions)  # generates 3 samples.`
 ];
 var audiocraft = (model) => {
-  if (model.tags?.includes("musicgen")) {
+  if (model.tags.includes("musicgen")) {
     return musicgen(model);
-  } else if (model.tags?.includes("audiogen")) {
+  } else if (model.tags.includes("audiogen")) {
     return audiogen(model);
-  } else if (model.tags?.includes("magnet")) {
+  } else if (model.tags.includes("magnet")) {
     return magnet(model);
   } else {
     return [`# Type of model unknown.`];
@@ -4600,6 +4603,15 @@ var MODEL_LIBRARIES_UI_ELEMENTS = {
     repoName: "doctr",
     repoUrl: "https://github.com/mindee/doctr"
   },
+  elm: {
+    prettyLabel: "ELM",
+    repoName: "elm",
+    repoUrl: "https://github.com/slicex-ai/elm",
+    filter: false,
+    countDownloads: {
+      wildcard: { path: "*/slicex_elm_config.json" }
+    }
+  },
   espnet: {
     prettyLabel: "ESPnet",
     repoName: "ESPnet",
@@ -5386,11 +5398,71 @@ function getJsInferenceSnippet(model, accessToken) {
 function hasJsInferenceSnippet(model) {
   return !!model.pipeline_tag && model.pipeline_tag in jsSnippets;
 }
+
+// src/local-apps.ts
+function isGgufModel(model) {
+  return model.tags.includes("gguf");
+}
+var snippetLlamacpp = (model) => {
+  return `./main 	--hf-repo ${model.id} 	-m file.gguf 	-p "I believe the meaning of life is " -n 128`;
+};
+var LOCAL_APPS = {
+  "llama.cpp": {
+    prettyLabel: "llama.cpp",
+    docsUrl: "https://github.com/ggerganov/llama.cpp",
+    mainTask: "text-generation",
+    displayOnModelPage: isGgufModel,
+    snippet: snippetLlamacpp
+  },
+  lmstudio: {
+    prettyLabel: "LM Studio",
+    docsUrl: "https://lmstudio.ai",
+    mainTask: "text-generation",
+    displayOnModelPage: isGgufModel,
+    deeplink: (model) => new URL(`lmstudio://open_from_hf?model=${model.id}`)
+  },
+  jan: {
+    prettyLabel: "Jan",
+    docsUrl: "https://jan.ai",
+    mainTask: "text-generation",
+    displayOnModelPage: isGgufModel,
+    deeplink: (model) => new URL(`jan://open_from_hf?model=${model.id}`)
+  },
+  faraday: {
+    prettyLabel: "Faraday",
+    docsUrl: "https://faraday.dev",
+    mainTask: "text-generation",
+    macOSOnly: true,
+    displayOnModelPage: isGgufModel,
+    deeplink: (model) => new URL(`faraday://open_from_hf?model=${model.id}`)
+  },
+  drawthings: {
+    prettyLabel: "Draw Things",
+    docsUrl: "https://drawthings.ai",
+    mainTask: "text-to-image",
+    macOSOnly: true,
+    /**
+     * random function, will need to refine the actual conditions:
+     */
+    displayOnModelPage: (model) => model.tags.includes("textual_inversion"),
+    deeplink: (model) => new URL(`drawthings://open_from_hf?model=${model.id}`)
+  },
+  diffusionbee: {
+    prettyLabel: "DiffusionBee",
+    docsUrl: "https://diffusionbee.com",
+    mainTask: "text-to-image",
+    macOSOnly: true,
+    comingSoon: true,
+    displayOnModelPage: (model) => model.library_name === "diffusers" && model.pipeline_tag === "text-to-image",
+    deeplink: (model) => new URL(`diffusionbee://open_from_hf?model=${model.id}`)
+  }
+};
 export {
   ALL_DISPLAY_MODEL_LIBRARY_KEYS,
   ALL_MODEL_LIBRARY_KEYS,
   InferenceDisplayability,
   LIBRARY_TASK_MAPPING,
+  LOCAL_APPS,
   MAPPING_DEFAULT_WIDGET,
   MODALITIES,
   MODALITY_LABELS,

package/dist/scripts/inference-codegen.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=inference-codegen.d.ts.map

package/dist/scripts/inference-codegen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inference-codegen.d.ts","sourceRoot":"","sources":["../../scripts/inference-codegen.ts"],"names":[],"mappings":""}

package/dist/scripts/inference-tgi-import.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=inference-tgi-import.d.ts.map

package/dist/scripts/inference-tgi-import.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inference-tgi-import.d.ts","sourceRoot":"","sources":["../../scripts/inference-tgi-import.ts"],"names":[],"mappings":""}

package/dist/src/default-widget-inputs.d.ts

@@ -0,0 +1,6 @@
+import type { WidgetExample } from "./widget-example";
+import type { WidgetType } from "./pipelines";
+type PerLanguageMapping = Map<WidgetType, string[] | WidgetExample[]>;
+export declare const MAPPING_DEFAULT_WIDGET: Map<string, PerLanguageMapping>;
+export {};
+//# sourceMappingURL=default-widget-inputs.d.ts.map

package/dist/src/default-widget-inputs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-widget-inputs.d.ts","sourceRoot":"","sources":["../../src/default-widget-inputs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAI9C,KAAK,kBAAkB,GAAG,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,aAAa,EAAE,CAAC,CAAC;AAyrBtE,eAAO,MAAM,sBAAsB,iCAejC,CAAC"}

package/dist/src/index.d.ts

@@ -0,0 +1,17 @@
+export { LIBRARY_TASK_MAPPING } from "./library-to-tasks";
+export { MAPPING_DEFAULT_WIDGET } from "./default-widget-inputs";
+export type { TaskData, TaskDemo, TaskDemoEntry, ExampleRepo } from "./tasks";
+export * from "./tasks";
+export { PIPELINE_DATA, PIPELINE_TYPES, type WidgetType, type PipelineType, type PipelineData, type Modality, MODALITIES, MODALITY_LABELS, SUBTASK_TYPES, PIPELINE_TYPES_SET, } from "./pipelines";
+export { ALL_DISPLAY_MODEL_LIBRARY_KEYS, ALL_MODEL_LIBRARY_KEYS, MODEL_LIBRARIES_UI_ELEMENTS } from "./model-libraries";
+export type { LibraryUiElement, ModelLibraryKey } from "./model-libraries";
+export type { ModelData, TransformersInfo } from "./model-data";
+export type { AddedToken, SpecialTokensMap, TokenizerConfig } from "./tokenizer-data";
+export type { ChatMessage, WidgetExample, WidgetExampleAttribute, WidgetExampleAssetAndPromptInput, WidgetExampleAssetAndTextInput, WidgetExampleAssetAndZeroShotInput, WidgetExampleAssetInput, WidgetExampleChatInput, WidgetExampleSentenceSimilarityInput, WidgetExampleStructuredDataInput, WidgetExampleTableDataInput, WidgetExampleTextAndContextInput, WidgetExampleTextAndTableInput, WidgetExampleTextInput, WidgetExampleZeroShotTextInput, WidgetExampleOutput, WidgetExampleOutputUrl, WidgetExampleOutputLabels, WidgetExampleOutputAnswerScore, WidgetExampleOutputText, } from "./widget-example";
+export { InferenceDisplayability } from "./model-data";
+export { SPECIAL_TOKENS_ATTRIBUTES } from "./tokenizer-data";
+import * as snippets from "./snippets";
+export { snippets };
+export { LOCAL_APPS } from "./local-apps";
+export type { LocalApp, LocalAppKey } from "./local-apps";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/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,WAAW,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,uBAAuB,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAE7D,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,CAAC;AAEpB,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,YAAY,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC"}

package/dist/src/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/src/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,CAgEjF,CAAC"}

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

@@ -0,0 +1,104 @@
+import type { ModelData } from "./model-data";
+import type { PipelineType } from "./pipelines";
+/**
+ * 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) => URL;
+} | {
+    /**
+     * And if not (mostly llama.cpp), snippet to copy/paste in your terminal
+     */
+    snippet: (model: ModelData) => string;
+});
+declare function isGgufModel(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 isGgufModel;
+        snippet: (model: ModelData) => string;
+    };
+    lmstudio: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: typeof isGgufModel;
+        deeplink: (model: ModelData) => URL;
+    };
+    jan: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        displayOnModelPage: typeof isGgufModel;
+        deeplink: (model: ModelData) => URL;
+    };
+    faraday: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-generation";
+        macOSOnly: true;
+        displayOnModelPage: typeof isGgufModel;
+        deeplink: (model: ModelData) => URL;
+    };
+    drawthings: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-to-image";
+        macOSOnly: true;
+        /**
+         * random function, will need to refine the actual conditions:
+         */
+        displayOnModelPage: (model: ModelData) => boolean;
+        deeplink: (model: ModelData) => URL;
+    };
+    diffusionbee: {
+        prettyLabel: string;
+        docsUrl: string;
+        mainTask: "text-to-image";
+        macOSOnly: true;
+        comingSoon: true;
+        displayOnModelPage: (model: ModelData) => boolean;
+        deeplink: (model: ModelData) => URL;
+    };
+};
+export type LocalAppKey = keyof typeof LOCAL_APPS;
+export {};
+//# sourceMappingURL=local-apps.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"local-apps.d.ts","sourceRoot":"","sources":["../../src/local-apps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEhD;;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,KAAK,GAAG,CAAC;CACnC,GACD;IACA;;OAEG;IACH,OAAO,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,MAAM,CAAC;CACrC,CACH,CAAC;AAEF,iBAAS,WAAW,CAAC,KAAK,EAAE,SAAS,WAEpC;AASD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU;;;;;;yBAlBS,SAAS,KAAG,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAqDhD;;WAEG;;;;;;;;;;;;;CAa+B,CAAC;AAErC,MAAM,MAAM,WAAW,GAAG,MAAM,OAAO,UAAU,CAAC"}