llama-stack-mirror/docs/source/providers/inference/remote_hf_endpoint.md
Sébastien Han c9a49a80e8
docs: auto generated documentation for providers (#2543)
# What does this PR do?

Simple approach to get some provider pages in the docs.

Add or update description fields in the provider configuration class
using Pydantic’s Field, ensuring these descriptions are clear and
complete, as they will be used to auto-generate provider documentation
via ./scripts/distro_codegen.py instead of editing the docs manually.

Signed-off-by: Sébastien Han <seb@redhat.com>
2025-06-30 15:13:20 +02:00

792 B

remote::hf::endpoint

Description

HuggingFace Inference Endpoints provider for dedicated model serving.

Configuration

Field Type Required Default Description
endpoint_name <class 'str'> No PydanticUndefined The name of the Hugging Face Inference Endpoint in the format of '{namespace}/{endpoint_name}' (e.g. 'my-cool-org/meta-llama-3-1-8b-instruct-rce'). Namespace is optional and will default to the user account if not provided.
api_token pydantic.types.SecretStr | None No Your Hugging Face user access token (will default to locally saved token if not provided)

Sample Configuration

endpoint_name: ${env.INFERENCE_ENDPOINT_NAME}
api_token: ${env.HF_API_TOKEN}