@huggingface/tasks 0.2.1 → 0.3.0

package/package.json

@@ -1,23 +1,24 @@
 {
   "name": "@huggingface/tasks",
   "packageManager": "pnpm@8.10.5",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "List of ML tasks for huggingface.co/tasks",
   "repository": "https://github.com/huggingface/huggingface.js.git",
   "publishConfig": {
     "access": "public"
   },
-  "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "require": "./dist/index.js",
-      "import": "./dist/index.mjs"
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js"
     }
   },
   "source": "src/index.ts",
+  "type": "module",
   "files": [
     "dist",
     "src",
@@ -30,13 +31,17 @@
   ],
   "author": "Hugging Face",
   "license": "MIT",
-  "devDependencies": {},
+  "devDependencies": {
+    "@types/node": "^20.11.5",
+    "quicktype-core": "https://github.com/huggingface/quicktype/raw/pack-18.0.15/packages/quicktype-core/quicktype-core-18.0.15.tgz"
+  },
   "scripts": {
     "lint": "eslint --quiet --fix --ext .cjs,.ts .",
     "lint:check": "eslint --ext .cjs,.ts .",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
-    "build": "tsup src/index.ts --format cjs,esm --clean --dts",
-    "check": "tsc"
+    "build": "tsup src/index.ts --format cjs,esm --clean --dts && pnpm run inference-codegen",
+    "check": "tsc",
+    "inference-codegen": "tsx scripts/inference-codegen.ts && prettier --write src/tasks/*/inference.ts"
   }
 }

package/src/index.ts

@@ -1,5 +1,4 @@
 export { LIBRARY_TASK_MAPPING_EXCLUDING_TRANSFORMERS } from "./library-to-tasks";
-export { MODEL_LIBRARIES_UI_ELEMENTS } from "./library-ui-elements";
 export { MAPPING_DEFAULT_WIDGET } from "./default-widget-inputs";
 export type { TaskData, TaskDemo, TaskDemoEntry, ExampleRepo } from "./tasks";
 export * from "./tasks";
@@ -14,8 +13,8 @@ export {
 	SUBTASK_TYPES,
 	PIPELINE_TYPES_SET,
 } from "./pipelines";
-export { ModelLibrary, ALL_DISPLAY_MODEL_LIBRARY_KEYS } from "./model-libraries";
-export type { ModelLibraryKey } from "./model-libraries";
+export { ALL_DISPLAY_MODEL_LIBRARY_KEYS, ALL_MODEL_LIBRARY_KEYS, MODEL_LIBRARIES_UI_ELEMENTS } from "./model-libraries";
+export type { LibraryUiElement, ModelLibraryKey } from "./model-libraries";
 export type { ModelData, TransformersInfo } from "./model-data";
 export type {
 	WidgetExample,
@@ -41,5 +40,3 @@ export { InferenceDisplayability } from "./model-data";
 
 import * as snippets from "./snippets";
 export { snippets };
-
-export type { LibraryUiElement } from "./library-ui-elements";

package/src/library-to-tasks.ts

@@ -3,7 +3,7 @@ import type { PipelineType } from "./pipelines";
 
 /**
  * Mapping from library name (excluding Transformers) to its supported tasks.
- * Inference API should be disabled for all other (library, task) pairs beyond this mapping.
+ * Inference API (serverless) should be disabled for all other (library, task) pairs beyond this mapping.
  * As an exception, we assume Transformers supports all inference tasks.
  * This mapping is generated automatically by "python-api-export-tasks" action in huggingface/api-inference-community repo upon merge.
  * Ref: https://github.com/huggingface/api-inference-community/pull/158

package/src/model-data.ts

@@ -78,7 +78,7 @@ export interface ModelData {
 	 */
 	widgetData?: WidgetExample[] | undefined;
 	/**
-	 * Parameters that will be used by the widget when calling Inference API
+	 * Parameters that will be used by the widget when calling Inference Endpoints (serverless)
 	 * https://huggingface.co/docs/api-inference/detailed_parameters
 	 *
 	 * can be set in the model card metadata (under `inference/parameters`)

package/src/model-libraries-downloads.ts

@@ -0,0 +1,20 @@
+/**
+ * This file contains the (simplified) types used
+ * to represent queries that are made to Elastic
+ * in order to count number of model downloads
+ *
+ * Read this doc about download stats on the Hub:
+ *
+ * https://huggingface.co/docs/hub/models-download-stats
+ *
+ * see also:
+ * https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html
+ */
+
+export type ElasticBoolQueryFilter =
+	// match a single filename
+	| { term?: { path: string } }
+	// match multiple possible filenames
+	| { terms?: { path: string[] } }
+	// match a wildcard
+	| { wildcard?: { path: string } };