@huggingface/tasks 0.0.4 → 0.0.5

package/dist/index.d.ts

@@ -43,6 +43,15 @@ type ModelLibraryKey = keyof typeof ModelLibrary;
 
 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 +409,7 @@ 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")[];
 
 interface ExampleRepo {
     description: string;
@@ -454,4 +464,4 @@ interface TaskData {
 
 declare const TASKS_DATA: Record<PipelineType, TaskData | undefined>;
 
-export { ExampleRepo, MODALITIES, Modality, ModelLibrary, PIPELINE_DATA, PipelineData, PipelineType, TASKS_DATA, TaskData, TaskDemo, TaskDemoEntry };
+export { ExampleRepo, MODALITIES, MODALITY_LABELS, Modality, ModelLibrary, ModelLibraryKey, PIPELINE_DATA, PIPELINE_TYPES, PipelineData, PipelineType, TASKS_DATA, TaskData, TaskDemo, TaskDemoEntry };

package/dist/index.js

@@ -21,14 +21,25 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   MODALITIES: () => MODALITIES,
+  MODALITY_LABELS: () => MODALITY_LABELS,
   ModelLibrary: () => ModelLibrary,
   PIPELINE_DATA: () => PIPELINE_DATA,
+  PIPELINE_TYPES: () => PIPELINE_TYPES,
   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 +585,7 @@ var PIPELINE_DATA = {
     hideInDatasets: true
   }
 };
+var PIPELINE_TYPES = Object.keys(PIPELINE_DATA);
 
 // src/audio-classification/data.ts
 var taskData = {
@@ -3135,7 +3147,9 @@ var ModelLibrary = /* @__PURE__ */ ((ModelLibrary2) => {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   MODALITIES,
+  MODALITY_LABELS,
   ModelLibrary,
   PIPELINE_DATA,
+  PIPELINE_TYPES,
   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,7 @@ var PIPELINE_DATA = {
     hideInDatasets: true
   }
 };
+var PIPELINE_TYPES = Object.keys(PIPELINE_DATA);
 
 // src/audio-classification/data.ts
 var taskData = {
@@ -3105,7 +3115,9 @@ var ModelLibrary = /* @__PURE__ */ ((ModelLibrary2) => {
 })(ModelLibrary || {});
 export {
   MODALITIES,
+  MODALITY_LABELS,
   ModelLibrary,
   PIPELINE_DATA,
+  PIPELINE_TYPES,
   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.5",
+  "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,13 @@
 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 {
+	PIPELINE_DATA,
+	PIPELINE_TYPES,
+	type PipelineType,
+	type PipelineData,
+	type Modality,
+	MODALITIES,
+	MODALITY_LABELS,
+} from "./pipelines";
 export { ModelLibrary } from "./modelLibraries";
+export type { ModelLibraryKey } from "./modelLibraries";

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,4 @@ 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[];