@huggingface/tasks 0.13.0 → 0.13.1-test

package/src/tasks/image-to-image/spec/input.json

@@ -1,55 +0,0 @@
-{
-	"$id": "/inference/schemas/image-to-image/input.json",
-	"$schema": "http://json-schema.org/draft-06/schema#",
-	"description": "Inputs for Image To Image inference",
-	"title": "ImageToImageInput",
-	"type": "object",
-	"properties": {
-		"inputs": {
-			"type": "string",
-			"description": "The input image data as a base64-encoded string. If no `parameters` are provided, you can also provide the image data as a raw bytes payload."
-		},
-		"parameters": {
-			"description": "Additional inference parameters",
-			"$ref": "#/$defs/ImageToImageParameters"
-		}
-	},
-	"$defs": {
-		"ImageToImageParameters": {
-			"title": "ImageToImageParameters",
-			"description": "Additional inference parameters for Image To Image",
-			"type": "object",
-			"properties": {
-				"guidance_scale": {
-					"type": "number",
-					"description": "For diffusion models. A higher guidance scale value encourages the model to generate images closely linked to the text prompt at the expense of lower image quality."
-				},
-				"negative_prompt": {
-					"type": "array",
-					"items": {
-						"type": "string"
-					},
-					"description": "One or several prompt to guide what NOT to include in image generation."
-				},
-				"num_inference_steps": {
-					"type": "integer",
-					"description": "For diffusion models. The number of denoising steps. More denoising steps usually lead to a higher quality image at the expense of slower inference."
-				},
-				"target_size": {
-					"type": "object",
-					"description": "The size in pixel of the output image.",
-					"properties": {
-						"width": {
-							"type": "integer"
-						},
-						"height": {
-							"type": "integer"
-						}
-					},
-					"required": ["width", "height"]
-				}
-			}
-		}
-	},
-	"required": ["inputs"]
-}

package/src/tasks/image-to-image/spec/output.json

@@ -1,12 +0,0 @@
-{
-	"$id": "/inference/schemas/image-to-image/output.json",
-	"$schema": "http://json-schema.org/draft-06/schema#",
-	"description": "Outputs of inference for the Image To Image task",
-	"title": "ImageToImageOutput",
-	"type": "object",
-	"properties": {
-		"image": {
-			"description": "The output image returned as raw bytes in the payload."
-		}
-	}
-}

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

@@ -1,61 +0,0 @@
-## Use Cases
-
-### Image Captioning
-
-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.
-
-## 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
-
-captioner = pipeline("image-to-text", model="Salesforce/blip-image-captioning-base")
-captioner("https://huggingface.co/datasets/Narsil/image_dummy/resolve/main/parrots.png")
-## [{'generated_text': 'two birds are standing next to each other '}]
-```
-
-### 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
-
-processor = TrOCRProcessor.from_pretrained('microsoft/trocr-base-handwritten')
-model = VisionEncoderDecoderModel.from_pretrained('microsoft/trocr-base-handwritten')
-pixel_values = processor(images="image.jpeg", return_tensors="pt").pixel_values
-
-generated_ids = model.generate(pixel_values)
-generated_text = processor.batch_decode(generated_ids, skip_special_tokens=True)[0]
-
-```
-
-You can use [huggingface.js](https://github.com/huggingface/huggingface.js) to infer image-to-text models on Hugging Face Hub.
-
-```javascript
-import { HfInference } from "@huggingface/inference";
-
-const inference = new HfInference(HF_TOKEN);
-await inference.imageToText({
-	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)
-- [Train OCR model on your dataset ](https://github.com/NielsRogge/Transformers-Tutorials/tree/master/TrOCR)
-
-This page was made possible thanks to efforts of [Sukesh Perla](https://huggingface.co/hitchhiker3010) and [Johannes Kolbe](https://huggingface.co/johko).

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

@@ -1,82 +0,0 @@
-import type { TaskDataCustom } from "..";
-
-const taskData: TaskDataCustom = {
-	datasets: [
-		{
-			// TODO write proper description
-			description: "Dataset from 12M image-text of Reddit",
-			id: "red_caps",
-		},
-		{
-			// TODO write proper description
-			description: "Dataset from 3.3M images of Google",
-			id: "datasets/conceptual_captions",
-		},
-	],
-	demo: {
-		inputs: [
-			{
-				filename: "savanna.jpg",
-				type: "img",
-			},
-		],
-		outputs: [
-			{
-				label: "Detailed description",
-				content: "a herd of giraffes and zebras grazing in a field",
-				type: "text",
-			},
-		],
-	},
-	metrics: [],
-	models: [
-		{
-			description: "A robust image captioning model.",
-			id: "Salesforce/blip2-opt-2.7b",
-		},
-		{
-			description: "A powerful and accurate image-to-text model that can also localize concepts in images.",
-			id: "microsoft/kosmos-2-patch14-224",
-		},
-		{
-			description: "A strong optical character recognition model.",
-			id: "facebook/nougat-base",
-		},
-		{
-			description: "A powerful model that lets you have a conversation with the image.",
-			id: "llava-hf/llava-1.5-7b-hf",
-		},
-	],
-	spaces: [
-		{
-			description: "An application that compares various image captioning models.",
-			id: "nielsr/comparing-captioning-models",
-		},
-		{
-			description: "A robust image captioning application.",
-			id: "flax-community/image-captioning",
-		},
-		{
-			description: "An application that transcribes handwritings into text.",
-			id: "nielsr/TrOCR-handwritten",
-		},
-		{
-			description: "An application that can caption images and answer questions about a given image.",
-			id: "Salesforce/BLIP",
-		},
-		{
-			description: "An application that can caption images and answer questions with a conversational agent.",
-			id: "Salesforce/BLIP2",
-		},
-		{
-			description: "An image captioning application that demonstrates the effect of noise on captions.",
-			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.",
-	widgetModels: ["Salesforce/blip-image-captioning-large"],
-	youtubeId: "",
-};
-
-export default taskData;

package/src/tasks/image-to-text/inference.ts

@@ -1,143 +0,0 @@
-/**
- * Inference code generated from the JSON schema spec in ./spec
- *
- * Using src/scripts/inference-codegen
- */
-
-/**
- * Inputs for Image To Text inference
- */
-export interface ImageToTextInput {
-	/**
-	 * The input image data
-	 */
-	inputs: unknown;
-	/**
-	 * Additional inference parameters
-	 */
-	parameters?: ImageToTextParameters;
-	[property: string]: unknown;
-}
-
-/**
- * Additional inference parameters
- *
- * Additional inference parameters for Image To Text
- */
-export interface ImageToTextParameters {
-	/**
-	 * Parametrization of the text generation process
-	 */
-	generation_parameters?: GenerationParameters;
-	/**
-	 * The amount of maximum tokens to generate.
-	 */
-	max_new_tokens?: number;
-	[property: string]: unknown;
-}
-
-/**
- * Parametrization of the text generation process
- *
- * Ad-hoc parametrization of the text generation process
- */
-export interface GenerationParameters {
-	/**
-	 * Whether to use sampling instead of greedy decoding when generating new tokens.
-	 */
-	do_sample?: boolean;
-	/**
-	 * Controls the stopping condition for beam-based methods.
-	 */
-	early_stopping?: EarlyStoppingUnion;
-	/**
-	 * If set to float strictly between 0 and 1, only tokens with a conditional probability
-	 * greater than epsilon_cutoff will be sampled. In the paper, suggested values range from
-	 * 3e-4 to 9e-4, depending on the size of the model. See [Truncation Sampling as Language
-	 * Model Desmoothing](https://hf.co/papers/2210.15191) for more details.
-	 */
-	epsilon_cutoff?: number;
-	/**
-	 * Eta sampling is a hybrid of locally typical sampling and epsilon sampling. If set to
-	 * float strictly between 0 and 1, a token is only considered if it is greater than either
-	 * eta_cutoff or sqrt(eta_cutoff) * exp(-entropy(softmax(next_token_logits))). The latter
-	 * term is intuitively the expected next token probability, scaled by sqrt(eta_cutoff). In
-	 * the paper, suggested values range from 3e-4 to 2e-3, depending on the size of the model.
-	 * See [Truncation Sampling as Language Model Desmoothing](https://hf.co/papers/2210.15191)
-	 * for more details.
-	 */
-	eta_cutoff?: number;
-	/**
-	 * The maximum length (in tokens) of the generated text, including the input.
-	 */
-	max_length?: number;
-	/**
-	 * The maximum number of tokens to generate. Takes precedence over max_length.
-	 */
-	max_new_tokens?: number;
-	/**
-	 * The minimum length (in tokens) of the generated text, including the input.
-	 */
-	min_length?: number;
-	/**
-	 * The minimum number of tokens to generate. Takes precedence over min_length.
-	 */
-	min_new_tokens?: number;
-	/**
-	 * Number of groups to divide num_beams into in order to ensure diversity among different
-	 * groups of beams. See [this paper](https://hf.co/papers/1610.02424) for more details.
-	 */
-	num_beam_groups?: number;
-	/**
-	 * Number of beams to use for beam search.
-	 */
-	num_beams?: number;
-	/**
-	 * The value balances the model confidence and the degeneration penalty in contrastive
-	 * search decoding.
-	 */
-	penalty_alpha?: number;
-	/**
-	 * The value used to modulate the next token probabilities.
-	 */
-	temperature?: number;
-	/**
-	 * The number of highest probability vocabulary tokens to keep for top-k-filtering.
-	 */
-	top_k?: number;
-	/**
-	 * If set to float < 1, only the smallest set of most probable tokens with probabilities
-	 * that add up to top_p or higher are kept for generation.
-	 */
-	top_p?: number;
-	/**
-	 * Local typicality measures how similar the conditional probability of predicting a target
-	 * token next is to the expected conditional probability of predicting a random token next,
-	 * given the partial text already generated. If set to float < 1, the smallest set of the
-	 * most locally typical tokens with probabilities that add up to typical_p or higher are
-	 * kept for generation. See [this paper](https://hf.co/papers/2202.00666) for more details.
-	 */
-	typical_p?: number;
-	/**
-	 * Whether the model should use the past last key/values attentions to speed up decoding
-	 */
-	use_cache?: boolean;
-	[property: string]: unknown;
-}
-
-/**
- * Controls the stopping condition for beam-based methods.
- */
-export type EarlyStoppingUnion = boolean | "never";
-
-/**
- * Outputs of inference for the Image To Text task
- */
-export interface ImageToTextOutput {
-	generatedText: unknown;
-	/**
-	 * The generated text.
-	 */
-	generated_text?: string;
-	[property: string]: unknown;
-}

package/src/tasks/image-to-text/spec/input.json

@@ -1,34 +0,0 @@
-{
-	"$id": "/inference/schemas/image-to-text/input.json",
-	"$schema": "http://json-schema.org/draft-06/schema#",
-	"description": "Inputs for Image To Text inference",
-	"title": "ImageToTextInput",
-	"type": "object",
-	"properties": {
-		"inputs": {
-			"description": "The input image data"
-		},
-		"parameters": {
-			"description": "Additional inference parameters",
-			"$ref": "#/$defs/ImageToTextParameters"
-		}
-	},
-	"$defs": {
-		"ImageToTextParameters": {
-			"title": "ImageToTextParameters",
-			"description": "Additional inference parameters for Image To Text",
-			"type": "object",
-			"properties": {
-				"max_new_tokens": {
-					"type": "integer",
-					"description": "The amount of maximum tokens to generate."
-				},
-				"generation_parameters": {
-					"description": "Parametrization of the text generation process",
-					"$ref": "/inference/schemas/common-definitions.json#/definitions/GenerationParameters"
-				}
-			}
-		}
-	},
-	"required": ["inputs"]
-}

package/src/tasks/image-to-text/spec/output.json

@@ -1,14 +0,0 @@
-{
-	"$id": "/inference/schemas/image-to-text/output.json",
-	"$schema": "http://json-schema.org/draft-06/schema#",
-	"description": "Outputs of inference for the Image To Text task",
-	"title": "ImageToTextOutput",
-	"type": "object",
-	"properties": {
-		"generated_text": {
-			"type": "string",
-			"description": "The generated text."
-		}
-	},
-	"required": ["generatedText"]
-}