@huggingface/inference 2.2.2 → 2.3.1

package/dist/index.js

@@ -22,6 +22,7 @@ var src_exports = {};
 __export(src_exports, {
   HfInference: () => HfInference,
   HfInferenceEndpoint: () => HfInferenceEndpoint,
+  InferenceOutputError: () => InferenceOutputError,
   audioClassification: () => audioClassification,
   automaticSpeechRecognition: () => automaticSpeechRecognition,
   conversational: () => conversational,
@@ -30,6 +31,7 @@ __export(src_exports, {
   fillMask: () => fillMask,
   imageClassification: () => imageClassification,
   imageSegmentation: () => imageSegmentation,
+  imageToImage: () => imageToImage,
   imageToText: () => imageToText,
   objectDetection: () => objectDetection,
   questionAnswering: () => questionAnswering,
@@ -62,6 +64,7 @@ __export(tasks_exports, {
   fillMask: () => fillMask,
   imageClassification: () => imageClassification,
   imageSegmentation: () => imageSegmentation,
+  imageToImage: () => imageToImage,
   imageToText: () => imageToText,
   objectDetection: () => objectDetection,
   questionAnswering: () => questionAnswering,
@@ -397,6 +400,48 @@ async function textToImage(args, options) {
   return res;
 }
 
+// ../shared/src/base64FromBytes.ts
+function base64FromBytes(arr) {
+  if (globalThis.Buffer) {
+    return globalThis.Buffer.from(arr).toString("base64");
+  } else {
+    const bin = [];
+    arr.forEach((byte) => {
+      bin.push(String.fromCharCode(byte));
+    });
+    return globalThis.btoa(bin.join(""));
+  }
+}
+
+// ../shared/src/isBackend.ts
+var isBrowser = typeof window !== "undefined" && typeof window.document !== "undefined";
+var isWebWorker = typeof self === "object" && self.constructor && self.constructor.name === "DedicatedWorkerGlobalScope";
+
+// src/tasks/cv/imageToImage.ts
+async function imageToImage(args, options) {
+  let reqArgs;
+  if (!args.parameters) {
+    reqArgs = {
+      accessToken: args.accessToken,
+      model: args.model,
+      data: args.inputs
+    };
+  } else {
+    reqArgs = {
+      ...args,
+      inputs: base64FromBytes(
+        new Uint8Array(args.inputs instanceof ArrayBuffer ? args.inputs : await args.inputs.arrayBuffer())
+      )
+    };
+  }
+  const res = await request(reqArgs, options);
+  const isValidOutput = res && res instanceof Blob;
+  if (!isValidOutput) {
+    throw new InferenceOutputError("Expected Blob");
+  }
+  return res;
+}
+
 // src/tasks/nlp/conversational.ts
 async function conversational(args, options) {
   const res = await request(args, options);
@@ -561,31 +606,18 @@ async function zeroShotClassification(args, options) {
   return res;
 }
 
-// ../shared/src/base64FromBytes.ts
-function base64FromBytes(arr) {
-  if (globalThis.Buffer) {
-    return globalThis.Buffer.from(arr).toString("base64");
-  } else {
-    const bin = [];
-    arr.forEach((byte) => {
-      bin.push(String.fromCharCode(byte));
-    });
-    return globalThis.btoa(bin.join(""));
-  }
-}
-
-// ../shared/src/isBackend.ts
-var isBrowser = typeof window !== "undefined" && typeof window.document !== "undefined";
-var isWebWorker = typeof self === "object" && self.constructor && self.constructor.name === "DedicatedWorkerGlobalScope";
-
 // src/tasks/multimodal/documentQuestionAnswering.ts
 async function documentQuestionAnswering(args, options) {
   const reqArgs = {
     ...args,
     inputs: {
       question: args.inputs.question,
-      // convert Blob to base64
-      image: base64FromBytes(new Uint8Array(await args.inputs.image.arrayBuffer()))
+      // convert Blob or ArrayBuffer to base64
+      image: base64FromBytes(
+        new Uint8Array(
+          args.inputs.image instanceof ArrayBuffer ? args.inputs.image : await args.inputs.image.arrayBuffer()
+        )
+      )
     }
   };
   const res = toArray(
@@ -604,8 +636,12 @@ async function visualQuestionAnswering(args, options) {
     ...args,
     inputs: {
       question: args.inputs.question,
-      // convert Blob to base64
-      image: base64FromBytes(new Uint8Array(await args.inputs.image.arrayBuffer()))
+      // convert Blob or ArrayBuffer to base64
+      image: base64FromBytes(
+        new Uint8Array(
+          args.inputs.image instanceof ArrayBuffer ? args.inputs.image : await args.inputs.image.arrayBuffer()
+        )
+      )
     }
   };
   const res = (await request(reqArgs, options))?.[0];
@@ -669,6 +705,7 @@ var HfInferenceEndpoint = class {
 0 && (module.exports = {
   HfInference,
   HfInferenceEndpoint,
+  InferenceOutputError,
   audioClassification,
   automaticSpeechRecognition,
   conversational,
@@ -677,6 +714,7 @@ var HfInferenceEndpoint = class {
   fillMask,
   imageClassification,
   imageSegmentation,
+  imageToImage,
   imageToText,
   objectDetection,
   questionAnswering,

package/dist/index.mjs

@@ -15,6 +15,7 @@ __export(tasks_exports, {
   fillMask: () => fillMask,
   imageClassification: () => imageClassification,
   imageSegmentation: () => imageSegmentation,
+  imageToImage: () => imageToImage,
   imageToText: () => imageToText,
   objectDetection: () => objectDetection,
   questionAnswering: () => questionAnswering,
@@ -350,6 +351,48 @@ async function textToImage(args, options) {
   return res;
 }
 
+// ../shared/src/base64FromBytes.ts
+function base64FromBytes(arr) {
+  if (globalThis.Buffer) {
+    return globalThis.Buffer.from(arr).toString("base64");
+  } else {
+    const bin = [];
+    arr.forEach((byte) => {
+      bin.push(String.fromCharCode(byte));
+    });
+    return globalThis.btoa(bin.join(""));
+  }
+}
+
+// ../shared/src/isBackend.ts
+var isBrowser = typeof window !== "undefined" && typeof window.document !== "undefined";
+var isWebWorker = typeof self === "object" && self.constructor && self.constructor.name === "DedicatedWorkerGlobalScope";
+
+// src/tasks/cv/imageToImage.ts
+async function imageToImage(args, options) {
+  let reqArgs;
+  if (!args.parameters) {
+    reqArgs = {
+      accessToken: args.accessToken,
+      model: args.model,
+      data: args.inputs
+    };
+  } else {
+    reqArgs = {
+      ...args,
+      inputs: base64FromBytes(
+        new Uint8Array(args.inputs instanceof ArrayBuffer ? args.inputs : await args.inputs.arrayBuffer())
+      )
+    };
+  }
+  const res = await request(reqArgs, options);
+  const isValidOutput = res && res instanceof Blob;
+  if (!isValidOutput) {
+    throw new InferenceOutputError("Expected Blob");
+  }
+  return res;
+}
+
 // src/tasks/nlp/conversational.ts
 async function conversational(args, options) {
   const res = await request(args, options);
@@ -514,31 +557,18 @@ async function zeroShotClassification(args, options) {
   return res;
 }
 
-// ../shared/src/base64FromBytes.ts
-function base64FromBytes(arr) {
-  if (globalThis.Buffer) {
-    return globalThis.Buffer.from(arr).toString("base64");
-  } else {
-    const bin = [];
-    arr.forEach((byte) => {
-      bin.push(String.fromCharCode(byte));
-    });
-    return globalThis.btoa(bin.join(""));
-  }
-}
-
-// ../shared/src/isBackend.ts
-var isBrowser = typeof window !== "undefined" && typeof window.document !== "undefined";
-var isWebWorker = typeof self === "object" && self.constructor && self.constructor.name === "DedicatedWorkerGlobalScope";
-
 // src/tasks/multimodal/documentQuestionAnswering.ts
 async function documentQuestionAnswering(args, options) {
   const reqArgs = {
     ...args,
     inputs: {
       question: args.inputs.question,
-      // convert Blob to base64
-      image: base64FromBytes(new Uint8Array(await args.inputs.image.arrayBuffer()))
+      // convert Blob or ArrayBuffer to base64
+      image: base64FromBytes(
+        new Uint8Array(
+          args.inputs.image instanceof ArrayBuffer ? args.inputs.image : await args.inputs.image.arrayBuffer()
+        )
+      )
     }
   };
   const res = toArray(
@@ -557,8 +587,12 @@ async function visualQuestionAnswering(args, options) {
     ...args,
     inputs: {
       question: args.inputs.question,
-      // convert Blob to base64
-      image: base64FromBytes(new Uint8Array(await args.inputs.image.arrayBuffer()))
+      // convert Blob or ArrayBuffer to base64
+      image: base64FromBytes(
+        new Uint8Array(
+          args.inputs.image instanceof ArrayBuffer ? args.inputs.image : await args.inputs.image.arrayBuffer()
+        )
+      )
     }
   };
   const res = (await request(reqArgs, options))?.[0];
@@ -621,6 +655,7 @@ var HfInferenceEndpoint = class {
 export {
   HfInference,
   HfInferenceEndpoint,
+  InferenceOutputError,
   audioClassification,
   automaticSpeechRecognition,
   conversational,
@@ -629,6 +664,7 @@ export {
   fillMask,
   imageClassification,
   imageSegmentation,
+  imageToImage,
   imageToText,
   objectDetection,
   questionAnswering,

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@huggingface/inference",
-  "version": "2.2.2",
+  "version": "2.3.1",
+  "packageManager": "pnpm@8.3.1",
   "license": "MIT",
   "author": "Tim Mikeladze <tim.mikeladze@gmail.com>",
   "description": "Typescript wrapper for the Hugging Face Inference API",
@@ -28,16 +29,17 @@
     "src"
   ],
   "source": "src/index.ts",
-  "types": "src/index.ts",
+  "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "exports": {
-    "types": "./src/index.ts",
+    "types": "./dist/index.d.ts",
     "require": "./dist/index.js",
     "import": "./dist/index.mjs"
   },
   "devDependencies": {
     "@types/node": "18.13.0",
+    "ts-node": "^10.9.1",
     "typescript": "^5.0.4",
     "vite": "^4.1.4",
     "vitest": "^0.29.8",
@@ -48,12 +50,12 @@
   ],
   "resolutions": {},
   "scripts": {
-    "build": "tsup src/index.ts --format cjs,esm --clean",
+    "build": "tsup src/index.ts --format cjs,esm --clean && pnpm run dts",
+    "dts": "ts-node scripts/generate-dts.ts",
     "lint": "eslint --quiet --fix --ext .cjs,.ts .",
     "lint:check": "eslint --ext .cjs,.ts .",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
-    "preversion": "pnpm --filter doc-internal run fix-cdn-versions && git add ../../README.md",
     "test": "vitest run --config vitest.config.ts",
     "test:browser": "vitest run --browser.name=chrome --browser.headless --config vitest.config.ts",
     "type-check": "tsc"

package/src/index.ts

@@ -1,3 +1,4 @@
 export { HfInference, HfInferenceEndpoint } from "./HfInference";
+export { InferenceOutputError } from "./lib/InferenceOutputError";
 export * from "./types";
 export * from "./tasks";

package/src/tasks/cv/imageToImage.ts

@@ -0,0 +1,83 @@
+import { InferenceOutputError } from "../../lib/InferenceOutputError";
+import type { BaseArgs, Options, RequestArgs } from "../../types";
+import { request } from "../custom/request";
+import { base64FromBytes } from "@huggingface/shared";
+
+export type ImageToImageArgs = BaseArgs & {
+	/**
+	 * The initial image condition
+	 *
+	 **/
+	inputs: Blob | ArrayBuffer;
+
+	parameters?: {
+		/**
+		 * The text prompt to guide the image generation.
+		 */
+		prompt?: string;
+		/**
+		 * strengh param only works for SD img2img and alt diffusion img2img models
+		 * Conceptually, indicates how much to transform the reference `image`. Must be between 0 and 1. `image`
+		 * will be used as a starting point, adding more noise to it the larger the `strength`. The number of
+		 * denoising steps depends on the amount of noise initially added. When `strength` is 1, added noise will
+		 * be maximum and the denoising process will run for the full number of iterations specified in
+		 * `num_inference_steps`. A value of 1, therefore, essentially ignores `image`.
+		 **/
+		strength?: number;
+		/**
+		 * An optional negative prompt for the image generation
+		 */
+		negative_prompt?: string;
+		/**
+		 * The height in pixels of the generated image
+		 */
+		height?: number;
+		/**
+		 * The width in pixels of the generated image
+		 */
+		width?: number;
+		/**
+		 * The number of denoising steps. More denoising steps usually lead to a higher quality image at the expense of slower inference.
+		 */
+		num_inference_steps?: number;
+		/**
+		 * Guidance scale: Higher guidance scale encourages to generate images that are closely linked to the text `prompt`, usually at the expense of lower image quality.
+		 */
+		guidance_scale?: number;
+		/**
+		 * guess_mode only works for ControlNet models, defaults to False In this mode, the ControlNet encoder will try best to recognize the content of the input image even if
+		 * you remove all prompts. The `guidance_scale` between 3.0 and 5.0 is recommended.
+		 */
+		guess_mode?: boolean;
+	};
+};
+
+export type ImageToImageOutput = Blob;
+
+/**
+ * This task reads some text input and outputs an image.
+ * Recommended model: lllyasviel/sd-controlnet-depth
+ */
+export async function imageToImage(args: ImageToImageArgs, options?: Options): Promise<ImageToImageOutput> {
+	let reqArgs: RequestArgs;
+	if (!args.parameters) {
+		reqArgs = {
+			accessToken: args.accessToken,
+			model: args.model,
+			data: args.inputs,
+		};
+	} else {
+		reqArgs = {
+			...args,
+			inputs: base64FromBytes(
+				new Uint8Array(args.inputs instanceof ArrayBuffer ? args.inputs : await args.inputs.arrayBuffer())
+			),
+		};
+	}
+	const res = await request<ImageToImageOutput>(reqArgs, options);
+	const isValidOutput = res && res instanceof Blob;
+	if (!isValidOutput) {
+		throw new InferenceOutputError("Expected Blob");
+	}
+	return res;
+}

package/src/tasks/index.ts

@@ -13,6 +13,7 @@ export * from "./cv/imageSegmentation";
 export * from "./cv/imageToText";
 export * from "./cv/objectDetection";
 export * from "./cv/textToImage";
+export * from "./cv/imageToImage";
 
 // Natural Language Processing tasks
 export * from "./nlp/conversational";

package/src/tasks/multimodal/documentQuestionAnswering.ts

@@ -12,7 +12,7 @@ export type DocumentQuestionAnsweringArgs = BaseArgs & {
 		 *
 		 * You can use native `File` in browsers, or `new Blob([buffer])` in node, or for a base64 image `new Blob([btoa(base64String)])`, or even `await (await fetch('...)).blob()`
 		 **/
-		image: Blob;
+		image: Blob | ArrayBuffer;
 		question: string;
 	};
 };
@@ -47,8 +47,12 @@ export async function documentQuestionAnswering(
 		...args,
 		inputs: {
 			question: args.inputs.question,
-			// convert Blob to base64
-			image: base64FromBytes(new Uint8Array(await args.inputs.image.arrayBuffer())),
+			// convert Blob or ArrayBuffer to base64
+			image: base64FromBytes(
+				new Uint8Array(
+					args.inputs.image instanceof ArrayBuffer ? args.inputs.image : await args.inputs.image.arrayBuffer()
+				)
+			),
 		},
 	} as RequestArgs;
 	const res = toArray(

package/src/tasks/multimodal/visualQuestionAnswering.ts

@@ -10,7 +10,7 @@ export type VisualQuestionAnsweringArgs = BaseArgs & {
 		 *
 		 * You can use native `File` in browsers, or `new Blob([buffer])` in node, or for a base64 image `new Blob([btoa(base64String)])`, or even `await (await fetch('...)).blob()`
 		 **/
-		image: Blob;
+		image: Blob | ArrayBuffer;
 		question: string;
 	};
 };
@@ -37,8 +37,12 @@ export async function visualQuestionAnswering(
 		...args,
 		inputs: {
 			question: args.inputs.question,
-			// convert Blob to base64
-			image: base64FromBytes(new Uint8Array(await args.inputs.image.arrayBuffer())),
+			// convert Blob or ArrayBuffer to base64
+			image: base64FromBytes(
+				new Uint8Array(
+					args.inputs.image instanceof ArrayBuffer ? args.inputs.image : await args.inputs.image.arrayBuffer()
+				)
+			),
 		},
 	} as RequestArgs;
 	const res = (await request<[VisualQuestionAnsweringOutput]>(reqArgs, options))?.[0];

package/src/utils/pick.ts

@@ -1,10 +1,7 @@
 /**
  * Return copy of object, only keeping allowlisted properties.
- *
- * This doesn't add {p: undefined} anymore, for props not in the o object.
  */
 export function pick<T, K extends keyof T>(o: T, props: K[] | ReadonlyArray<K>): Pick<T, K> {
-	// inspired by stackoverflow.com/questions/25553910/one-liner-to-take-some-properties-from-object-in-es-6
 	return Object.assign(
 		{},
 		...props.map((prop) => {