@huggingface/tasks 0.0.2 → 0.0.4

package/src/document-question-answering/about.md

@@ -16,7 +16,6 @@ Another very popular use case is invoice information extraction. For example, yo
 You can infer with Document QA models with the 🤗 Transformers library using the [`document-question-answering` pipeline](https://huggingface.co/docs/transformers/en/main_classes/pipelines#transformers.DocumentQuestionAnsweringPipeline). If no model checkpoint is given, the pipeline will be initialized with [`impira/layoutlm-document-qa`](https://huggingface.co/impira/layoutlm-document-qa). This pipeline takes question(s) and document(s) as input, and returns the answer.  
 👉 Note that the question answering task solved here is extractive: the model extracts the answer from a context (the document).
 
-
 ```python
 from transformers import pipeline
 from PIL import Image
@@ -51,4 +50,4 @@ Would you like to learn more about Document QA? Awesome! Here are some curated r
 
 - [Document question answering task guide](https://huggingface.co/docs/transformers/tasks/document_question_answering)
 
-The contents of this page are contributed by [Eliott Zemour](https://huggingface.co/eliolio) and reviewed by [Kwadwo Agyapon-Ntra](https://huggingface.co/KayO) and [Ankur Goyal](https://huggingface.co/ankrgyl).
+The contents of this page are contributed by [Eliott Zemour](https://huggingface.co/eliolio) and reviewed by [Kwadwo Agyapon-Ntra](https://huggingface.co/KayO) and [Ankur Goyal](https://huggingface.co/ankrgyl).

package/src/document-question-answering/data.ts

@@ -4,64 +4,67 @@ const taskData: TaskDataCustom = {
 	datasets: [
 		{
 			// TODO write proper description
-			description: "Dataset from the 2020 DocVQA challenge. The documents are taken from the UCSF Industry Documents Library.",
-			id:          "eliolio/docvqa",
+			description:
+				"Dataset from the 2020 DocVQA challenge. The documents are taken from the UCSF Industry Documents Library.",
+			id: "eliolio/docvqa",
 		},
 	],
 	demo: {
 		inputs: [
 			{
-				label:   "Question",
+				label: "Question",
 				content: "What is the idea behind the consumer relations efficiency team?",
-				type:    "text",
+				type: "text",
 			},
 			{
 				filename: "document-question-answering-input.png",
-				type:     "img",
+				type: "img",
 			},
 		],
 		outputs: [
 			{
-				label:   "Answer",
+				label: "Answer",
 				content: "Balance cost efficiency with quality customer service",
-				type:    "text",
+				type: "text",
 			},
 		],
 	},
 	metrics: [
 		{
-			description: "The evaluation metric for the DocVQA challenge is the Average Normalized Levenshtein Similarity (ANLS). This metric is flexible to character regognition errors and compares the predicted answer with the ground truth answer.",
-			id:          "anls",
+			description:
+				"The evaluation metric for the DocVQA challenge is the Average Normalized Levenshtein Similarity (ANLS). This metric is flexible to character regognition errors and compares the predicted answer with the ground truth answer.",
+			id: "anls",
 		},
 		{
-			description: "Exact Match is a metric based on the strict character match of the predicted answer and the right answer. For answers predicted correctly, the Exact Match will be 1. Even if only one character is different, Exact Match will be 0",
-			id:          "exact-match",
+			description:
+				"Exact Match is a metric based on the strict character match of the predicted answer and the right answer. For answers predicted correctly, the Exact Match will be 1. Even if only one character is different, Exact Match will be 0",
+			id: "exact-match",
 		},
 	],
 	models: [
 		{
 			description: "A LayoutLM model for the document QA task, fine-tuned on DocVQA and SQuAD2.0.",
-			id:          "impira/layoutlm-document-qa",
+			id: "impira/layoutlm-document-qa",
 		},
 		{
 			description: "A special model for OCR-free Document QA task. Donut model fine-tuned on DocVQA.",
-			id:          "naver-clova-ix/donut-base-finetuned-docvqa",
+			id: "naver-clova-ix/donut-base-finetuned-docvqa",
 		},
 	],
-	spaces:       [
+	spaces: [
 		{
 			description: "A robust document question answering application.",
-			id:          "impira/docquery",
+			id: "impira/docquery",
 		},
 		{
 			description: "An application that can answer questions from invoices.",
-			id:          "impira/invoices",
+			id: "impira/invoices",
 		},
 	],
-	summary:      "Document Question Answering (also known as Document Visual Question Answering) is the task of answering questions on document images. Document question answering models take a (document, question) pair as input and return an answer in natural language. Models usually rely on multi-modal features, combining text, position of words (bounding-boxes) and image.",
+	summary:
+		"Document Question Answering (also known as Document Visual Question Answering) is the task of answering questions on document images. Document question answering models take a (document, question) pair as input and return an answer in natural language. Models usually rely on multi-modal features, combining text, position of words (bounding-boxes) and image.",
 	widgetModels: ["impira/layoutlm-document-qa"],
-	youtubeId:    "",
+	youtubeId: "",
 };
 
-
 export default taskData;

package/src/feature-extraction/about.md

@@ -4,6 +4,7 @@ Feature extraction is the task of building features intended to be informative f
 facilitating the subsequent learning and generalization steps in various domains of machine learning.
 
 ## Use Cases
+
 Feature extraction can be used to do transfer learning in natural language processing, computer vision and audio models.
 
 ## Inference
@@ -17,7 +18,7 @@ feature_extractor = pipeline("feature-extraction",framework="pt",model=checkpoin
 text = "Transformers is an awesome library!"
 
 #Reducing along the first dimension to get a 768 dimensional array
-feature_extractor(text,return_tensors = "pt")[0].numpy().mean(axis=0) 
+feature_extractor(text,return_tensors = "pt")[0].numpy().mean(axis=0)
 
 '''tensor([[[ 2.5834,  2.7571,  0.9024,  ...,  1.5036, -0.0435, -0.8603],
          [-1.2850, -1.0094, -2.0826,  ...,  1.5993, -0.9017,  0.6426],
@@ -31,5 +32,3 @@ feature_extractor(text,return_tensors = "pt")[0].numpy().mean(axis=0)
 ## Useful resources
 
 - [Documentation for feature extractor of 🤗Transformers](https://huggingface.co/docs/transformers/main_classes/feature_extractor)
-
-

package/src/feature-extraction/data.ts

@@ -3,29 +3,27 @@ import type { TaskDataCustom } from "../Types";
 const taskData: TaskDataCustom = {
 	datasets: [
 		{
-			description: "Wikipedia dataset containing cleaned articles of all languages. Can be used to train `feature-extraction` models.",
-			id:"wikipedia",
+			description:
+				"Wikipedia dataset containing cleaned articles of all languages. Can be used to train `feature-extraction` models.",
+			id: "wikipedia",
 		},
 	],
 	demo: {
 		inputs: [
 			{
-				label:   "Input",
-				content:
-						"India, officially the Republic of India, is a country in South Asia.",
+				label: "Input",
+				content: "India, officially the Republic of India, is a country in South Asia.",
 				type: "text",
 			},
-
 		],
 		outputs: [
-			{	
+			{
 				table: [
 					["Dimension 1", "Dimension 2", "Dimension 3"],
 					["2.583383083343506", "2.757075071334839", "0.9023529887199402"],
 					["8.29393482208252", "1.1071064472198486", "2.03399395942688"],
 					["-0.7754912972450256", "-1.647324562072754", "-0.6113331913948059"],
 					["0.07087723910808563", "1.5942802429199219", "1.4610432386398315"],
-				
 				],
 				type: "tabular",
 			},
@@ -34,23 +32,22 @@ const taskData: TaskDataCustom = {
 	metrics: [
 		{
 			description: "",
-			id:          "",
+			id: "",
 		},
 	],
 	models: [
 		{
 			description: "A powerful feature extraction model for natural language processing tasks.",
-			id:          "facebook/bart-base",
+			id: "facebook/bart-base",
 		},
 		{
 			description: "A strong feature extraction model for coding tasks.",
-			id:          "microsoft/codebert-base",
+			id: "microsoft/codebert-base",
 		},
 	],
-	spaces:       [
-
-	],
-	summary:      "Feature extraction refers to the process of transforming raw data into numerical features that can be processed while preserving the information in the original dataset.",
+	spaces: [],
+	summary:
+		"Feature extraction refers to the process of transforming raw data into numerical features that can be processed while preserving the information in the original dataset.",
 	widgetModels: ["facebook/bart-base"],
 };
 

package/src/fill-mask/about.md

@@ -48,4 +48,4 @@ Would you like to learn more about the topic? Awesome! Here you can find some cu
 
 ### Documentation
 
-- [Masked language modeling task guide](https://huggingface.co/docs/transformers/tasks/masked_language_modeling)
+- [Masked language modeling task guide](https://huggingface.co/docs/transformers/tasks/masked_language_modeling)

package/src/fill-mask/data.ts

@@ -4,21 +4,20 @@ const taskData: TaskDataCustom = {
 	datasets: [
 		{
 			description: "A common dataset that is used to train models for many languages.",
-			id:          "wikipedia",
+			id: "wikipedia",
 		},
 		{
 			description: "A large English dataset with text crawled from the web.",
-			id:          "c4",
+			id: "c4",
 		},
 	],
 	demo: {
 		inputs: [
 			{
-				label:   "Input",
+				label: "Input",
 				content: "The <mask> barked at me",
-				type:    "text",
+				type: "text",
 			},
-			
 		],
 		outputs: [
 			{
@@ -50,28 +49,31 @@ const taskData: TaskDataCustom = {
 	},
 	metrics: [
 		{
-			description: "Cross Entropy is a metric that calculates the difference between two probability distributions. Each probability distribution is the distribution of predicted words",
-			id:          "cross_entropy",
+			description:
+				"Cross Entropy is a metric that calculates the difference between two probability distributions. Each probability distribution is the distribution of predicted words",
+			id: "cross_entropy",
 		},
 		{
-			description: "Perplexity is the exponential of the cross-entropy loss. It evaluates the probabilities assigned to the next word by the model. Lower perplexity indicates better performance",
-			id:          "perplexity",
+			description:
+				"Perplexity is the exponential of the cross-entropy loss. It evaluates the probabilities assigned to the next word by the model. Lower perplexity indicates better performance",
+			id: "perplexity",
 		},
 	],
 	models: [
 		{
 			description: "A faster and smaller model than the famous BERT model.",
-			id:          "distilbert-base-uncased",
+			id: "distilbert-base-uncased",
 		},
 		{
 			description: "A multilingual model trained on 100 languages.",
-			id:          "xlm-roberta-base",
+			id: "xlm-roberta-base",
 		},
 	],
-	spaces:       [],
-	summary:      "Masked language modeling is the task of masking some of the words in a sentence and predicting which words should replace those masks. These models are useful when we want to get a statistical understanding of the language in which the model is trained in.",
+	spaces: [],
+	summary:
+		"Masked language modeling is the task of masking some of the words in a sentence and predicting which words should replace those masks. These models are useful when we want to get a statistical understanding of the language in which the model is trained in.",
 	widgetModels: ["distilroberta-base"],
-	youtubeId:    "mqElG5QJWUg",
+	youtubeId: "mqElG5QJWUg",
 };
 
 export default taskData;

package/src/image-classification/about.md

@@ -1,7 +1,9 @@
 ## Use Cases
+
 Image classification models can be used when we are not interested in specific instances of objects with location information or their shape.
 
 ### Keyword Classification
+
 Image classification models are used widely in stock photography to assign each image a keyword.
 
 ### Image Search
@@ -29,9 +31,9 @@ import { HfInference } from "@huggingface/inference";
 
 const inference = new HfInference(HF_ACCESS_TOKEN);
 await inference.imageClassification({
-  data: await (await fetch('https://picsum.photos/300/300')).blob(),
-  model: 'microsoft/resnet-50',  
-})
+	data: await (await fetch("https://picsum.photos/300/300")).blob(),
+	model: "microsoft/resnet-50",
+});
 ```
 
 ## Useful Resources

package/src/image-classification/data.ts

@@ -5,19 +5,19 @@ const taskData: TaskDataCustom = {
 		{
 			// TODO write proper description
 			description: "Benchmark dataset used for image classification with images that belong to 100 classes.",
-			id:          "cifar100",
+			id: "cifar100",
 		},
 		{
 			// TODO write proper description
 			description: "Dataset consisting of images of garments.",
-			id:          "fashion_mnist",
+			id: "fashion_mnist",
 		},
 	],
 	demo: {
 		inputs: [
 			{
 				filename: "image-classification-input.jpeg",
-				type:     "img",
+				type: "img",
 			},
 		],
 		outputs: [
@@ -43,46 +43,46 @@ const taskData: TaskDataCustom = {
 	metrics: [
 		{
 			description: "",
-			id:          "accuracy",
+			id: "accuracy",
 		},
 		{
 			description: "",
-			id:          "recall",
+			id: "recall",
 		},
 		{
 			description: "",
-			id:          "precision",
+			id: "precision",
 		},
 		{
 			description: "",
-			id:          "f1",
+			id: "f1",
 		},
-
 	],
 	models: [
 		{
 			description: "A strong image classification model.",
-			id:          "google/vit-base-patch16-224",
+			id: "google/vit-base-patch16-224",
 		},
 		{
 			description: "A robust image classification model.",
-			id:          "facebook/deit-base-distilled-patch16-224",
+			id: "facebook/deit-base-distilled-patch16-224",
 		},
 		{
 			description: "A strong image classification model.",
-			id:          "facebook/convnext-large-224",
+			id: "facebook/convnext-large-224",
 		},
 	],
-	spaces:       [
+	spaces: [
 		{
 			// TO DO: write description
 			description: "An application that classifies what a given image is about.",
-			id:          "nielsr/perceiver-image-classification",
+			id: "nielsr/perceiver-image-classification",
 		},
 	],
-	summary:      "Image classification is the task of assigning a label or class to an entire image. Images are expected to have only one class for each image. Image classification models take an image as input and return a prediction about which class the image belongs to.",
+	summary:
+		"Image classification is the task of assigning a label or class to an entire image. Images are expected to have only one class for each image. Image classification models take an image as input and return a prediction about which class the image belongs to.",
 	widgetModels: ["google/vit-base-patch16-224"],
-	youtubeId:    "tjAIM7BOYhw",
+	youtubeId: "tjAIM7BOYhw",
 };
 
 export default taskData;

package/src/image-segmentation/about.md

@@ -47,9 +47,9 @@ import { HfInference } from "@huggingface/inference";
 
 const inference = new HfInference(HF_ACCESS_TOKEN);
 await inference.imageSegmentation({
-  data: await (await fetch('https://picsum.photos/300/300')).blob(),
-  model: 'facebook/detr-resnet-50-panoptic',  
-})
+	data: await (await fetch("https://picsum.photos/300/300")).blob(),
+	model: "facebook/detr-resnet-50-panoptic",
+});
 ```
 
 ## Useful Resources
@@ -60,4 +60,4 @@ Would you like to learn more about image segmentation? Great! Here you can find
 - [Walkthrough of Computer Vision Ecosystem in Hugging Face - CV Study Group](https://www.youtube.com/watch?v=oL-xmufhZM8)
 - [A Guide on Universal Image Segmentation with Mask2Former and OneFormer](https://huggingface.co/blog/mask2former)
 - [Zero-shot image segmentation with CLIPSeg](https://huggingface.co/blog/clipseg-zero-shot)
-- [Semantic segmentation task guide](https://huggingface.co/docs/transformers/tasks/semantic_segmentation)
+- [Semantic segmentation task guide](https://huggingface.co/docs/transformers/tasks/semantic_segmentation)

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">
 
-
 ## 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.