Buckets:

hf-doc-build
/

doc-dev

Files

xet

hf-doc-build/doc-dev / inference-endpoints /pr_113 /en /guides /create_endpoint.html

rtrm

about 1 month ago

download

raw

18.1 kB

	<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{"title":"Create an Endpoint","local":"create-an-endpoint","sections":[{"title":"1. Enter the Hugging Face Repository ID and your desired Endpoint name","local":"1-enter-the-hugging-face-repository-id-and-your-desired-endpoint-name","sections":[],"depth":2},{"title":"2. Select your Instance Configuration","local":"2-select-your-instance-configuration","sections":[],"depth":2},{"title":"3. Apply Automatic Scale-to-Zero","local":"3-apply-automatic-scale-to-zero","sections":[],"depth":2},{"title":"4. Define the Security Level for the Endpoint","local":"4-define-the-security-level-for-the-endpoint","sections":[],"depth":2},{"title":"5. Customize your Endpoint","local":"5-customize-your-endpoint","sections":[],"depth":2},{"title":"6. Create your Endpoint","local":"6-create-your-endpoint","sections":[],"depth":2},{"title":"7. Wait for the Endpoint to build, initialize and run","local":"7-wait-for-the-endpoint-to-build-initialize-and-run","sections":[],"depth":2},{"title":"8. Test your Endpoint 🎉","local":"8-test-your-endpoint-","sections":[],"depth":2}],"depth":1}">
	<link href="/docs/inference-endpoints/pr_113/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
	<link rel="modulepreload" href="/docs/inference-endpoints/pr_113/en/_app/immutable/entry/start.d1c14968.js">
	<link rel="modulepreload" href="/docs/inference-endpoints/pr_113/en/_app/immutable/chunks/scheduler.389d799c.js">
	<link rel="modulepreload" href="/docs/inference-endpoints/pr_113/en/_app/immutable/chunks/singletons.16c9b508.js">
	<link rel="modulepreload" href="/docs/inference-endpoints/pr_113/en/_app/immutable/chunks/paths.58d119e0.js">
	<link rel="modulepreload" href="/docs/inference-endpoints/pr_113/en/_app/immutable/entry/app.18050d92.js">
	<link rel="modulepreload" href="/docs/inference-endpoints/pr_113/en/_app/immutable/chunks/index.8f81d18f.js">
	<link rel="modulepreload" href="/docs/inference-endpoints/pr_113/en/_app/immutable/nodes/0.ce016c16.js">
	<link rel="modulepreload" href="/docs/inference-endpoints/pr_113/en/_app/immutable/nodes/8.994529fa.js">
	<link rel="modulepreload" href="/docs/inference-endpoints/pr_113/en/_app/immutable/chunks/getInferenceSnippets.8efa8e08.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{"title":"Create an Endpoint","local":"create-an-endpoint","sections":[{"title":"1. Enter the Hugging Face Repository ID and your desired Endpoint name","local":"1-enter-the-hugging-face-repository-id-and-your-desired-endpoint-name","sections":[],"depth":2},{"title":"2. Select your Instance Configuration","local":"2-select-your-instance-configuration","sections":[],"depth":2},{"title":"3. Apply Automatic Scale-to-Zero","local":"3-apply-automatic-scale-to-zero","sections":[],"depth":2},{"title":"4. Define the Security Level for the Endpoint","local":"4-define-the-security-level-for-the-endpoint","sections":[],"depth":2},{"title":"5. Customize your Endpoint","local":"5-customize-your-endpoint","sections":[],"depth":2},{"title":"6. Create your Endpoint","local":"6-create-your-endpoint","sections":[],"depth":2},{"title":"7. Wait for the Endpoint to build, initialize and run","local":"7-wait-for-the-endpoint-to-build-initialize-and-run","sections":[],"depth":2},{"title":"8. Test your Endpoint 🎉","local":"8-test-your-endpoint-","sections":[],"depth":2}],"depth":1}"><!-- HEAD_svelte-u9bgzb_END --> <p></p> <h1 class="relative group"><a id="create-an-endpoint" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#create-an-endpoint"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Create an Endpoint</span></h1> <p data-svelte-h="svelte-10bn6ql">After your first login, you will be directed to the <a href="https://ui.endpoints.huggingface.co/new" rel="nofollow">Endpoint creation page</a>. As an example, this guide will go through the steps to deploy <a href="https://huggingface.co/distilbert/distilbert-base-uncased-finetuned-sst-2-english" rel="nofollow">distilbert/distilbert-base-uncased-finetuned-sst-2-english</a> for text classification.</p> <h2 class="relative group"><a id="1-enter-the-hugging-face-repository-id-and-your-desired-endpoint-name" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#1-enter-the-hugging-face-repository-id-and-your-desired-endpoint-name"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>1. Enter the Hugging Face Repository ID and your desired Endpoint name</span></h2> <img src="https://raw.githubusercontent.com/huggingface/hf-endpoints-documentation/main/assets/CreateEndpoint.png" alt="Create"> <h2 class="relative group"><a id="2-select-your-instance-configuration" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#2-select-your-instance-configuration"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>2. Select your Instance Configuration</span></h2> <p data-svelte-h="svelte-1554qf0">Choose cloud provider, region, and instance type. If you’re looking for a specific cloud provider, region, or instance that you don’t yet see available, please let us know.</p> <img src="https://raw.githubusercontent.com/huggingface/hf-endpoints-documentation/main/assets/InstanceConfiguration.png" alt="select region"> <h2 class="relative group"><a id="3-apply-automatic-scale-to-zero" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#3-apply-automatic-scale-to-zero"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>3. Apply Automatic Scale-to-Zero</span></h2> <p data-svelte-h="svelte-1qy1l8o">Or leave your Endpoint as is.</p> <img src="https://raw.githubusercontent.com/huggingface/hf-endpoints-documentation/main/assets/Scale-to-Zero.png" alt="autoscaling"> <h2 class="relative group"><a id="4-define-the-security-level-for-the-endpoint" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#4-define-the-security-level-for-the-endpoint"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>4. Define the Security Level for the Endpoint</span></h2> <img src="https://raw.githubusercontent.com/huggingface/hf-endpoints-documentation/main/assets/SecurityLevel.png" alt="define security"> <h2 class="relative group"><a id="5-customize-your-endpoint" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#5-customize-your-endpoint"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>5. Customize your Endpoint</span></h2> <p data-svelte-h="svelte-tr5gct">Feel free to customize your Endpoint further in Advanced Configuration: replica autoscaling, task, revision, framework, and container type are accessible in this section.</p> <img src="https://raw.githubusercontent.com/huggingface/hf-endpoints-documentation/main/assets/AdvancedConfigs.png" alt="advanced configuration"> <h2 class="relative group"><a id="6-create-your-endpoint" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#6-create-your-endpoint"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>6. Create your Endpoint</span></h2> <p data-svelte-h="svelte-1nd2r7k">By clicking <strong>Create Endpoint</strong>. The cost estimate displayed is per hour and does not take autoscaling into account.</p> <img src="https://raw.githubusercontent.com/huggingface/hf-endpoints-documentation/main/assets/Create+Cost.png" alt="create endpoint"> <h2 class="relative group"><a id="7-wait-for-the-endpoint-to-build-initialize-and-run" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#7-wait-for-the-endpoint-to-build-initialize-and-run"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>7. Wait for the Endpoint to build, initialize and run</span></h2> <p data-svelte-h="svelte-1agqjf6">Note that initializing time depends on the model size and typically takes between 1 to 5 minutes.</p> <img src="https://raw.githubusercontent.com/huggingface/hf-endpoints-documentation/main/assets/RunningEndpoint.png" alt="running"> <h2 class="relative group"><a id="8-test-your-endpoint-" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#8-test-your-endpoint-"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>8. Test your Endpoint 🎉</span></h2> <p data-svelte-h="svelte-1r7u5xl">This is possible in your Endpoint Overview utilizing Playground 🏁 !</p> <img src="https://raw.githubusercontent.com/huggingface/hf-endpoints-documentation/main/assets/TestEndpoint.png" alt="playground"> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/hf-endpoints-documentation/blob/main/docs/source/guides/create_endpoint.mdx" target="_blank"><span data-svelte-h="svelte-1kd6by1"><</span> <span data-svelte-h="svelte-x0xyl0">></span> <span data-svelte-h="svelte-1dajgef"><span class="underline ml-1.5">Update</span> on GitHub</span></a> <p></p>

	<script>
	{
	__sveltekit_87vzq7 = {
	assets: "/docs/inference-endpoints/pr_113/en",
	base: "/docs/inference-endpoints/pr_113/en",
	env: {}
	};

	const element = document.currentScript.parentElement;

	const data = [null,null];

	Promise.all([
	import("/docs/inference-endpoints/pr_113/en/_app/immutable/entry/start.d1c14968.js"),
	import("/docs/inference-endpoints/pr_113/en/_app/immutable/entry/app.18050d92.js")
	]).then(([kit, app]) => {
	kit.start(app, element, {
	node_ids: [0, 8],
	data,
	form: null,
	error: null
	});
	});
	}
	</script>

Xet Storage Details

Size:: 18.1 kB
Xet hash:: 92f2c6e8edf041ac5a1ae70678cbc16bf911e647c0752b240038eb117a4d878e

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.