@huggingface/tasks 0.0.3 → 0.0.5

package/src/image-segmentation/data.ts

@@ -4,93 +4,96 @@ const taskData: TaskDataCustom = {
 	datasets: [
 		{
 			description: "Scene segmentation dataset.",
-			id:          "scene_parse_150",
+			id: "scene_parse_150",
 		},
 	],
 	demo: {
 		inputs: [
 			{
 				filename: "image-segmentation-input.jpeg",
-				type:     "img",
+				type: "img",
 			},
 		],
 		outputs: [
 			{
 				filename: "image-segmentation-output.png",
-				type:     "img",
+				type: "img",
 			},
 		],
 	},
 	metrics: [
 		{
-			description: "Average Precision (AP) is the Area Under the PR Curve (AUC-PR). It is calculated for each semantic class separately",
-			id:          "Average Precision",
+			description:
+				"Average Precision (AP) is the Area Under the PR Curve (AUC-PR). It is calculated for each semantic class separately",
+			id: "Average Precision",
 		},
 		{
 			description: "Mean Average Precision (mAP) is the overall average of the AP values",
-			id:          "Mean Average Precision",
+			id: "Mean Average Precision",
 		},
 		{
-			description: "Intersection over Union (IoU) is the overlap of segmentation masks. Mean IoU is the average of the IoU of all semantic classes",
-			id:          "Mean Intersection over Union",
+			description:
+				"Intersection over Union (IoU) is the overlap of segmentation masks. Mean IoU is the average of the IoU of all semantic classes",
+			id: "Mean Intersection over Union",
 		},
 		{
 			description: "APα is the Average Precision at the IoU threshold of a α value, for example, AP50 and AP75",
-			id:          "APα",
+			id: "APα",
 		},
 	],
 	models: [
 		{
 			// TO DO: write description
 			description: "Solid panoptic segmentation model trained on the COCO 2017 benchmark dataset.",
-			id:          "facebook/detr-resnet-50-panoptic",
+			id: "facebook/detr-resnet-50-panoptic",
 		},
 		{
 			description: "Semantic segmentation model trained on ADE20k benchmark dataset.",
-			id:          "microsoft/beit-large-finetuned-ade-640-640",
+			id: "microsoft/beit-large-finetuned-ade-640-640",
 		},
 		{
 			description: "Semantic segmentation model trained on ADE20k benchmark dataset with 512x512 resolution.",
-			id:          "nvidia/segformer-b0-finetuned-ade-512-512",
+			id: "nvidia/segformer-b0-finetuned-ade-512-512",
 		},
 		{
 			description: "Semantic segmentation model trained Cityscapes dataset.",
-			id:          "facebook/mask2former-swin-large-cityscapes-semantic",
+			id: "facebook/mask2former-swin-large-cityscapes-semantic",
 		},
 		{
 			description: "Panoptic segmentation model trained COCO (common objects) dataset.",
-			id:          "facebook/mask2former-swin-large-coco-panoptic",
+			id: "facebook/mask2former-swin-large-coco-panoptic",
 		},
 	],
-	spaces:       [
+	spaces: [
 		{
 			description: "A semantic segmentation application that can predict unseen instances out of the box.",
-			id:          "facebook/ov-seg",
+			id: "facebook/ov-seg",
 		},
 		{
 			description: "One of the strongest segmentation applications.",
-			id:          "jbrinkma/segment-anything",
+			id: "jbrinkma/segment-anything",
 		},
 		{
 			description: "A semantic segmentation application that predicts human silhouettes.",
-			id:          "keras-io/Human-Part-Segmentation",
+			id: "keras-io/Human-Part-Segmentation",
 		},
 		{
 			description: "An instance segmentation application to predict neuronal cell types from microscopy images.",
-			id:          "rashmi/sartorius-cell-instance-segmentation",
+			id: "rashmi/sartorius-cell-instance-segmentation",
 		},
 		{
 			description: "An application that segments videos.",
-			id:          "ArtGAN/Segment-Anything-Video",
+			id: "ArtGAN/Segment-Anything-Video",
 		},
 		{
 			description: "An panoptic segmentation application built for outdoor environments.",
-			id:          "segments/panoptic-segment-anything",
+			id: "segments/panoptic-segment-anything",
 		},
 	],
-	summary:      "Image Segmentation divides an image into segments where each pixel in the image is mapped to an object. This task has multiple variants such as instance segmentation, panoptic segmentation and semantic segmentation.",
+	summary:
+		"Image Segmentation divides an image into segments where each pixel in the image is mapped to an object. This task has multiple variants such as instance segmentation, panoptic segmentation and semantic segmentation.",
 	widgetModels: ["facebook/detr-resnet-50-panoptic"],
-	youtubeId:    "dKE8SIt9C-w",
+	youtubeId: "dKE8SIt9C-w",
 };
 
 export default taskData;

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

@@ -45,36 +45,34 @@ import { HfInference } from "@huggingface/inference";
 
 const inference = new HfInference(HF_ACCESS_TOKEN);
 await inference.imageToImage({
-  data: await (await fetch('image')).blob(),
-  model: "timbrooks/instruct-pix2pix", 
-  parameters: {
-    prompt: "Deblur this image"
-  }
-})
+	data: await (await fetch("image")).blob(),
+	model: "timbrooks/instruct-pix2pix",
+	parameters: {
+		prompt: "Deblur this image",
+	},
+});
 ```
 
 ## ControlNet
 
 Controlling outputs of diffusion models only with a text prompt is a challenging problem. ControlNet is a neural network type that provides an image based control to diffusion models. These controls can be edges or landmarks in an image.
 
-Many ControlNet models were trained in our community event, JAX Diffusers sprint. You can see the full list of the ControlNet models available [here](https://huggingface.co/spaces/jax-diffusers-event/leaderboard). 
+Many ControlNet models were trained in our community event, JAX Diffusers sprint. You can see the full list of the ControlNet models available [here](https://huggingface.co/spaces/jax-diffusers-event/leaderboard).
 
 ## Most Used Model for the Task
 
 Pix2Pix is a popular model used for image to image translation tasks. It is based on a conditional-GAN (generative adversarial network) where instead of a noise vector a 2D image is given as input. More information about Pix2Pix can be retrieved from this [link](https://phillipi.github.io/pix2pix/) where the associated paper and the GitHub repository can be found.
 
-
 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)
 
-## References 
+## References
 
 [1] P. Isola, J. -Y. Zhu, T. Zhou and A. A. Efros, "Image-to-Image Translation with Conditional Adversarial Networks," 2017 IEEE Conference on Computer Vision and Pattern Recognition (CVPR), 2017, pp. 5967-5976, doi: 10.1109/CVPR.2017.632.
 

package/src/image-to-image/data.ts

@@ -4,94 +4,98 @@ const taskData: TaskDataCustom = {
 	datasets: [
 		{
 			description: "Synthetic dataset, for image relighting",
-			id:          "VIDIT",
+			id: "VIDIT",
 		},
 		{
 			description: "Multiple images of celebrities, used for facial expression translation",
-			id:          "huggan/CelebA-faces",
+			id: "huggan/CelebA-faces",
 		},
 	],
 	demo: {
 		inputs: [
 			{
 				filename: "image-to-image-input.jpeg",
-				type:     "img",
+				type: "img",
 			},
 		],
 		outputs: [
 			{
 				filename: "image-to-image-output.png",
-				type:     "img",
+				type: "img",
 			},
 		],
 	},
 	isPlaceholder: false,
-	metrics:       [
+	metrics: [
 		{
-			description: "Peak Signal to Noise Ratio (PSNR) is an approximation of the human perception, considering the ratio of the absolute intensity with respect to the variations. Measured in dB, a high value indicates a high fidelity.",
-			id:          "PSNR",
+			description:
+				"Peak Signal to Noise Ratio (PSNR) is an approximation of the human perception, considering the ratio of the absolute intensity with respect to the variations. Measured in dB, a high value indicates a high fidelity.",
+			id: "PSNR",
 		},
 		{
-			description: "Structural Similarity Index (SSIM) is a perceptual metric which compares the luminance, contrast and structure of two images. The values of SSIM range between -1 and 1, and higher values indicate closer resemblance to the original image.",
-			id:          "SSIM",
+			description:
+				"Structural Similarity Index (SSIM) is a perceptual metric which compares the luminance, contrast and structure of two images. The values of SSIM range between -1 and 1, and higher values indicate closer resemblance to the original image.",
+			id: "SSIM",
 		},
 		{
-			description: "Inception Score (IS) is an analysis of the labels predicted by an image classification model when presented with a sample of the generated images.",
-			id:          "IS",
+			description:
+				"Inception Score (IS) is an analysis of the labels predicted by an image classification model when presented with a sample of the generated images.",
+			id: "IS",
 		},
 	],
 	models: [
 		{
 			description: "A model that enhances images captured in low light conditions.",
-			id:          "keras-io/low-light-image-enhancement",
+			id: "keras-io/low-light-image-enhancement",
 		},
 		{
 			description: "A model that increases the resolution of an image.",
-			id:          "keras-io/super-resolution",
+			id: "keras-io/super-resolution",
 		},
 		{
-			description: "A model that creates a set of variations of the input image in the style of DALL-E using Stable Diffusion.",
-			id:          "lambdalabs/sd-image-variations-diffusers",
+			description:
+				"A model that creates a set of variations of the input image in the style of DALL-E using Stable Diffusion.",
+			id: "lambdalabs/sd-image-variations-diffusers",
 		},
 		{
 			description: "A model that generates images based on segments in the input image and the text prompt.",
-			id:          "mfidabel/controlnet-segment-anything",
+			id: "mfidabel/controlnet-segment-anything",
 		},
 		{
 			description: "A model that takes an image and an instruction to edit the image.",
-			id:          "timbrooks/instruct-pix2pix",
+			id: "timbrooks/instruct-pix2pix",
 		},
 	],
-	spaces:       [
+	spaces: [
 		{
 			description: "Image enhancer application for low light.",
-			id:          "keras-io/low-light-image-enhancement",
+			id: "keras-io/low-light-image-enhancement",
 		},
 		{
 			description: "Style transfer application.",
-			id:          "keras-io/neural-style-transfer",
+			id: "keras-io/neural-style-transfer",
 		},
 		{
 			description: "An application that generates images based on segment control.",
-			id:          "mfidabel/controlnet-segment-anything",
+			id: "mfidabel/controlnet-segment-anything",
 		},
 		{
 			description: "Image generation application that takes image control and text prompt.",
-			id:          "hysts/ControlNet",
+			id: "hysts/ControlNet",
 		},
 		{
 			description: "Colorize any image using this app.",
-			id:          "ioclab/brightness-controlnet",
+			id: "ioclab/brightness-controlnet",
 		},
 		{
 			description: "Edit images with instructions.",
-			id:          "timbrooks/instruct-pix2pix",
+			id: "timbrooks/instruct-pix2pix",
 		},
-
 	],
-	summary:      "Image-to-image is the task of transforming a source image to match the characteristics of a target image or a target image domain. Any image manipulation and enhancement is possible with image to image models.",
+	summary:
+		"Image-to-image is the task of transforming a source image to match the characteristics of a target image or a target image domain. Any image manipulation and enhancement is possible with image to image models.",
 	widgetModels: ["lllyasviel/sd-controlnet-canny"],
-	youtubeId:    "",
+	youtubeId: "",
 };
 
 export default taskData;

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

@@ -1,20 +1,24 @@
 ## Use Cases
+
 ### Image Captioning
-Image Captioning is the process of generating textual description of an image. 
+
+Image Captioning is the process of generating textual description of an image.
 This can help the visually impaired people to understand what's happening in their surroundings.
 
 ### Optical Character Recognition (OCR)
-OCR models convert the text present in an image, e.g. a scanned document, to text.
-
 
+OCR models convert the text present in an image, e.g. a scanned document, to text.
 
 ## Pix2Struct
 
 Pix2Struct is a state-of-the-art model built and released by Google AI. The model itself has to be trained on a downstream task to be used. These tasks include, captioning UI components, images including text, visual questioning infographics, charts, scientific diagrams and more. You can find these models on recommended models of this page.
 
 ## Inference
+
 ### Image Captioning
+
 You can use the 🤗 Transformers library's `image-to-text` pipeline to generate caption for the Image input.
+
 ```python
 from transformers import pipeline
 
@@ -24,7 +28,9 @@ captioner("https://huggingface.co/datasets/Narsil/image_dummy/resolve/main/parro
 ```
 
 ### OCR
+
 This code snippet uses Microsoft’s TrOCR, an encoder-decoder model consisting of an image Transformer encoder and a text Transformer decoder for state-of-the-art optical character recognition (OCR) on single-text line images.
+
 ```python
 from transformers import TrOCRProcessor, VisionEncoderDecoderModel
 
@@ -44,12 +50,13 @@ import { HfInference } from "@huggingface/inference";
 
 const inference = new HfInference(HF_ACCESS_TOKEN);
 await inference.imageToText({
-  data: await (await fetch('https://picsum.photos/300/300')).blob(),
-  model: 'Salesforce/blip-image-captioning-base',  
-})
+	data: await (await fetch("https://picsum.photos/300/300")).blob(),
+	model: "Salesforce/blip-image-captioning-base",
+});
 ```
 
 ## Useful Resources
+
 - [Image Captioning](https://huggingface.co/docs/transformers/main/en/tasks/image_captioning)
 - [Image captioning use case](https://blog.google/outreach-initiatives/accessibility/get-image-descriptions/)
 - [Train Image Captioning model on your dataset](https://github.com/NielsRogge/Transformers-Tutorials/blob/master/GIT/Fine_tune_GIT_on_an_image_captioning_dataset.ipynb)

package/src/image-to-text/data.ts

@@ -5,27 +5,26 @@ const taskData: TaskDataCustom = {
 		{
 			// TODO write proper description
 			description: "Dataset from 12M image-text of Reddit",
-			id:          "red_caps",
+			id: "red_caps",
 		},
 		{
 			// TODO write proper description
 			description: "Dataset from 3.3M images of Google",
-			id:          "datasets/conceptual_captions",
+			id: "datasets/conceptual_captions",
 		},
-
 	],
 	demo: {
 		inputs: [
 			{
 				filename: "savanna.jpg",
-				type:     "img",
+				type: "img",
 			},
 		],
 		outputs: [
 			{
-				label:   "Detailed description",
+				label: "Detailed description",
 				content: "a herd of giraffes and zebras grazing in a field",
-				type:    "text",
+				type: "text",
 			},
 		],
 	},
@@ -33,55 +32,55 @@ const taskData: TaskDataCustom = {
 	models: [
 		{
 			description: "A robust image captioning model.",
-			id:          "Salesforce/blip-image-captioning-large",
+			id: "Salesforce/blip-image-captioning-large",
 		},
 		{
 			description: "A strong image captioning model.",
-			id:          "nlpconnect/vit-gpt2-image-captioning",
+			id: "nlpconnect/vit-gpt2-image-captioning",
 		},
 		{
 			description: "A strong optical character recognition model.",
-			id:          "microsoft/trocr-base-printed",
+			id: "microsoft/trocr-base-printed",
 		},
 		{
 			description: "A strong visual question answering model for scientific diagrams.",
-			id:          "google/pix2struct-ai2d-base",
+			id: "google/pix2struct-ai2d-base",
 		},
 		{
 			description: "A strong captioning model for UI components.",
-			id:          "google/pix2struct-widget-captioning-base",
+			id: "google/pix2struct-widget-captioning-base",
 		},
 		{
 			description: "A captioning model for images that contain text.",
-			id:          "google/pix2struct-textcaps-base",
+			id: "google/pix2struct-textcaps-base",
 		},
 	],
-	spaces:       [
+	spaces: [
 		{
 			description: "A robust image captioning application.",
-			id:          "flax-community/image-captioning",
+			id: "flax-community/image-captioning",
 		},
 		{
 			description: "An application that transcribes handwritings into text.",
-			id:          "nielsr/TrOCR-handwritten",
+			id: "nielsr/TrOCR-handwritten",
 		},
 		{
 			description: "An application that can caption images and answer questions about a given image.",
-			id:          "Salesforce/BLIP",
+			id: "Salesforce/BLIP",
 		},
 		{
 			description: "An application that can caption images and answer questions with a conversational agent.",
-			id:          "Salesforce/BLIP2",
+			id: "Salesforce/BLIP2",
 		},
 		{
 			description: "An image captioning application that demonstrates the effect of noise on captions.",
-			id:          "johko/capdec-image-captioning",
+			id: "johko/capdec-image-captioning",
 		},
 	],
-	summary:      "Image to text models output a text from a given image. Image captioning or optical character recognition can be considered as the most common applications of image to text.",
+	summary:
+		"Image to text models output a text from a given image. Image captioning or optical character recognition can be considered as the most common applications of image to text.",
 	widgetModels: ["Salesforce/blip-image-captioning-base"],
-	youtubeId:    "",
+	youtubeId: "",
 };
 
-
 export default taskData;

package/src/index.ts

@@ -1,2 +1,13 @@
 export type { TaskData, TaskDemo, TaskDemoEntry, ExampleRepo } from "./Types";
 export { TASKS_DATA } from "./tasksData";
+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/modelLibraries.ts

@@ -0,0 +1,43 @@
+/**
+ * Add your new library here.
+ *
+ * This is for modeling (= architectures) libraries, not for file formats (like ONNX, etc).
+ * File formats live in an enum inside the internal codebase.
+ */
+export enum ModelLibrary {
+	"adapter-transformers" = "Adapter Transformers",
+	"allennlp" = "allenNLP",
+	"asteroid" = "Asteroid",
+	"bertopic" = "BERTopic",
+	"diffusers" = "Diffusers",
+	"doctr" = "docTR",
+	"espnet" = "ESPnet",
+	"fairseq" = "Fairseq",
+	"flair" = "Flair",
+	"keras" = "Keras",
+	"k2" = "K2",
+	"nemo" = "NeMo",
+	"open_clip" = "OpenCLIP",
+	"paddlenlp" = "PaddleNLP",
+	"peft" = "PEFT",
+	"pyannote-audio" = "pyannote.audio",
+	"sample-factory" = "Sample Factory",
+	"sentence-transformers" = "Sentence Transformers",
+	"sklearn" = "Scikit-learn",
+	"spacy" = "spaCy",
+	"span-marker" = "SpanMarker",
+	"speechbrain" = "speechbrain",
+	"tensorflowtts" = "TensorFlowTTS",
+	"timm" = "Timm",
+	"fastai" = "fastai",
+	"transformers" = "Transformers",
+	"transformers.js" = "Transformers.js",
+	"stanza" = "Stanza",
+	"fasttext" = "fastText",
+	"stable-baselines3" = "Stable-Baselines3",
+	"ml-agents" = "ML-Agents",
+	"pythae" = "Pythae",
+	"mindspore" = "MindSpore",
+}
+
+export type ModelLibraryKey = keyof typeof ModelLibrary;

package/src/object-detection/about.md

@@ -32,5 +32,6 @@ model("path_to_cat_image")
 ```
 
 # Useful Resources
+
 - [Walkthrough of Computer Vision Ecosystem in Hugging Face - CV Study Group](https://www.youtube.com/watch?v=oL-xmufhZM8)
-- [Object detection task guide](https://huggingface.co/docs/transformers/tasks/object_detection)
+- [Object detection task guide](https://huggingface.co/docs/transformers/tasks/object_detection)

package/src/object-detection/data.ts

@@ -5,69 +5,72 @@ const taskData: TaskDataCustom = {
 		{
 			// TODO write proper description
 			description: "Widely used benchmark dataset for multiple Vision tasks.",
-			id:          "merve/coco2017",
+			id: "merve/coco2017",
 		},
 	],
 	demo: {
 		inputs: [
 			{
 				filename: "object-detection-input.jpg",
-				type:     "img",
+				type: "img",
 			},
 		],
 		outputs: [
 			{
 				filename: "object-detection-output.jpg",
-				type:     "img",
+				type: "img",
 			},
 		],
 	},
 	metrics: [
 		{
-			description: "The Average Precision (AP) metric is the Area Under the PR Curve (AUC-PR). It is calculated for each class separately",
-			id:          "Average Precision",
+			description:
+				"The Average Precision (AP) metric is the Area Under the PR Curve (AUC-PR). It is calculated for each class separately",
+			id: "Average Precision",
 		},
 		{
 			description: "The Mean Average Precision (mAP) metric is the overall average of the AP values",
-			id:          "Mean Average Precision",
+			id: "Mean Average Precision",
 		},
 		{
-			description: "The APα metric is the Average Precision at the IoU threshold of a α value, for example, AP50 and AP75",
-			id:          "APα",
+			description:
+				"The APα metric is the Average Precision at the IoU threshold of a α value, for example, AP50 and AP75",
+			id: "APα",
 		},
 	],
 	models: [
 		{
 			// TO DO: write description
 			description: "Solid object detection model trained on the benchmark dataset COCO 2017.",
-			id:          "facebook/detr-resnet-50",
+			id: "facebook/detr-resnet-50",
 		},
 		{
 			description: "Strong object detection model trained on ImageNet-21k dataset.",
-			id:          "microsoft/beit-base-patch16-224-pt22k-ft22k",
+			id: "microsoft/beit-base-patch16-224-pt22k-ft22k",
 		},
 	],
-	spaces:       [
+	spaces: [
 		{
 			description: "An object detection application that can detect unseen objects out of the box.",
-			id:          "adirik/OWL-ViT",
+			id: "adirik/OWL-ViT",
 		},
 		{
 			description: "An application that contains various object detection models to try from.",
-			id:          "Gradio-Blocks/Object-Detection-With-DETR-and-YOLOS",
+			id: "Gradio-Blocks/Object-Detection-With-DETR-and-YOLOS",
 		},
 		{
 			description: "An application that shows multiple cutting edge techniques for object detection and tracking.",
-			id:          "kadirnar/torchyolo",
+			id: "kadirnar/torchyolo",
 		},
 		{
 			description: "An object tracking, segmentation and inpainting application.",
-			id:          "VIPLab/Track-Anything",
+			id: "VIPLab/Track-Anything",
 		},
 	],
-	summary:      "Object Detection models allow users to identify objects of certain defined classes. Object detection models receive an image as input and output the images with bounding boxes and labels on detected objects.",
+	summary:
+		"Object Detection models allow users to identify objects of certain defined classes. Object detection models receive an image as input and output the images with bounding boxes and labels on detected objects.",
 	widgetModels: ["facebook/detr-resnet-50"],
-	youtubeId:    "WdAeKSOpxhw",
+	youtubeId: "WdAeKSOpxhw",
 };
 
 export default taskData;