Merge branch 'main' into saksham/blackforestlabs-ai

SBrandeis · SBrandeis · commit f704e07f8a56 · 2025-02-12T15:30:03.000+01:00
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -42,6 +42,7 @@ jobs:
         env:
           HF_TOKEN: ${{ secrets.HF_TOKEN }}
           HF_FAL_KEY: dummy
+          HF_NEBIUS_KEY: dummy
           HF_REPLICATE_KEY: dummy
           HF_SAMBANOVA_KEY: dummy
           HF_TOGETHER_KEY: dummy
@@ -84,6 +85,7 @@ jobs:
         env:
           HF_TOKEN: ${{ secrets.HF_TOKEN }}
           HF_FAL_KEY: dummy
+          HF_NEBIUS_KEY: dummy
           HF_REPLICATE_KEY: dummy
           HF_SAMBANOVA_KEY: dummy
           HF_TOGETHER_KEY: dummy
@@ -153,6 +155,7 @@ jobs:
           NPM_CONFIG_REGISTRY: http://localhost:4874/
           HF_TOKEN: ${{ secrets.HF_TOKEN }}
           HF_FAL_KEY: dummy
+          HF_NEBIUS_KEY: dummy
           HF_REPLICATE_KEY: dummy
           HF_SAMBANOVA_KEY: dummy
           HF_TOGETHER_KEY: dummy
diff --git a/README.md b/README.md
@@ -96,7 +96,7 @@ You can run our packages with vanilla JS, without any bundler, by using a CDN or
 
 ```html
 <script type="module">
-    import { HfInference } from 'https://cdn.jsdelivr.net/npm/@huggingface/inference@3.3.0/+esm';
+    import { HfInference } from 'https://cdn.jsdelivr.net/npm/@huggingface/inference@3.3.3/+esm';
     import { createRepo, commit, deleteRepo, listFiles } from "https://cdn.jsdelivr.net/npm/@huggingface/hub@1.0.1/+esm";
 </script>
 ```
diff --git a/packages/agents/src/tools/imageToText.ts b/packages/agents/src/tools/imageToText.ts
@@ -15,12 +15,9 @@ export const imageToTextTool: Tool = {
 		if (typeof data === "string") throw "Input must be a blob.";
 
 		return (
-			await inference.imageToText(
-				{
-					data,
-				},
-				{ wait_for_model: true }
-			)
+			await inference.imageToText({
+				data,
+			})
 		).generated_text;
 	},
 };
diff --git a/packages/agents/src/tools/speechToText.ts b/packages/agents/src/tools/speechToText.ts
@@ -15,12 +15,9 @@ export const speechToTextTool: Tool = {
 		if (typeof data === "string") throw "Input must be a blob.";
 
 		return (
-			await inference.automaticSpeechRecognition(
-				{
-					data,
-				},
-				{ wait_for_model: true }
-			)
+			await inference.automaticSpeechRecognition({
+				data,
+			})
 		).text;
 	},
 };
diff --git a/packages/agents/src/tools/textToImage.ts b/packages/agents/src/tools/textToImage.ts
@@ -19,11 +19,8 @@ export const textToImageTool: Tool = {
 		const data = await input;
 		if (typeof data !== "string") throw "Input must be a string.";
 
-		return await inference.textToImage(
-			{
-				inputs: data,
-			},
-			{ wait_for_model: true }
-		);
+		return await inference.textToImage({
+			inputs: data,
+		});
 	},
 };
diff --git a/packages/agents/src/tools/textToSpeech.ts b/packages/agents/src/tools/textToSpeech.ts
@@ -19,12 +19,9 @@ export const textToSpeechTool: Tool = {
 		const data = await input;
 		if (typeof data !== "string") throw "Input must be a string.";
 
-		return inference.textToSpeech(
-			{
-				inputs: data,
-				model: "espnet/kan-bayashi_ljspeech_vits",
-			},
-			{ wait_for_model: true }
-		);
+		return inference.textToSpeech({
+			inputs: data,
+			model: "espnet/kan-bayashi_ljspeech_vits",
+		});
 	},
 };
diff --git a/packages/inference/README.md b/packages/inference/README.md
@@ -49,6 +49,7 @@ You can send inference requests to third-party providers with the inference clie
 Currently, we support the following providers:
 - [Fal.ai](https://fal.ai)
 - [Fireworks AI](https://fireworks.ai)
+- [Nebius](https://studio.nebius.ai)
 - [Replicate](https://replicate.com)
 - [Sambanova](https://sambanova.ai)
 - [Together](https://together.xyz)
@@ -72,12 +73,13 @@ When authenticated with a third-party provider key, the request is made directly
 Only a subset of models are supported when requesting third-party providers. You can check the list of supported models per pipeline tasks here:
 - [Fal.ai supported models](https://huggingface.co/api/partners/fal-ai/models)
 - [Fireworks AI supported models](https://huggingface.co/api/partners/fireworks-ai/models)
+- [Nebius supported models](https://huggingface.co/api/partners/nebius/models)
 - [Replicate supported models](https://huggingface.co/api/partners/replicate/models)
 - [Sambanova supported models](https://huggingface.co/api/partners/sambanova/models)
 - [Together supported models](https://huggingface.co/api/partners/together/models)
 - [HF Inference API (serverless)](https://huggingface.co/models?inference=warm&sort=trending)
 
-❗**Important note:** To be compatible, the third-party API must adhere to the "standard" shape API we expect on HF model pages for each pipeline task type. 
+❗**Important note:** To be compatible, the third-party API must adhere to the "standard" shape API we expect on HF model pages for each pipeline task type.
 This is not an issue for LLMs as everyone converged on the OpenAI API anyways, but can be more tricky for other tasks like "text-to-image" or "automatic-speech-recognition" where there exists no standard API. Let us know if any help is needed or if we can make things easier for you!
 
 👋**Want to add another provider?** Get in touch if you'd like to add support for another Inference provider, and/or request it on https://huggingface.co/spaces/huggingface/HuggingDiscussions/discussions/49
@@ -464,7 +466,7 @@ await hf.zeroShotImageClassification({
   model: 'openai/clip-vit-large-patch14-336',
   inputs: {
     image: await (await fetch('https://placekitten.com/300/300')).blob()
-  },  
+  },
   parameters: {
     candidate_labels: ['cat', 'dog']
   }
diff --git a/packages/inference/package.json b/packages/inference/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "@huggingface/inference",
-	"version": "3.3.0",
+	"version": "3.3.3",
 	"packageManager": "pnpm@8.10.5",
 	"license": "MIT",
 	"author": "Tim Mikeladze <tim.mikeladze@gmail.com>",
diff --git a/packages/inference/src/lib/makeRequestOptions.ts b/packages/inference/src/lib/makeRequestOptions.ts
@@ -1,5 +1,6 @@
 import { HF_HUB_URL, HF_ROUTER_URL } from "../config";
 import { FAL_AI_API_BASE_URL } from "../providers/fal-ai";
+import { NEBIUS_API_BASE_URL } from "../providers/nebius";
 import { REPLICATE_API_BASE_URL } from "../providers/replicate";
 import { SAMBANOVA_API_BASE_URL } from "../providers/sambanova";
 import { TOGETHER_API_BASE_URL } from "../providers/together";
@@ -39,8 +40,7 @@ export async function makeRequestOptions(
 	let otherArgs = remainingArgs;
 	const provider = maybeProvider ?? "hf-inference";
 
-	const { forceTask, includeCredentials, taskHint, wait_for_model, use_cache, dont_load_model, chatCompletion } =
-		options ?? {};
+	const { forceTask, includeCredentials, taskHint, chatCompletion } = options ?? {};
 
 	if (endpointUrl && provider !== "hf-inference") {
 		throw new Error(`Cannot use endpointUrl with a third-party provider.`);
@@ -107,18 +107,6 @@ export async function makeRequestOptions(
 		headers["Content-Type"] = "application/json";
 	}
 
-	if (provider === "hf-inference") {
-		if (wait_for_model) {
-			headers["X-Wait-For-Model"] = "true";
-		}
-		if (use_cache === false) {
-			headers["X-Use-Cache"] = "false";
-		}
-		if (dont_load_model) {
-			headers["X-Load-Model"] = "0";
-		}
-	}
-
 	if (provider === "replicate") {
 		headers["Prefer"] = "wait";
 	}
@@ -149,7 +137,7 @@ export async function makeRequestOptions(
 			? args.data
 			: JSON.stringify({
 					...otherArgs,
-					...(chatCompletion || provider === "together" ? { model } : undefined),
+					...(chatCompletion || provider === "together" || provider === "nebius" ? { model } : undefined),
 			  }),
 		...(credentials ? { credentials } : undefined),
 		signal: options?.signal,
@@ -184,6 +172,22 @@ function makeUrl(params: {
 				: FAL_AI_API_BASE_URL;
 			return `${baseUrl}/${params.model}`;
 		}
+		case "nebius": {
+			const baseUrl = shouldProxy
+				? HF_HUB_INFERENCE_PROXY_TEMPLATE.replace("{{PROVIDER}}", params.provider)
+				: NEBIUS_API_BASE_URL;
+
+			if (params.taskHint === "text-to-image") {
+				return `${baseUrl}/v1/images/generations`;
+			}
+			if (params.taskHint === "text-generation") {
+				if (params.chatCompletion) {
+					return `${baseUrl}/v1/chat/completions`;
+				}
+				return `${baseUrl}/v1/completions`;
+			}
+			return baseUrl;
+		}
 		case "replicate": {
 			const baseUrl = shouldProxy
 				? HF_HUB_INFERENCE_PROXY_TEMPLATE.replace("{{PROVIDER}}", params.provider)
diff --git a/packages/inference/src/providers/consts.ts b/packages/inference/src/providers/consts.ts
@@ -20,6 +20,7 @@ export const HARDCODED_MODEL_ID_MAPPING: Record<InferenceProvider, Record<ModelI
 	"fal-ai": {},
 	"fireworks-ai": {},
 	"hf-inference": {},
+	nebius: {},
 	replicate: {},
 	sambanova: {},
 	together: {},
diff --git a/packages/inference/src/providers/nebius.ts b/packages/inference/src/providers/nebius.ts
@@ -0,0 +1,18 @@
+export const NEBIUS_API_BASE_URL = "https://api.studio.nebius.ai";
+
+/**
+ * See the registered mapping of HF model ID => Nebius model ID here:
+ *
+ * https://huggingface.co/api/partners/nebius/models
+ *
+ * This is a publicly available mapping.
+ *
+ * If you want to try to run inference for a new model locally before it's registered on huggingface.co,
+ * you can add it to the dictionary "HARDCODED_MODEL_ID_MAPPING" in consts.ts, for dev purposes.
+ *
+ * - If you work at Nebius and want to update this mapping, please use the model mapping API we provide on huggingface.co
+ * - If you're a community member and want to add a new supported HF model to Nebius, please open an issue on the present repo
+ * and we will tag Nebius team members.
+ *
+ * Thanks!
+ */
diff --git a/packages/inference/src/tasks/custom/request.ts b/packages/inference/src/tasks/custom/request.ts
@@ -18,11 +18,8 @@ export async function request<T>(
 	const { url, info } = await makeRequestOptions(args, options);
 	const response = await (options?.fetch ?? fetch)(url, info);
 
-	if (options?.retry_on_error !== false && response.status === 503 && !options?.wait_for_model) {
-		return request(args, {
-			...options,
-			wait_for_model: true,
-		});
+	if (options?.retry_on_error !== false && response.status === 503) {
+		return request(args, options);
 	}
 
 	if (!response.ok) {
diff --git a/packages/inference/src/tasks/custom/streamingRequest.ts b/packages/inference/src/tasks/custom/streamingRequest.ts
@@ -20,11 +20,8 @@ export async function* streamingRequest<T>(
 	const { url, info } = await makeRequestOptions({ ...args, stream: true }, options);
 	const response = await (options?.fetch ?? fetch)(url, info);
 
-	if (options?.retry_on_error !== false && response.status === 503 && !options?.wait_for_model) {
-		return yield* streamingRequest(args, {
-			...options,
-			wait_for_model: true,
-		});
+	if (options?.retry_on_error !== false && response.status === 503) {
+		return yield* streamingRequest(args, options);
 	}
 	if (!response.ok) {
 		if (response.headers.get("Content-Type")?.startsWith("application/json")) {
diff --git a/packages/inference/src/tasks/cv/textToImage.ts b/packages/inference/src/tasks/cv/textToImage.ts
@@ -1,6 +1,6 @@
 import type { TextToImageInput, TextToImageOutput } from "@huggingface/tasks";
 import { InferenceOutputError } from "../../lib/InferenceOutputError";
-import type { BaseArgs, Options } from "../../types";
+import type { BaseArgs, InferenceProvider, Options } from "../../types";
 import { omit } from "../../utils/omit";
 import { request } from "../custom/request";
 import { delay } from "../../utils/delay";
@@ -21,29 +21,42 @@ interface BlackForestLabsResponse {
 	polling_url: string;
 }
 
+function getResponseFormatArg(provider: InferenceProvider) {
+	switch (provider) {
+		case "fal-ai":
+			return { sync_mode: true };
+		case "nebius":
+			return { response_format: "b64_json" };
+		case "replicate":
+			return undefined;
+		case "together":
+			return { response_format: "base64" };
+		default:
+			return undefined;
+	}
+}
+
 /**
  * This task reads some text input and outputs an image.
  * Recommended model: stabilityai/stable-diffusion-2
  */
 export async function textToImage(args: TextToImageArgs, options?: Options): Promise<Blob> {
 	const payload =
-		args.provider === "together" ||
-		args.provider === "fal-ai" ||
-		args.provider === "replicate" ||
-		args.provider === "black-forest-labs"
-			? {
+		!args.provider || args.provider === "hf-inference" || args.provider === "sambanova"
+			? args
+			: {
 					...omit(args, ["inputs", "parameters"]),
 					...args.parameters,
-					...(args.provider !== "replicate" ? { response_format: "base64" } : undefined),
+					...getResponseFormatArg(args.provider),
 					prompt: args.inputs,
-			  }
-			: args;
+			  };
 	const res = await request<
 		TextToImageOutput | Base64ImageGeneration | OutputUrlImageGeneration | BlackForestLabsResponse
 	>(payload, {
 		...options,
 		taskHint: "text-to-image",
 	});
+
 	if (res && typeof res === "object") {
 		if (args.provider === "black-forest-labs" && "polling_url" in res && typeof res.polling_url === "string") {
 			return await pollBflResponse(res.polling_url);
diff --git a/packages/inference/src/tasks/nlp/chatCompletion.ts b/packages/inference/src/tasks/nlp/chatCompletion.ts
@@ -15,14 +15,17 @@ export async function chatCompletion(
 		taskHint: "text-generation",
 		chatCompletion: true,
 	});
+
 	const isValidOutput =
 		typeof res === "object" &&
 		Array.isArray(res?.choices) &&
 		typeof res?.created === "number" &&
 		typeof res?.id === "string" &&
 		typeof res?.model === "string" &&
-		/// Together.ai does not output a system_fingerprint
-		(res.system_fingerprint === undefined || typeof res.system_fingerprint === "string") &&
+		/// Together.ai and Nebius do not output a system_fingerprint
+		(res.system_fingerprint === undefined ||
+			res.system_fingerprint === null ||
+			typeof res.system_fingerprint === "string") &&
 		typeof res?.usage === "object";
 
 	if (!isValidOutput) {
diff --git a/packages/inference/src/types.ts b/packages/inference/src/types.ts
@@ -7,26 +7,10 @@ export type ModelId = string;
 
 export interface Options {
 	/**
-	 * (Default: true) Boolean. If a request 503s and wait_for_model is set to false, the request will be retried with the same parameters but with wait_for_model set to true.
+	 * (Default: true) Boolean. If a request 503s, the request will be retried with the same parameters.
 	 */
 	retry_on_error?: boolean;
-	/**
-	 * (Default: true). Boolean. There is a cache layer on Inference API (serverless) to speedup requests we have already seen. Most models can use those results as is as models are deterministic (meaning the results will be the same anyway). However if you use a non deterministic model, you can set this parameter to prevent the caching mechanism from being used resulting in a real new query.
-	 */
-	use_cache?: boolean;
-	/**
-	 * (Default: false). Boolean. Do not load the model if it's not already available.
-	 */
-	dont_load_model?: boolean;
-	/**
-	 * (Default: false). Boolean to use GPU instead of CPU for inference (requires Startup plan at least).
-	 */
-	use_gpu?: boolean;
 
-	/**
-	 * (Default: false) Boolean. If the model is not ready, wait for it instead of receiving 503. It limits the number of requests required to get your inference done. It is advised to only set this flag to true after receiving a 503 error as it will limit hanging in your application to known places.
-	 */
-	wait_for_model?: boolean;
 	/**
 	 * Custom fetch function to use instead of the default one, for example to use a proxy or edit headers.
 	 */
@@ -47,6 +31,7 @@ export type InferenceTask = Exclude<PipelineType, "other">;
 export const INFERENCE_PROVIDERS = [
 	"fal-ai",
 	"fireworks-ai",
+	"nebius",
 	"hf-inference",
 	"replicate",
 	"sambanova",
diff --git a/packages/inference/test/HfInference.spec.ts b/packages/inference/test/HfInference.spec.ts
diff --git a/packages/inference/test/tapes.json b/packages/inference/test/tapes.json

-Original file line number
+Diff line change
 ```html
 <script type="module">
 -    import { HfInference } from 'https://cdn.jsdelivr.net/npm/@huggingface/[email protected].0/+esm';
 +    import { HfInference } from 'https://cdn.jsdelivr.net/npm/@huggingface/[email protected].3/+esm';
     import { createRepo, commit, deleteRepo, listFiles } from "https://cdn.jsdelivr.net/npm/@huggingface/[email protected]/+esm";
 </script>
 ```
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@huggingface/inference",`
`3`		`- "version": "3.3.0",`
	`3`	`+ "version": "3.3.3",`
`4`	`4`	`"packageManager": "[email protected]",`
`5`	`5`	`"license": "MIT",`
`6`	`6`	`"author": "Tim Mikeladze <[email protected]>",`