@huggingface/tasks 0.0.4 → 0.0.6

package/dist/index.d.ts

@@ -40,9 +40,19 @@ declare enum ModelLibrary {
     "mindspore" = "MindSpore"
 }
 type ModelLibraryKey = keyof typeof ModelLibrary;
+declare const ALL_DISPLAY_MODEL_LIBRARY_KEYS: string[];
 
 declare const MODALITIES: readonly ["cv", "nlp", "audio", "tabular", "multimodal", "rl", "other"];
 type Modality = (typeof MODALITIES)[number];
+declare const MODALITY_LABELS: {
+    multimodal: string;
+    nlp: string;
+    audio: string;
+    cv: string;
+    rl: string;
+    tabular: string;
+    other: string;
+};
 /**
  * Public interface for a sub task.
  *
@@ -400,6 +410,9 @@ declare const PIPELINE_DATA: {
     };
 };
 type PipelineType = keyof typeof PIPELINE_DATA;
+declare const PIPELINE_TYPES: ("other" | "text-classification" | "token-classification" | "table-question-answering" | "question-answering" | "zero-shot-classification" | "translation" | "summarization" | "conversational" | "feature-extraction" | "text-generation" | "text2text-generation" | "fill-mask" | "sentence-similarity" | "text-to-speech" | "text-to-audio" | "automatic-speech-recognition" | "audio-to-audio" | "audio-classification" | "voice-activity-detection" | "depth-estimation" | "image-classification" | "object-detection" | "image-segmentation" | "text-to-image" | "image-to-text" | "image-to-image" | "unconditional-image-generation" | "video-classification" | "reinforcement-learning" | "robotics" | "tabular-classification" | "tabular-regression" | "tabular-to-text" | "table-to-text" | "multiple-choice" | "text-retrieval" | "time-series-forecasting" | "text-to-video" | "visual-question-answering" | "document-question-answering" | "zero-shot-image-classification" | "graph-ml")[];
+declare const SUBTASK_TYPES: string[];
+declare const PIPELINE_TYPES_SET: Set<"other" | "text-classification" | "token-classification" | "table-question-answering" | "question-answering" | "zero-shot-classification" | "translation" | "summarization" | "conversational" | "feature-extraction" | "text-generation" | "text2text-generation" | "fill-mask" | "sentence-similarity" | "text-to-speech" | "text-to-audio" | "automatic-speech-recognition" | "audio-to-audio" | "audio-classification" | "voice-activity-detection" | "depth-estimation" | "image-classification" | "object-detection" | "image-segmentation" | "text-to-image" | "image-to-text" | "image-to-image" | "unconditional-image-generation" | "video-classification" | "reinforcement-learning" | "robotics" | "tabular-classification" | "tabular-regression" | "tabular-to-text" | "table-to-text" | "multiple-choice" | "text-retrieval" | "time-series-forecasting" | "text-to-video" | "visual-question-answering" | "document-question-answering" | "zero-shot-image-classification" | "graph-ml">;
 
 interface ExampleRepo {
     description: string;
@@ -454,4 +467,9 @@ interface TaskData {
 
 declare const TASKS_DATA: Record<PipelineType, TaskData | undefined>;
 
-export { ExampleRepo, MODALITIES, Modality, ModelLibrary, PIPELINE_DATA, PipelineData, PipelineType, TASKS_DATA, TaskData, TaskDemo, TaskDemoEntry };
+declare const TAG_NFAA_CONTENT = "not-for-all-audiences";
+declare const OTHER_TAGS_SUGGESTIONS: string[];
+declare const TAG_TEXT_GENERATION_INFERENCE = "text-generation-inference";
+declare const TAG_CUSTOM_CODE = "custom_code";
+
+export { ALL_DISPLAY_MODEL_LIBRARY_KEYS, ExampleRepo, MODALITIES, MODALITY_LABELS, Modality, ModelLibrary, ModelLibraryKey, OTHER_TAGS_SUGGESTIONS, PIPELINE_DATA, PIPELINE_TYPES, PIPELINE_TYPES_SET, PipelineData, PipelineType, SUBTASK_TYPES, TAG_CUSTOM_CODE, TAG_NFAA_CONTENT, TAG_TEXT_GENERATION_INFERENCE, TASKS_DATA, TaskData, TaskDemo, TaskDemoEntry };

package/dist/index.js

@@ -20,15 +20,33 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  ALL_DISPLAY_MODEL_LIBRARY_KEYS: () => ALL_DISPLAY_MODEL_LIBRARY_KEYS,
   MODALITIES: () => MODALITIES,
+  MODALITY_LABELS: () => MODALITY_LABELS,
   ModelLibrary: () => ModelLibrary,
+  OTHER_TAGS_SUGGESTIONS: () => OTHER_TAGS_SUGGESTIONS,
   PIPELINE_DATA: () => PIPELINE_DATA,
+  PIPELINE_TYPES: () => PIPELINE_TYPES,
+  PIPELINE_TYPES_SET: () => PIPELINE_TYPES_SET,
+  SUBTASK_TYPES: () => SUBTASK_TYPES,
+  TAG_CUSTOM_CODE: () => TAG_CUSTOM_CODE,
+  TAG_NFAA_CONTENT: () => TAG_NFAA_CONTENT,
+  TAG_TEXT_GENERATION_INFERENCE: () => TAG_TEXT_GENERATION_INFERENCE,
   TASKS_DATA: () => TASKS_DATA
 });
 module.exports = __toCommonJS(src_exports);
 
 // src/pipelines.ts
 var MODALITIES = ["cv", "nlp", "audio", "tabular", "multimodal", "rl", "other"];
+var MODALITY_LABELS = {
+  multimodal: "Multimodal",
+  nlp: "Natural Language Processing",
+  audio: "Audio",
+  cv: "Computer Vision",
+  rl: "Reinforcement Learning",
+  tabular: "Tabular",
+  other: "Other"
+};
 var PIPELINE_DATA = {
   "text-classification": {
     name: "Text Classification",
@@ -574,6 +592,9 @@ var PIPELINE_DATA = {
     hideInDatasets: true
   }
 };
+var PIPELINE_TYPES = Object.keys(PIPELINE_DATA);
+var SUBTASK_TYPES = Object.values(PIPELINE_DATA).flatMap((data) => "subtasks" in data ? data.subtasks : []).map((s) => s.type);
+var PIPELINE_TYPES_SET = new Set(PIPELINE_TYPES);
 
 // src/audio-classification/data.ts
 var taskData = {
@@ -3132,10 +3153,39 @@ var ModelLibrary = /* @__PURE__ */ ((ModelLibrary2) => {
   ModelLibrary2["mindspore"] = "MindSpore";
   return ModelLibrary2;
 })(ModelLibrary || {});
+var ALL_DISPLAY_MODEL_LIBRARY_KEYS = Object.keys(ModelLibrary).filter(
+  (k) => !["doctr", "k2", "mindspore", "tensorflowtts"].includes(k)
+);
+
+// src/tags.ts
+var TAG_NFAA_CONTENT = "not-for-all-audiences";
+var OTHER_TAGS_SUGGESTIONS = [
+  "chemistry",
+  "biology",
+  "finance",
+  "legal",
+  "music",
+  "art",
+  "code",
+  "climate",
+  "medical",
+  TAG_NFAA_CONTENT
+];
+var TAG_TEXT_GENERATION_INFERENCE = "text-generation-inference";
+var TAG_CUSTOM_CODE = "custom_code";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ALL_DISPLAY_MODEL_LIBRARY_KEYS,
   MODALITIES,
+  MODALITY_LABELS,
   ModelLibrary,
+  OTHER_TAGS_SUGGESTIONS,
   PIPELINE_DATA,
+  PIPELINE_TYPES,
+  PIPELINE_TYPES_SET,
+  SUBTASK_TYPES,
+  TAG_CUSTOM_CODE,
+  TAG_NFAA_CONTENT,
+  TAG_TEXT_GENERATION_INFERENCE,
   TASKS_DATA
 });

package/dist/index.mjs

@@ -1,5 +1,14 @@
 // src/pipelines.ts
 var MODALITIES = ["cv", "nlp", "audio", "tabular", "multimodal", "rl", "other"];
+var MODALITY_LABELS = {
+  multimodal: "Multimodal",
+  nlp: "Natural Language Processing",
+  audio: "Audio",
+  cv: "Computer Vision",
+  rl: "Reinforcement Learning",
+  tabular: "Tabular",
+  other: "Other"
+};
 var PIPELINE_DATA = {
   "text-classification": {
     name: "Text Classification",
@@ -545,6 +554,9 @@ var PIPELINE_DATA = {
     hideInDatasets: true
   }
 };
+var PIPELINE_TYPES = Object.keys(PIPELINE_DATA);
+var SUBTASK_TYPES = Object.values(PIPELINE_DATA).flatMap((data) => "subtasks" in data ? data.subtasks : []).map((s) => s.type);
+var PIPELINE_TYPES_SET = new Set(PIPELINE_TYPES);
 
 // src/audio-classification/data.ts
 var taskData = {
@@ -3103,9 +3115,38 @@ var ModelLibrary = /* @__PURE__ */ ((ModelLibrary2) => {
   ModelLibrary2["mindspore"] = "MindSpore";
   return ModelLibrary2;
 })(ModelLibrary || {});
+var ALL_DISPLAY_MODEL_LIBRARY_KEYS = Object.keys(ModelLibrary).filter(
+  (k) => !["doctr", "k2", "mindspore", "tensorflowtts"].includes(k)
+);
+
+// src/tags.ts
+var TAG_NFAA_CONTENT = "not-for-all-audiences";
+var OTHER_TAGS_SUGGESTIONS = [
+  "chemistry",
+  "biology",
+  "finance",
+  "legal",
+  "music",
+  "art",
+  "code",
+  "climate",
+  "medical",
+  TAG_NFAA_CONTENT
+];
+var TAG_TEXT_GENERATION_INFERENCE = "text-generation-inference";
+var TAG_CUSTOM_CODE = "custom_code";
 export {
+  ALL_DISPLAY_MODEL_LIBRARY_KEYS,
   MODALITIES,
+  MODALITY_LABELS,
   ModelLibrary,
+  OTHER_TAGS_SUGGESTIONS,
   PIPELINE_DATA,
+  PIPELINE_TYPES,
+  PIPELINE_TYPES_SET,
+  SUBTASK_TYPES,
+  TAG_CUSTOM_CODE,
+  TAG_NFAA_CONTENT,
+  TAG_TEXT_GENERATION_INFERENCE,
   TASKS_DATA
 };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@huggingface/tasks",
-  "packageManager": "pnpm@8.3.1",
-  "version": "0.0.4",
-  "description": "List of ISO-639 languages used in the Hub",
+  "packageManager": "pnpm@8.10.5",
+  "version": "0.0.6",
+  "description": "List of ML tasks for huggingface.co/tasks",
   "repository": "https://github.com/huggingface/huggingface.js.git",
   "publishConfig": {
     "access": "public"
@@ -39,6 +39,6 @@
     "format": "prettier --write .",
     "format:check": "prettier --check .",
     "build": "tsup src/index.ts --format cjs,esm --clean --dts",
-    "type-check": "tsc"
+    "check": "tsc"
   }
 }

package/src/image-to-image/about.md

@@ -65,9 +65,9 @@ Pix2Pix is a popular model used for image to image translation tasks. It is base
 
 Below images show some of the examples shared in the paper that can be obtained using Pix2Pix. There are various cases this model can be applied on. It is capable of relatively simpler things, e.g. converting a grayscale image to its colored version. But more importantly, it can generate realistic pictures from rough sketches (can be seen in the purse example) or from painting-like images (can be seen in the street and facade examples below).
 
-<img src="/tasks/assets/image-to-image/pix2pix_examples.jpg" alt="Alt text" title="Optional title">
+![Examples](https://huggingface.co/datasets/huggingfacejs/tasks/resolve/main/image-to-image/pix2pix_examples.jpg)
 
-## Useful Resources
+## Useful Resources
 
 - [Train your ControlNet with diffusers 🧨](https://huggingface.co/blog/train-your-controlnet)
 - [Ultra fast ControlNet with 🧨 Diffusers](https://huggingface.co/blog/controlnet)

package/src/index.ts

@@ -1,4 +1,17 @@
 export type { TaskData, TaskDemo, TaskDemoEntry, ExampleRepo } from "./Types";
 export { TASKS_DATA } from "./tasksData";
-export { PIPELINE_DATA, type PipelineType, type PipelineData, type Modality, MODALITIES } from "./pipelines";
-export { ModelLibrary } from "./modelLibraries";
+export {
+	PIPELINE_DATA,
+	PIPELINE_TYPES,
+	type PipelineType,
+	type PipelineData,
+	type Modality,
+	MODALITIES,
+	MODALITY_LABELS,
+	SUBTASK_TYPES,
+	PIPELINE_TYPES_SET,
+} from "./pipelines";
+export { ModelLibrary, ALL_DISPLAY_MODEL_LIBRARY_KEYS } from "./modelLibraries";
+export type { ModelLibraryKey } from "./modelLibraries";
+
+export { TAG_NFAA_CONTENT, OTHER_TAGS_SUGGESTIONS, TAG_TEXT_GENERATION_INFERENCE, TAG_CUSTOM_CODE } from "./tags";

package/src/modelLibraries.ts

@@ -41,3 +41,7 @@ export enum ModelLibrary {
 }
 
 export type ModelLibraryKey = keyof typeof ModelLibrary;
+
+export const ALL_DISPLAY_MODEL_LIBRARY_KEYS = Object.keys(ModelLibrary).filter(
+	(k) => !["doctr", "k2", "mindspore", "tensorflowtts"].includes(k)
+);

package/src/pipelines.ts

@@ -2,6 +2,16 @@ export const MODALITIES = ["cv", "nlp", "audio", "tabular", "multimodal", "rl",
 
 export type Modality = (typeof MODALITIES)[number];
 
+export const MODALITY_LABELS = {
+	multimodal: "Multimodal",
+	nlp: "Natural Language Processing",
+	audio: "Audio",
+	cv: "Computer Vision",
+	rl: "Reinforcement Learning",
+	tabular: "Tabular",
+	other: "Other",
+} satisfies Record<Modality, string>;
+
 /**
  * Public interface for a sub task.
  *
@@ -606,3 +616,11 @@ export const PIPELINE_DATA = {
 } satisfies Record<string, PipelineData>;
 
 export type PipelineType = keyof typeof PIPELINE_DATA;
+
+export const PIPELINE_TYPES = Object.keys(PIPELINE_DATA) as PipelineType[];
+
+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/src/tags.ts

@@ -0,0 +1,15 @@
+export const TAG_NFAA_CONTENT = "not-for-all-audiences";
+export const OTHER_TAGS_SUGGESTIONS = [
+	"chemistry",
+	"biology",
+	"finance",
+	"legal",
+	"music",
+	"art",
+	"code",
+	"climate",
+	"medical",
+	TAG_NFAA_CONTENT,
+];
+export const TAG_TEXT_GENERATION_INFERENCE = "text-generation-inference";
+export const TAG_CUSTOM_CODE = "custom_code";