Buckets:

hf-doc-build
/

doc-dev

Files

xet

hf-doc-build/doc-dev / sagemaker /pr_1995 /en /tutorials /bedrock /bedrock-quickstart.html

rtrm

about 1 month ago

download

raw

21.1 kB

	<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{"title":"Quickstart — Using Hugging Face Models with Amazon Bedrock Marketplace","local":"quickstart--using-hugging-face-models-with-amazon-bedrock-marketplace","sections":[{"title":"Why use Bedrock Marketplace for Hugging Face models?","local":"why-use-bedrock-marketplace-for-hugging-face-models","sections":[],"depth":2},{"title":"1 . Prerequisites","local":"1--prerequisites","sections":[],"depth":2},{"title":"2. Endpoint deployment","local":"2-endpoint-deployment","sections":[],"depth":2},{"title":"3 . Test interactively","local":"3--test-interactively","sections":[],"depth":2},{"title":"4 . Clean‑up (stop charges)","local":"4--cleanup-stop-charges","sections":[],"depth":2}],"depth":1}">
	<link href="/docs/sagemaker/pr_1995/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
	<link rel="modulepreload" href="/docs/sagemaker/pr_1995/en/_app/immutable/entry/start.c99dd462.js">
	<link rel="modulepreload" href="/docs/sagemaker/pr_1995/en/_app/immutable/chunks/scheduler.aec39e6a.js">
	<link rel="modulepreload" href="/docs/sagemaker/pr_1995/en/_app/immutable/chunks/singletons.3bc577c3.js">
	<link rel="modulepreload" href="/docs/sagemaker/pr_1995/en/_app/immutable/chunks/paths.12b7f279.js">
	<link rel="modulepreload" href="/docs/sagemaker/pr_1995/en/_app/immutable/entry/app.cd901cb4.js">
	<link rel="modulepreload" href="/docs/sagemaker/pr_1995/en/_app/immutable/chunks/preload-helper.73d9078d.js">
	<link rel="modulepreload" href="/docs/sagemaker/pr_1995/en/_app/immutable/chunks/index.4ee0a2d0.js">
	<link rel="modulepreload" href="/docs/sagemaker/pr_1995/en/_app/immutable/nodes/0.381271ed.js">
	<link rel="modulepreload" href="/docs/sagemaker/pr_1995/en/_app/immutable/chunks/each.e59479a4.js">
	<link rel="modulepreload" href="/docs/sagemaker/pr_1995/en/_app/immutable/nodes/11.c6f3d844.js">
	<link rel="modulepreload" href="/docs/sagemaker/pr_1995/en/_app/immutable/chunks/MermaidChart.svelte_svelte_type_style_lang.8184f5a3.js">
	<link rel="modulepreload" href="/docs/sagemaker/pr_1995/en/_app/immutable/chunks/CodeBlock.db6247f1.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{"title":"Quickstart — Using Hugging Face Models with Amazon Bedrock Marketplace","local":"quickstart--using-hugging-face-models-with-amazon-bedrock-marketplace","sections":[{"title":"Why use Bedrock Marketplace for Hugging Face models?","local":"why-use-bedrock-marketplace-for-hugging-face-models","sections":[],"depth":2},{"title":"1 . Prerequisites","local":"1--prerequisites","sections":[],"depth":2},{"title":"2. Endpoint deployment","local":"2-endpoint-deployment","sections":[],"depth":2},{"title":"3 . Test interactively","local":"3--test-interactively","sections":[],"depth":2},{"title":"4 . Clean‑up (stop charges)","local":"4--cleanup-stop-charges","sections":[],"depth":2}],"depth":1}"><!-- HEAD_svelte-u9bgzb_END --> <p></p> <div class="items-center shrink-0 min-w-[100px] max-sm:min-w-[50px] justify-end ml-auto flex" style="float: right; margin-left: 10px; display: inline-flex; position: relative; z-index: 10;"><div class="inline-flex rounded-md max-sm:rounded-sm"><button class="inline-flex items-center gap-1 max-sm:gap-0.5 h-6 max-sm:h-5 px-2 max-sm:px-1.5 text-[11px] max-sm:text-[9px] font-medium text-gray-800 border border-r-0 rounded-l-md max-sm:rounded-l-sm border-gray-200 bg-white hover:shadow-inner dark:border-gray-850 dark:bg-gray-950 dark:text-gray-200 dark:hover:bg-gray-800" aria-live="polite"><span class="inline-flex items-center justify-center rounded-md p-0.5 max-sm:p-0"><svg class="w-3 h-3 max-sm:w-2.5 max-sm:h-2.5" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg></span> <span>Copy page</span></button> <button class="inline-flex items-center justify-center w-6 max-sm:w-5 h-6 max-sm:h-5 disabled:pointer-events-none text-sm text-gray-500 hover:text-gray-700 dark:hover:text-white rounded-r-md max-sm:rounded-r-sm border border-l transition border-gray-200 bg-white hover:shadow-inner dark:border-gray-850 dark:bg-gray-950 dark:text-gray-200 dark:hover:bg-gray-800" aria-haspopup="menu" aria-expanded="false" aria-label="Open copy menu"><svg class="transition-transform text-gray-400 overflow-visible w-3 h-3 max-sm:w-2.5 max-sm:h-2.5 rotate-0" width="1em" height="1em" viewBox="0 0 12 7" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1 1L6 6L11 1" stroke="currentColor"></path></svg></button></div> </div> <h1 class="relative group"><a id="quickstart--using-hugging-face-models-with-amazon-bedrock-marketplace" 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="#quickstart--using-hugging-face-models-with-amazon-bedrock-marketplace"><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>Quickstart — Using Hugging Face Models with Amazon Bedrock Marketplace</span></h1> <h2 class="relative group"><a id="why-use-bedrock-marketplace-for-hugging-face-models" 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="#why-use-bedrock-marketplace-for-hugging-face-models"><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>Why use Bedrock Marketplace for Hugging Face models?</span></h2> <p data-svelte-h="svelte-1vqh3ae">Amazon Bedrock now exposes Hugging Face open-weight models—including Gemma, Llama 3, Mistral, and more—through a single catalog. You invoke them with the same Bedrock APIs you already use for Titan, Anthropic, Cohere, etc. Under the hood, Bedrock Marketplace model endpoints are managed by Amazon SageMaker AI. With Bedrock Marketplace, you can now combine the ease of use of SageMaker JumpStart with the fully managed infrastructure of Amazon Bedrock, including compatibility with high-level APIs such as Agents, Knowledge Bases, Guardrails and Model Evaluations.</p> <h2 class="relative group"><a id="1--prerequisites" 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--prerequisites"><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 . Prerequisites</span></h2> <table data-svelte-h="svelte-m8x058"><thead><tr><th> </th> <th>Requirement</th></tr></thead> <tbody><tr><td>AWS account in a Bedrock Region</td> <td>Marketplace is regional; switch the console to one of the 14 supported Regions first, for example <code>us-east-1</code>.</td></tr> <tr><td>Permissions</td> <td>For a quick trial, attach <code>AmazonBedrockFullAccess</code> and <code>AmazonSageMakerFullAccess</code>.</td></tr> <tr><td>Service quotas</td> <td>The SageMaker endpoint uses GPU instances (for example ml.g5). Verify you have quota or request it.</td></tr> <tr><td>JumpStart-only</td> <td>If you choose path B, create a SageMaker Studio domain and user profile first (Console ▸ SageMaker ▸ Domains). Open Studio before continuing.</td></tr></tbody></table> <p data-svelte-h="svelte-6ggu3r">When registering your Sagemaker Jumpstart endpoints in Amazon Bedrock, you only pay for the SageMaker compute resources and regular Amazon Bedrock APIs prices are applicable.</p> <h2 class="relative group"><a id="2-endpoint-deployment" 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-endpoint-deployment"><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. Endpoint deployment</span></h2> <p data-svelte-h="svelte-oe95c9">There are two equivalent paths to use a Hugging Face model with Amazon Bedrock Marketplace.</p> <p data-svelte-h="svelte-1yhy6w8">Path A is from the Bedrock <em>Model Catalog</em>:</p> <ol data-svelte-h="svelte-kvtpq2"><li>Console → Amazon Bedrock → Foundation Models → Model catalog</li> <li>Filter Provider → “Hugging Face”, then pick your model (e.g., Gemma 2 27B Instruct)</li> <li>If you see Subscribe, review pricing & terms, click Subscribe, then continue</li> <li>Click Deploy → name the endpoint → keep the recommended instance → accept the EULA → Deploy</li> <li>Wait for Foundation Models → Marketplace deployments to show status In service (takes a few minutes)</li> <li>Click the deployment name and copy the SageMaker endpoint ARN — you’ll need it for API calls</li></ol> <img src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/sagemaker/bedrock-marketplace-deployment.gif" alt="Bedrock deployment demo" width="500"> <p data-svelte-h="svelte-1vbvwx3">Path B is from SageMaker JumpStart for the model that shows “Use with Bedrock”:</p> <ol data-svelte-h="svelte-1lnrw9"><li>In SageMaker Studio, open JumpStart</li> <li>Filter Bedrock Ready models → select the model card (e.g., Gemma 2 9B Instruct)</li> <li>Click Deploy, accept the EULA, keep defaults, Deploy</li> <li>Studio → Deployments → Endpoints → wait for status In service</li> <li>Click the endpoint, choose Use with Bedrock</li> <li>In the Bedrock console, review and Register → a new entry appears under Marketplace deployments</li> <li>Open that entry and copy the SageMaker endpoint ARN for code samples</li></ol> <h2 class="relative group"><a id="3--test-interactively" 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--test-interactively"><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 . Test interactively</span></h2> <p data-svelte-h="svelte-3fcc6r">To test the model interactively in the console, select the model under Marketplace deployments, open it in the playground, and send a prompt in Chat/Text mode to verify the model’s response.</p> <p data-svelte-h="svelte-199kuj">Alternatively, you can programmatically access your endpoint.</p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg class="" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><!-- HTML_TAG_START --><span class="hljs-keyword">import</span> boto3

	bedrock = boto3.client(<span class="hljs-string">"bedrock-runtime"</span>)

	<span class="hljs-comment"># Paste the endpoint ARN you copied above</span>
	endpoint_arn = <span class="hljs-string">"arn:aws:sagemaker:<region>:<account‑id>:endpoint/<name>"</span>

	inference_cfg = {<span class="hljs-string">"maxTokens"</span>: <span class="hljs-number">256</span>, <span class="hljs-string">"temperature"</span>: <span class="hljs-number">0.1</span>, <span class="hljs-string">"topP"</span>: <span class="hljs-number">0.95</span>}
	extra = {<span class="hljs-string">"parameters"</span>: {<span class="hljs-string">"repetition_penalty"</span>: <span class="hljs-number">1.05</span>}}

	response = bedrock.converse(
	modelId=endpoint_arn, <span class="hljs-comment"># <- SageMaker endpoint ARN</span>
	messages=[{
	<span class="hljs-string">"role"</span>: <span class="hljs-string">"user"</span>,
	<span class="hljs-string">"content"</span>: [{<span class="hljs-string">"text"</span>: <span class="hljs-string">"Give me three taglines for a serverless AI startup"</span>}]
	}],
	inferenceConfig=inference_cfg,
	additionalModelRequestFields=extra,
	)

	<span class="hljs-built_in">print</span>(response[<span class="hljs-string">"output"</span>][<span class="hljs-string">"message"</span>][<span class="hljs-string">"content"</span>][<span class="hljs-number">0</span>][<span class="hljs-string">"text"</span>])<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-e0gjs0"><em>Heads‑up</em>: the same <code>modelId=endpoint_arn</code> works with <strong>InvokeModel</strong>, <strong>Knowledge Bases (RetrieveAndGenerate)</strong>, <strong>Agents</strong>, and <strong>Guardrails</strong>—no code changes.</p> <h2 class="relative group"><a id="4--cleanup-stop-charges" 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--cleanup-stop-charges"><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 . Clean‑up (stop charges)</span></h2> <table data-svelte-h="svelte-1cem8df"><thead><tr><th>Resource</th> <th>How to delete</th></tr></thead> <tbody><tr><td>SageMaker endpoint</td> <td>Console → Marketplace deployments → select → Delete (also de‑registers it) • <em>or</em> <code>boto3.client("sagemaker").delete_endpoint(...)</code></td></tr> <tr><td>Optional extras</td> <td>Delete Knowledge Base, Guardrail, or S3 vectors if you created them.</td></tr></tbody></table> <p data-svelte-h="svelte-1m2nl00">For more information, refer to the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-bedrock.html" rel="nofollow">Bedrock documentation</a>.</p> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/hub-docs/blob/main/docs/sagemaker/source/tutorials/bedrock/bedrock-quickstart.md" target="_blank"><svg class="mr-1" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M31,16l-7,7l-1.41-1.41L28.17,16l-5.58-5.59L24,9l7,7z"></path><path d="M1,16l7-7l1.41,1.41L3.83,16l5.58,5.59L8,23l-7-7z"></path><path d="M12.419,25.484L17.639,6.552l1.932,0.518L14.351,26.002z"></path></svg> <span data-svelte-h="svelte-zjs2n5"><span class="underline">Update</span> on GitHub</span></a> <p></p>

	<script>
	{
	__sveltekit_16nm56f = {
	assets: "/docs/sagemaker/pr_1995/en",
	base: "/docs/sagemaker/pr_1995/en",
	env: {}
	};

	const element = document.currentScript.parentElement;

	const data = [null,null];

	Promise.all([
	import("/docs/sagemaker/pr_1995/en/_app/immutable/entry/start.c99dd462.js"),
	import("/docs/sagemaker/pr_1995/en/_app/immutable/entry/app.cd901cb4.js")
	]).then(([kit, app]) => {
	kit.start(app, element, {
	node_ids: [0, 11],
	data,
	form: null,
	error: null
	});
	});
	}
	</script>

Xet Storage Details

Size:: 21.1 kB
Xet hash:: 0dd6d0d4db81c6dea37a2b32de27b61325bdb0d7868a96df7e551529d22f55ba

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