hf-cloud-sagemaker-production-defaults

name

hf-cloud-sagemaker-production-defaults

description

Create a SageMaker endpoint (real-time or async) with autoscaling, CloudWatch alarms, and tagging enabled by default. Use this skill whenever about to create a SageMaker endpoint, write deployment code that calls `create_endpoint`, or finalize a deployment after the image URI and IAM role are known. Provides deploy.py for real-time endpoints and deploy_async.py for async endpoints (with genuine scale-to-zero support). This is the last step in the SageMaker deployment workflow. Never generate a bare `create_endpoint` call without these defaults — endpoints without autoscaling or alarms are demos, not deployments.

SageMaker Production Defaults

The difference between a demo endpoint and one you can leave running is: it scales with traffic, it tells you when it breaks, and you can debug it later. This skill makes those three the default rather than optional extras.

By the time this skill runs, the planner has chosen a real-time endpoint, IAM has a usable role, and image-selection has resolved a container URI + AMI version. This skill turns those into an actual deployment.

What gets created

For every endpoint, the skill creates these as a unit:

1. SageMaker Model — image + env vars + execution role + S3 artifacts
2. Endpoint config — instance type, initial count, optional data capture
3. Endpoint — the real-time endpoint serving inference
4. Autoscaling target + policy — target tracking on invocations per instance
5. CloudWatch alarms — latency, errors, platform overhead

Data capture (logging requests/responses to S3) is off by default — useful for debugging but creates ongoing S3 costs the user didn't necessarily ask for. Enable with --enable-data-capture.

All resources get a consistent tag set including CreatedBy=agentic-deploy-skills for later cleanup.

Defaults and reasoning in references/deployment-template.md.

Running the deployment

For a text-generation LLM (vLLM):

python scripts/deploy.py \
    --model-name qwen3-medical \
    --image-uri "$IMAGE_URI" \
    --inference-ami-version "$AMI" \
    --role-arn "$ROLE_ARN" \
    --instance-type ml.g5.xlarge \
    --region "$REGION" \
    --env SM_VLLM_MODEL=Qwen/Qwen3-0.6B \
    --env SM_VLLM_HOST=0.0.0.0 \
    --env SM_VLLM_TRUST_REMOTE_CODE=true \
    --env SM_VLLM_MAX_MODEL_LEN=4096

For an embedding model (TEI, often on CPU):

python scripts/deploy.py \
    --model-name bge-large-embeddings \
    --image-uri "$IMAGE_URI" \
    --role-arn "$ROLE_ARN" \
    --instance-type ml.c6i.2xlarge \
    --region "$REGION" \
    --env HF_MODEL_ID=BAAI/bge-large-en-v1.5

Note: TEI deployments do not need --inference-ami-version. That flag is vLLM-specific. TEI env vars are also simpler (HF_MODEL_ID instead of SM_VLLM_*, no host or trust-remote-code to configure).

Where each value comes from:

Parameter	Source
--image-uri	hf-cloud-serving-image-selection — agent reads from the AWS DLC catalog page
--inference-ami-version	hf-cloud-serving-image-selection — required for vLLM tags containing cu130+
--role-arn	hf-cloud-sagemaker-iam-preflight (check_role.py)
--region	hf-cloud-aws-context-discovery
--instance-type	User input or planner recommendation
--env	Model-specific; see hf-cloud-serving-image-selection for required SM_VLLM_* vars
--model-s3-uri	Optional — S3 path to model artifacts; omit if loading from HF Hub

The script creates resources in order with error handling, waits for InService (up to 30 min), surfaces failure reasons, registers autoscaling and alarms, and prints a summary including the teardown command. Outputs a JSON blob on stdout with endpoint/config/model names for downstream scripting.

The scripts ship with this skill. If the installed copy is missing the scripts/ directory (some harnesses copy only SKILL.md on install), fetch them from the source repo rather than re-implementing them from this description.

Cold-start expectation: when the model loads from HF Hub, the download happens inside the container after the endpoint starts — 5–15+ minutes to InService is normal, not a failure. deploy.py waits 30 minutes; if you write custom wait code, don't time out at 15. Pre-staging weights in S3 (--model-s3-uri) cuts this and removes the Hub dependency.

InService is not success — smoke-test before declaring victory

InService only means the container answered /ping. In MMS-based containers (HF Inference Toolkit) the Java front-end answers pings even while the Python worker crash-loops — an endpoint can be InService and serve nothing. Two checks, always:

1. One real invocation.

   • Real-time: invoke_endpoint.py (below) with a minimal payload; require an HTTP 200 with a sane body.
   • Async: upload one input to S3, call invoke-endpoint-async, poll the output URI for a few minutes (see "Invoking async endpoints"). A result object = success; an object at the failure URI, or nothing appearing, = broken.

2. Scan the endpoint logs for worker-crash markers — catches the crash-loop case even when the smoke request merely times out:

   aws logs filter-log-events \
       --log-group-name /aws/sagemaker/Endpoints/<endpoint-name> \
       --filter-pattern '?"Worker died" ?"Load model failed" ?"ImportError"' \
       --region <region> --max-items 5
   

Only report the deployment complete after both pass. If the log scan hits, surface the actual traceback from CloudWatch — not the InService status.

Testing a real-time endpoint

Once the endpoint is InService, test it with the bundled helper. It is cross-platform and BOM-safe — use it instead of hand-writing a payload file and calling invoke-endpoint directly:

# macOS / Linux
python3 scripts/invoke_endpoint.py \
    --endpoint-name <endpoint-name> \
    --payload '{"inputs": "Hello"}' \
    --region "$REGION"

# Windows (PowerShell)
python scripts\invoke_endpoint.py `
    --endpoint-name <endpoint-name> `
    --payload-file payload.json `
    --region $REGION

It accepts either --payload '<json>' (inline) or --payload-file <path>, validates JSON, writes the request body as plain UTF-8, invokes the endpoint, and prints the response body to stdout.

The UTF-8 BOM gotcha (Windows)

If you write the request payload yourself on Windows, do not use Set-Content -Encoding UTF8 — depending on the PowerShell version it prepends a UTF-8 byte-order mark (BOM). SageMaker's JSON parser rejects a BOM with a 400 ModelError:

Unexpected UTF-8 BOM (decode using utf-8-sig): line 1 column 1 (char 0)

This is not a model, endpoint-health, or image problem — only the file encoding of the request body. invoke_endpoint.py avoids it entirely (it even strips a BOM from a --payload-file that already has one). If you must call the CLI directly, write the body as BOM-free UTF-8:

# BOM-free UTF-8 — use this
[System.IO.File]::WriteAllText((Resolve-Path "payload.json"), $json, [System.Text.UTF8Encoding]::new($false))

aws sagemaker-runtime invoke-endpoint `
    --endpoint-name <endpoint-name> `
    --content-type application/json `
    --body fileb://payload.json `
    --region $REGION `
    response.json

Fallback: if any invocation fails with Unexpected UTF-8 BOM, rewrite the payload as BOM-free UTF-8 (or re-run via invoke_endpoint.py) and retry once before treating the endpoint or model as broken.

Invoking a generative reranker (vLLM)

Generative rerankers (Qwen3-Reranker etc. — routed to the HuggingFace vLLM DLC by hf-cloud-serving-image-selection) are causal LMs scored by their first generated token, not chat models. Use the completions API with a raw prompt, not the messages/chat API: chat templating does not reliably honor chat_template_kwargs such as {"enable_thinking": false}, and a wrong template silently returns near-identical scores for every query–document pair instead of erroring.

Payload shape (Qwen3-Reranker's expected format — substitute {query} / {document}):

{
  "prompt": "<|im_start|>system\nJudge whether the Document meets the requirements based on the Query and the Instruct provided. Note that the answer can only be \"yes\" or \"no\".<|im_end|>\n<|im_start|>user\n<Instruct>: Given a web search query, retrieve relevant passages that answer the query\n<Query>: {query}\n<Document>: {document}<|im_end|>\n<|im_start|>assistant\n<think>\n\n</think>\n\n",
  "max_tokens": 1,
  "temperature": 0,
  "logprobs": 20
}

The trailing <|im_start|>assistant\n<think>\n\n</think>\n\n suffix is load-bearing: it pre-fills an empty thinking block so the first generated token is the yes/no judgment. Score from the returned logprobs: P("yes") / (P("yes") + P("no")). Sanity check the endpoint with one relevant pair (expect >0.9) and one irrelevant pair (expect <0.05) — near-identical scores across pairs mean the prompt template is wrong, not that the model is broken.

The same rule generalizes: for any thinking-mode model where the prompt must be byte-exact, prefer the raw completions API over chat.

Picking the image URI

The agent reads the image URI from AWS's Deep Learning Containers catalog — pick the row that matches the model family (HuggingFace vLLM for LLMs, TEI for embeddings, etc.), substitute <region> with the deployment region, and pass to deploy.py --image-uri.

For vLLM images specifically (both huggingface-vllm and the AWS vllm fallback), also check the tag's CUDA version:

# Example: HuggingFace vLLM 0.21.0 from the catalog
IMAGE_URI="763104351884.dkr.ecr.eu-west-1.amazonaws.com/huggingface-vllm:0.21.0-transformers5.8.1-gpu-py312-cu130-ubuntu22.04"

# cu130 tag → must pass --inference-ami-version
python deploy.py --image-uri "$IMAGE_URI" \
    --inference-ami-version al2-ami-sagemaker-inference-gpu-3-1 \
    ...

For tags with cu129 or lower, omit --inference-ami-version. See hf-cloud-serving-image-selection for the full vLLM AMI lookup table and the env-var requirements for each image family.

Async inference deployments

For long-running inferences (>60s), large payloads, or workloads that are bursty/sparse enough to benefit from scale-to-zero, use deploy_async.py instead of deploy.py. Async genuinely supports MinCapacity=0 — real-time autoscaling can't.

python scripts/deploy_async.py \
    --model-name flux-text-to-image \
    --image-uri "$IMAGE_URI" \
    --role-arn "$ROLE_ARN" \
    --instance-type ml.g5.2xlarge \
    --region "$REGION" \
    --output-s3-uri s3://my-bucket/async-output/ \
    --env HF_MODEL_ID=black-forest-labs/FLUX.1-dev

Required extras over deploy.py:

• --output-s3-uri — where async results land (results are not returned synchronously)

Optional async-specific flags:

• --failure-s3-uri — separate path for failed invocations
• --success-sns-topic, --error-sns-topic — get notified when async results are ready or fail
• --min-capacity 0 (the default) — scale to zero between batches
• --backlog-per-instance-target N — target queue depth per instance (default 5)
• --max-concurrent-invocations-per-instance N — default 4

How scale-to-zero works

The async script registers two autoscaling policies on the variant:

1. Target-tracking on ApproximateBacklogSizePerInstance — handles ongoing scaling between min and max
2. Step-scaling triggered by a HasBacklogWithoutCapacity CloudWatch alarm — handles 0→1 wake-from-zero

Both are needed. Target-tracking alone cannot transition from zero (it can't divide by zero instances), so without the step policy the endpoint comes up, scales to zero after the first batch, and never wakes again. The script wires this up automatically.

Async alarms

The script creates three CloudWatch alarms:

• ApproximateBacklogSize > 50 — queue is building faster than capacity can drain it
• InvocationsFailed > 5 — repeated processing failures
• HasBacklogWithoutCapacity — drives the wake-from-zero policy (not a notification alarm; its action is the step-scaling policy, not the SNS topic)

If you pass --sns-alarm-topic <arn>, the first two notify on that topic. The wake alarm always points at the step policy.

Invoking async endpoints

Async endpoints aren't called synchronously. You upload the input to S3, call invoke-endpoint-async with the S3 input location, and SageMaker writes the result to your --output-s3-uri when done:

# Upload your input first
aws s3 cp input.json s3://my-input-bucket/job1/input.json

# Invoke
aws sagemaker-runtime invoke-endpoint-async \
    --endpoint-name <endpoint-name> \
    --input-location s3://my-input-bucket/job1/input.json \
    --content-type application/json \
    --region <region>

# Poll for the result at your output URI
aws s3 cp s3://my-bucket/async-output/<inference-id>.out result.json

The same UTF-8 BOM caveat applies to the input.json you upload (see "The UTF-8 BOM gotcha" above) — if you build it on Windows, write it as BOM-free UTF-8 or the container's JSON parser will reject it.

Teardown works the same as real-time: python3 scripts/teardown.py <endpoint-name> (the teardown script discovers policies and alarms by name prefix, so it handles both deployment modes).

Defaults at a glance

Setting	Default	Override
Initial instance count	1	--initial-instance-count
Autoscaling min / max	1 / 4	--min-capacity, --max-capacity
Autoscaling target	20 invocations/min/instance	--target-invocations-per-instance
Data capture	disabled (opt-in)	--enable-data-capture
CloudWatch alarms	3 alarms	--no-alarms
SNS notification	none (alarms created but won't notify)	--sns-alarm-topic <arn>
Environment tag	dev	--environment
InferenceAmiVersion	none (SageMaker default)	--inference-ami-version (REQUIRED for vLLM CUDA 13+)

Not defaulted (user-specific input needed): VPC config, KMS key, multi-variant, async inference.

Autoscaling target — tune by model type

The default --target-invocations-per-instance 20 is conservative and tuned for LLM workloads where each request takes 1–5 seconds. For embedding deployments (TEI), each request is much faster (typically <100ms on CPU, <20ms on GPU), so a single instance can handle far more throughput. For embedding deployments, raise the target to 100–500 depending on instance and model size. The default of 20 will trigger autoscaling far too aggressively for embeddings and waste money.

A rule of thumb: target value ≈ 60 / (typical request latency in seconds). LLM at 3s latency → target 20. Embedding at 100ms → target 600. Generative rerankers sit in between — they generate a single token per request, so ~40–100 is a reasonable target.

Data capture + IAM gotcha

If the user enables data capture, the execution role needs S3 write access to the capture prefix. The default URI (s3://sagemaker-<region>-<account>/<endpoint>/data-capture/) is typically a different bucket than the model artifact bucket. If hf-cloud-sagemaker-iam-preflight scoped the inline policy narrowly to just the model bucket, capture writes fail silently — endpoint keeps serving but no data appears.

If the user reports "data capture isn't showing up", check the role's S3 access. Either widen the inline policy or pass --data-capture-s3-uri pointing to a bucket the role can write.

Teardown

python3 scripts/teardown.py <endpoint-name> <region>   # macOS / Linux
python  scripts\teardown.py <endpoint-name> <region>   # Windows

Deletes in safe order: alarms → autoscaling → endpoint (stops billing) → endpoint config → model. Idempotent.

Does not delete: the IAM execution role (might be shared), data capture S3 objects (user might want to keep), SNS topic, original model artifacts.

Always tell the user about the teardown command after the deployment summary. Users forget; endpoints accrue cost.

When the deployment fails

CannotStartContainerError + no CloudWatch logs ever created — the InferenceAmiVersion problem. If the image tag contains cu130 or later and you didn't pass --inference-ami-version al2-ami-sagemaker-inference-gpu-3-1, this is the cause. See hf-cloud-serving-image-selection. Do NOT chase images, IAM roles, env vars, or instance types — the failure signature is identical for many other things but the cause here is the AMI.

"Failed to pass ping health check" — the container did start and produced logs, but /ping isn't responding. Check CloudWatch at /aws/sagemaker/Endpoints/<endpoint-name>. Usually: wrong image for model architecture, missing HF token, or OOM.

"Container failed to start" (with logs present) — entrypoint ran, then exited. Check CloudWatch. Common: missing required env vars (SM_VLLM_MODEL, SM_VLLM_HOST, SM_VLLM_TRUST_REMOTE_CODE), wrong ModelDataUrl format, unreadable model artifacts.

ResourceLimitExceeded — no quota for the instance type in this region. Request increase or pick a different type (the planner should have checked quotas up front — see hf-cloud-sagemaker-deployment-planner).

ImportError: libtorch_cuda.so: undefined symbol: ncclCommResume in CloudWatch logs — known packaging defect in huggingface-pytorch-inference GPU images (see "Known-broken images" in hf-cloud-serving-image-selection). Inside the container, so no env var, AMI, instance type, or sibling tag fixes it. Switch to DJL Inference.

InService, but invocations time out / async outputs never appear — dead Python worker behind a live MMS front-end. Run the log scan from "InService is not success" above; the traceback in CloudWatch is the real error.

403 Forbidden downloading weights from HF Hub during startup — the container's bundled huggingface_hub predates HF's XET CDN auth. Add --env HF_HUB_ENABLE_HF_TRANSFER=0, or pre-stage the weights in S3. Note: this can mask a deeper failure (the worker may still crash after the download succeeds) — re-check logs after fixing it.

Diagnostic rule: when failures look identical across multiple configurations (different images, roles, instance types) and no logs are ever produced, the cause is almost always below the container — host AMI, networking, account-level — not the deployment config. Stop iterating on config; check the AMI version and account state.

Don't retry blindly. The script prints the specific FailureReason from describe-endpoint — fix the root cause before retrying.