@huggingface/tasks 0.13.1-test → 0.13.1-test2

package/src/tasks/summarization/inference.ts

@@ -0,0 +1,57 @@
+/**
+ * Inference code generated from the JSON schema spec in ./spec
+ *
+ * Using src/scripts/inference-codegen
+ */
+
+/**
+ * Inputs for Summarization inference
+ */
+export interface SummarizationInput {
+	/**
+	 * The input text to summarize.
+	 */
+	inputs: string;
+	/**
+	 * Additional inference parameters.
+	 */
+	parameters?: SummarizationParameters;
+	[property: string]: unknown;
+}
+
+/**
+ * Additional inference parameters.
+ *
+ * Additional inference parameters for summarization.
+ */
+export interface SummarizationParameters {
+	/**
+	 * Whether to clean up the potential extra spaces in the text output.
+	 */
+	clean_up_tokenization_spaces?: boolean;
+	/**
+	 * Additional parametrization of the text generation algorithm.
+	 */
+	generate_parameters?: { [key: string]: unknown };
+	/**
+	 * The truncation strategy to use.
+	 */
+	truncation?: SummarizationTruncationStrategy;
+	[property: string]: unknown;
+}
+
+/**
+ * The truncation strategy to use.
+ */
+export type SummarizationTruncationStrategy = "do_not_truncate" | "longest_first" | "only_first" | "only_second";
+
+/**
+ * Outputs of inference for the Summarization task
+ */
+export interface SummarizationOutput {
+	/**
+	 * The summarized text.
+	 */
+	summary_text: string;
+	[property: string]: unknown;
+}

package/src/tasks/summarization/spec/input.json

@@ -0,0 +1,42 @@
+{
+	"$id": "/inference/schemas/summarization/input.json",
+	"$schema": "http://json-schema.org/draft-06/schema#",
+	"description": "Inputs for Summarization inference",
+	"title": "SummarizationInput",
+	"type": "object",
+	"properties": {
+		"inputs": {
+			"description": "The input text to summarize.",
+			"type": "string"
+		},
+		"parameters": {
+			"description": "Additional inference parameters.",
+			"$ref": "#/$defs/SummarizationParameters"
+		}
+	},
+	"$defs": {
+		"SummarizationParameters": {
+			"title": "SummarizationParameters",
+			"description": "Additional inference parameters for summarization.",
+			"type": "object",
+			"properties": {
+				"clean_up_tokenization_spaces": {
+					"type": "boolean",
+					"description": "Whether to clean up the potential extra spaces in the text output."
+				},
+				"truncation": {
+					"title": "SummarizationTruncationStrategy",
+					"type": "string",
+					"description": "The truncation strategy to use.",
+					"enum": ["do_not_truncate", "longest_first", "only_first", "only_second"]
+				},
+				"generate_parameters": {
+					"title": "generateParameters",
+					"type": "object",
+					"description": "Additional parametrization of the text generation algorithm."
+				}
+			}
+		}
+	},
+	"required": ["inputs"]
+}

package/src/tasks/summarization/spec/output.json

@@ -0,0 +1,14 @@
+{
+	"$id": "/inference/schemas/summarization/output.json",
+	"$schema": "http://json-schema.org/draft-06/schema#",
+	"description": "Outputs of inference for the Summarization task",
+	"title": "SummarizationOutput",
+	"type": "object",
+	"properties": {
+		"summary_text": {
+			"type": "string",
+			"description": "The summarized text."
+		}
+	},
+	"required": ["summary_text"]
+}

package/src/tasks/table-question-answering/about.md

@@ -0,0 +1,43 @@
+## Use Cases
+
+### SQL execution
+
+You can use the Table Question Answering models to simulate SQL execution by inputting a table.
+
+### Table Question Answering
+
+Table Question Answering models are capable of answering questions based on a table.
+
+## Task Variants
+
+This place can be filled with variants of this task if there's any.
+
+## Inference
+
+You can infer with TableQA models using the 🤗 Transformers library.
+
+```python
+from transformers import pipeline
+import pandas as pd
+
+# prepare table + question
+data = {"Actors": ["Brad Pitt", "Leonardo Di Caprio", "George Clooney"], "Number of movies": ["87", "53", "69"]}
+table = pd.DataFrame.from_dict(data)
+question = "how many movies does Leonardo Di Caprio have?"
+
+# pipeline model
+# Note: you must to install torch-scatter first.
+tqa = pipeline(task="table-question-answering", model="google/tapas-large-finetuned-wtq")
+
+# result
+
+print(tqa(table=table, query=question)['cells'][0])
+#53
+
+```
+
+## Useful Resources
+
+In this area, you can insert useful resources about how to train or use a model for this task.
+
+This task page is complete thanks to the efforts of [Hao Kim Tieu](https://huggingface.co/haotieu). 🦸

package/src/tasks/table-question-answering/data.ts

@@ -0,0 +1,59 @@
+import type { TaskDataCustom } from "../index.js";
+
+const taskData: TaskDataCustom = {
+	datasets: [
+		{
+			description:
+				"The WikiTableQuestions dataset is a large-scale dataset for the task of question answering on semi-structured tables.",
+			id: "wikitablequestions",
+		},
+		{
+			description:
+				"WikiSQL is a dataset of 80654 hand-annotated examples of questions and SQL queries distributed across 24241 tables from Wikipedia.",
+			id: "wikisql",
+		},
+	],
+	demo: {
+		inputs: [
+			{
+				table: [
+					["Rank", "Name", "No.of reigns", "Combined days"],
+					["1", "lou Thesz", "3", "3749"],
+					["2", "Ric Flair", "8", "3103"],
+					["3", "Harley Race", "7", "1799"],
+				],
+				type: "tabular",
+			},
+
+			{ label: "Question", content: "What is the number of reigns for Harley Race?", type: "text" },
+		],
+		outputs: [{ label: "Result", content: "7", type: "text" }],
+	},
+	metrics: [
+		{
+			description: "Checks whether the predicted answer(s) is the same as the ground-truth answer(s).",
+			id: "Denotation Accuracy",
+		},
+	],
+	models: [
+		{
+			description:
+				"A table question answering model that is capable of neural SQL execution, i.e., employ TAPEX to execute a SQL query on a given table.",
+			id: "microsoft/tapex-base",
+		},
+		{
+			description: "A robust table question answering model.",
+			id: "google/tapas-base-finetuned-wtq",
+		},
+	],
+	spaces: [
+		{
+			description: "An application that answers questions based on table CSV files.",
+			id: "katanaml/table-query",
+		},
+	],
+	summary: "Table Question Answering (Table QA) is the answering a question about an information on a given table.",
+	widgetModels: ["google/tapas-base-finetuned-wtq"],
+};
+
+export default taskData;

package/src/tasks/table-question-answering/inference.ts

@@ -0,0 +1,61 @@
+/**
+ * Inference code generated from the JSON schema spec in ./spec
+ *
+ * Using src/scripts/inference-codegen
+ */
+/**
+ * Inputs for Table Question Answering inference
+ */
+export interface TableQuestionAnsweringInput {
+	/**
+	 * One (table, question) pair to answer
+	 */
+	inputs: TableQuestionAnsweringInputData;
+	/**
+	 * Additional inference parameters
+	 */
+	parameters?: {
+		[key: string]: unknown;
+	};
+	[property: string]: unknown;
+}
+/**
+ * One (table, question) pair to answer
+ */
+export interface TableQuestionAnsweringInputData {
+	/**
+	 * The question to be answered about the table
+	 */
+	question: string;
+	/**
+	 * The table to serve as context for the questions
+	 */
+	table: {
+		[key: string]: string[];
+	};
+	[property: string]: unknown;
+}
+export type TableQuestionAnsweringOutput = TableQuestionAnsweringOutputElement[];
+/**
+ * Outputs of inference for the Table Question Answering task
+ */
+export interface TableQuestionAnsweringOutputElement {
+	/**
+	 * If the model has an aggregator, this returns the aggregator.
+	 */
+	aggregator?: string;
+	/**
+	 * The answer of the question given the table. If there is an aggregator, the answer will be
+	 * preceded by `AGGREGATOR >`.
+	 */
+	answer: string;
+	/**
+	 * List of strings made up of the answer cell values.
+	 */
+	cells: string[];
+	/**
+	 * Coordinates of the cells of the answers.
+	 */
+	coordinates: Array<number[]>;
+	[property: string]: unknown;
+}

package/src/tasks/table-question-answering/spec/input.json

@@ -0,0 +1,44 @@
+{
+	"$id": "/inference/schemas/table-question-answering/input.json",
+	"$schema": "http://json-schema.org/draft-06/schema#",
+	"description": "Inputs for Table Question Answering inference",
+	"title": "TableQuestionAnsweringInput",
+	"type": "object",
+	"properties": {
+		"inputs": {
+			"description": "One (table, question) pair to answer",
+			"title": "TableQuestionAnsweringInputData",
+			"type": "object",
+			"properties": {
+				"table": {
+					"description": "The table to serve as context for the questions",
+					"type": "object",
+					"additionalProperties": {
+						"type": "array",
+						"items": {
+							"type": "string"
+						}
+					}
+				},
+				"question": {
+					"description": "The question to be answered about the table",
+					"type": "string"
+				}
+			},
+			"required": ["table", "question"]
+		},
+		"parameters": {
+			"description": "Additional inference parameters",
+			"$ref": "#/$defs/TableQuestionAnsweringParameters"
+		}
+	},
+	"$defs": {
+		"TableQuestionAnsweringParameters": {
+			"title": "TableQuestionAnsweringParameters",
+			"description": "Additional inference parameters for Table Question Answering",
+			"type": "object",
+			"properties": {}
+		}
+	},
+	"required": ["inputs"]
+}

package/src/tasks/table-question-answering/spec/output.json

@@ -0,0 +1,40 @@
+{
+	"$id": "/inference/schemas/table-question-answering/output.json",
+	"$schema": "http://json-schema.org/draft-06/schema#",
+	"description": "Outputs of inference for the Table Question Answering task",
+	"title": "TableQuestionAnsweringOutput",
+	"type": "array",
+	"items": {
+		"type": "object",
+		"properties": {
+			"answer": {
+				"type": "string",
+				"description": "The answer of the question given the table. If there is an aggregator, the answer will be preceded by `AGGREGATOR >`."
+			},
+			"coordinates": {
+				"type": "array",
+				"description": "Coordinates of the cells of the answers.",
+				"items": {
+					"type": "array",
+					"items": {
+						"type": "integer"
+					},
+					"minLength": 2,
+					"maxLength": 2
+				}
+			},
+			"cells": {
+				"type": "array",
+				"description": "List of strings made up of the answer cell values.",
+				"items": {
+					"type": "string"
+				}
+			},
+			"aggregator": {
+				"type": "string",
+				"description": "If the model has an aggregator, this returns the aggregator."
+			}
+		},
+		"required": ["answer", "cells", "coordinates"]
+	}
+}

package/src/tasks/tabular-classification/about.md

@@ -0,0 +1,65 @@
+## About the Task
+
+Tabular classification is the task of assigning a label or class given a limited number of attributes. For example, the input can be data related to a customer (balance of the customer, the time being a customer, or more) and the output can be whether the customer will churn from the service or not.
+There are three types of categorical variables:
+
+- Binary variables: Variables that can take two values, like yes or no, open or closed. The task of predicting binary variables is called binary classification.
+- Ordinal variables: Variables with a ranking relationship, e.g., good, insignificant, and bad product reviews. The task of predicting ordinal variables is called ordinal classification.
+- Nominal variables: Variables with no ranking relationship among them, e.g., predicting an animal from their weight and height, where categories are cat, dog, or bird. The task of predicting nominal variables is called multinomial classification.
+
+## Use Cases
+
+### Fraud Detection
+Tabular classification models can be used in detecting fraudulent credit card transactions, where the features could be the amount of the transaction and the account balance, and the target to predict could be whether the transaction is fraudulent or not. This is an example of binary classification.
+
+### Churn Prediction
+Tabular classification models can be used in predicting customer churn in telecommunication. An example dataset for the task is hosted [here](https://huggingface.co/datasets/scikit-learn/churn-prediction).
+
+# Model Hosting and Inference
+
+You can use [skops](https://skops.readthedocs.io/) for model hosting and inference on the Hugging Face Hub. This library is built to improve production workflows of various libraries that are used to train tabular models, including [sklearn](https://scikit-learn.org/stable/) and [xgboost](https://xgboost.readthedocs.io/en/stable/). Using `skops` you can:
+
+- Easily use Inference Endpoints
+- Build neat UIs with one line of code,
+- Programmatically create model cards,
+- Securely serialize your scikit-learn model. (See limitations of using pickle [here](https://huggingface.co/docs/hub/security-pickle).)
+
+You can push your model as follows:
+
+```python
+from skops import hub_utils
+# initialize a repository with a trained model
+local_repo = "/path_to_new_repo"
+hub_utils.init(model, dst=local_repo)
+# push to Hub!
+hub_utils.push("username/my-awesome-model", source=local_repo)
+```
+
+Once the model is pushed, you can infer easily.
+
+```python
+import skops.hub_utils as hub_utils
+import pandas as pd
+data = pd.DataFrame(your_data)
+# Load the model from the Hub
+res = hub_utils.get_model_output("username/my-awesome-model", data)
+```
+
+You can launch a UI for your model with only one line of code!
+
+```python
+import gradio as gr
+gr.Interface.load("huggingface/username/my-awesome-model").launch()
+```
+
+## Useful Resources
+
+- Check out the [scikit-learn organization](https://huggingface.co/scikit-learn) to learn more about different algorithms used for this task.
+- [Skops documentation](https://skops.readthedocs.io/en/latest/)
+- [Skops announcement blog](https://huggingface.co/blog/skops)
+- [Notebook: Persisting your scikit-learn model using skops](https://www.kaggle.com/code/unofficialmerve/persisting-your-scikit-learn-model-using-skops)
+- Check out [interactive sklearn examples](https://huggingface.co/sklearn-docs) built with ❤️ using Gradio.
+
+### Training your own model in just a few seconds
+
+We have built a [baseline trainer](https://huggingface.co/spaces/scikit-learn/baseline-trainer) application to which you can drag and drop your dataset. It will train a baseline and push it to your Hugging Face Hub profile with a model card containing information about the model.

package/src/tasks/tabular-classification/data.ts

@@ -0,0 +1,68 @@
+import type { TaskDataCustom } from "../index.js";
+
+const taskData: TaskDataCustom = {
+	datasets: [
+		{
+			description: "A comprehensive curation of datasets covering all benchmarks.",
+			id: "inria-soda/tabular-benchmark",
+		},
+	],
+	demo: {
+		inputs: [
+			{
+				table: [
+					["Glucose", "Blood Pressure ", "Skin Thickness", "Insulin", "BMI"],
+					["148", "72", "35", "0", "33.6"],
+					["150", "50", "30", "0", "35.1"],
+					["141", "60", "29", "1", "39.2"],
+				],
+				type: "tabular",
+			},
+		],
+		outputs: [
+			{
+				table: [["Diabetes"], ["1"], ["1"], ["0"]],
+				type: "tabular",
+			},
+		],
+	},
+	metrics: [
+		{
+			description: "",
+			id: "accuracy",
+		},
+		{
+			description: "",
+			id: "recall",
+		},
+		{
+			description: "",
+			id: "precision",
+		},
+		{
+			description: "",
+			id: "f1",
+		},
+	],
+	models: [
+		{
+			description: "Breast cancer prediction model based on decision trees.",
+			id: "scikit-learn/cancer-prediction-trees",
+		},
+	],
+	spaces: [
+		{
+			description: "An application that can predict defective products on a production line.",
+			id: "scikit-learn/tabular-playground",
+		},
+		{
+			description: "An application that compares various tabular classification techniques on different datasets.",
+			id: "scikit-learn/classification",
+		},
+	],
+	summary: "Tabular classification is the task of classifying a target category (a group) based on set of attributes.",
+	widgetModels: ["scikit-learn/tabular-playground"],
+	youtubeId: "",
+};
+
+export default taskData;

package/src/tasks/tabular-regression/about.md

@@ -0,0 +1,87 @@
+## About the Task
+
+Tabular regression is the task of predicting a numerical value given a set of attributes/features. _Tabular_ meaning that data is stored in a table (like an excel sheet), and each sample is contained in its own row. The features used to predict our target can be both numerical and categorical. However, including categorical features often requires additional preprocessing/feature engineering (a few models do accept categorical features directly, like [CatBoost](https://catboost.ai/)). An example of tabular regression would be predicting the weight of a fish given its' species and length.
+
+## Use Cases
+
+### Sales Prediction: a Use Case for Predicting a Continuous Target Variable
+
+Here the objective is to predict a continuous variable based on a set of input variable(s). For example, predicting `sales` of an ice cream shop based on `temperature` of weather and `duration of hours` shop was open. Here we can build a regression model with `temperature` and `duration of hours` as input variable and `sales` as target variable.
+
+### Missing Value Imputation for Other Tabular Tasks
+In real-world applications, due to human error or other reasons, some of the input values can be missing or there might not be any recorded data. Considering the example above, say the shopkeeper's watch was broken and they forgot to calculate the `hours` for which the shop was open. This will lead to a missing value in their dataset. In this case, missing values could be replaced it with zero, or average hours for which the shop is kept open. Another approach we can try is to use `temperature` and `sales` variables to predict the `hours` variable here.
+
+## Model Training
+
+A simple regression model can be created using `sklearn` as follows:
+
+```python
+#set the input features
+X = data[["Feature 1", "Feature 2", "Feature 3"]]
+#set the target variable
+y = data["Target Variable"]
+#initialize the model
+model = LinearRegression()
+#Fit the model
+model.fit(X, y)
+```
+
+# Model Hosting and Inference
+
+You can use [skops](https://skops.readthedocs.io/) for model hosting and inference on the Hugging Face Hub. This library is built to improve production workflows of various libraries that are used to train tabular models, including [sklearn](https://scikit-learn.org/stable/) and [xgboost](https://xgboost.readthedocs.io/en/stable/). Using `skops` you can:
+
+- Easily use Inference Endpoints,
+- Build neat UIs with one line of code,
+- Programmatically create model cards,
+- Securely serialize your models. (See limitations of using pickle [here](https://huggingface.co/docs/hub/security-pickle).)
+
+You can push your model as follows:
+
+```python
+from skops import hub_utils
+# initialize a repository with a trained model
+local_repo = "/path_to_new_repo"
+hub_utils.init(model, dst=local_repo)
+# push to Hub!
+hub_utils.push("username/my-awesome-model", source=local_repo)
+```
+
+Once the model is pushed, you can infer easily.
+
+```python
+import skops.hub_utils as hub_utils
+import pandas as pd
+data = pd.DataFrame(your_data)
+# Load the model from the Hub
+res = hub_utils.get_model_output("username/my-awesome-model", data)
+```
+
+You can launch a UI for your model with only one line of code!
+
+```python
+import gradio as gr
+gr.Interface.load("huggingface/username/my-awesome-model").launch()
+```
+
+## Useful Resources
+
+- [Skops documentation](https://skops.readthedocs.io/en/stable/index.html)
+
+- Check out [interactive sklearn examples](https://huggingface.co/sklearn-docs) built with ❤️ using Gradio.
+- [Notebook: Persisting your scikit-learn model using skops](https://www.kaggle.com/code/unofficialmerve/persisting-your-scikit-learn-model-using-skops)
+
+- For starting with tabular regression:
+
+  - Doing [Exploratory Data Analysis](https://neptune.ai/blog/exploratory-data-analysis-for-tabular-data) for tabular data.
+    - The data considered here consists of details of Olympic athletes and medal results from Athens 1896 to Rio 2016.
+    - Here you can learn more about how to explore and analyse the data and visualize them in order to get a better understanding of dataset.
+  - Building your [first ML model](https://www.kaggle.com/code/dansbecker/your-first-machine-learning-model).
+
+- Intermediate level tutorials on tabular regression:
+  - [A Short Chronology of Deep Learning for Tabular Data](https://sebastianraschka.com/blog/2022/deep-learning-for-tabular-data.html) by Sebastian Raschka.
+
+### Training your own model in just a few seconds
+
+We have built a [baseline trainer](https://huggingface.co/spaces/scikit-learn/baseline-trainer) application to which you can drag and drop your dataset. It will train a baseline and push it to your Hugging Face Hub profile with a model card containing information about the model.
+
+This page was made possible thanks to efforts of [Brenden Connors](https://huggingface.co/brendenc) and [Ayush Bihani](https://huggingface.co/hsuyab).

package/src/tasks/tabular-regression/data.ts

@@ -0,0 +1,57 @@
+import type { TaskDataCustom } from "../index.js";
+
+const taskData: TaskDataCustom = {
+	datasets: [
+		{
+			description: "A comprehensive curation of datasets covering all benchmarks.",
+			id: "inria-soda/tabular-benchmark",
+		},
+	],
+	demo: {
+		inputs: [
+			{
+				table: [
+					["Car Name", "Horsepower", "Weight"],
+					["ford torino", "140", "3,449"],
+					["amc hornet", "97", "2,774"],
+					["toyota corolla", "65", "1,773"],
+				],
+				type: "tabular",
+			},
+		],
+		outputs: [
+			{
+				table: [["MPG (miles per gallon)"], ["17"], ["18"], ["31"]],
+				type: "tabular",
+			},
+		],
+	},
+	metrics: [
+		{
+			description: "",
+			id: "mse",
+		},
+		{
+			description:
+				"Coefficient of determination (or R-squared) is a measure of how well the model fits the data. Higher R-squared is considered a better fit.",
+			id: "r-squared",
+		},
+	],
+	models: [
+		{
+			description: "Fish weight prediction based on length measurements and species.",
+			id: "scikit-learn/Fish-Weight",
+		},
+	],
+	spaces: [
+		{
+			description: "An application that can predict weight of a fish based on set of attributes.",
+			id: "scikit-learn/fish-weight-prediction",
+		},
+	],
+	summary: "Tabular regression is the task of predicting a numerical value given a set of attributes.",
+	widgetModels: ["scikit-learn/Fish-Weight"],
+	youtubeId: "",
+};
+
+export default taskData;