flytekitplugins.inference.nim.serve
class NIM(
secrets: flytekitplugins.inference.nim.serve.NIMSecrets,
image: str = 'nvcr.io/nim/meta/llama3-8b-instruct:1.0.0',
health_endpoint: str = 'v1/health/ready',
port: int = 8000,
cpu: int = 1,
gpu: int = 1,
mem: str = '20Gi',
ephemeral_storage: str = '20Gi',
shm_size: str = '16Gi',
env: typing.Optional[dict[str, str]] = None,
hf_repo_ids: typing.Optional[list[str]] = None,
lora_adapter_mem: typing.Optional[str] = None,
)
Initialize NIM class for managing a Kubernetes pod template.
| Parameter |
Type |
Description |
secrets |
flytekitplugins.inference.nim.serve.NIMSecrets |
Instance of NIMSecrets for managing secrets. |
image |
str |
The Docker image to be used for the model server container. Default is “nvcr.io/nim/meta/llama3-8b-instruct |
health_endpoint |
str |
The health endpoint for the model server container. Default is “v1/health/ready”. |
port |
int |
The port number for the model server container. Default is 8000. |
cpu |
int |
The number of CPU cores requested for the model server container. Default is 1. |
gpu |
int |
The number of GPU cores requested for the model server container. Default is 1. |
mem |
str |
The amount of memory requested for the model server container. Default is “20Gi”. |
ephemeral_storage |
str |
The amount of ephemeral storage requested for the model server container. Default is “20Gi”. |
shm_size |
str |
The size of the shared memory volume. Default is “16Gi”. |
env |
typing.Optional[dict[str, str]] |
A dictionary of environment variables to be set in the model server container. |
hf_repo_ids |
typing.Optional[list[str]] |
A list of Hugging Face repository IDs for LoRA adapters to be downloaded. |
lora_adapter_mem |
typing.Optional[str] |
The amount of memory requested for the init container that downloads LoRA adapters. |
| Property |
Type |
Description |
base_url |
None |
|
pod_template |
None |
|
def setup_nim_pod_template()
class NIMSecrets(
ngc_secret_key: str,
secrets_prefix: str,
ngc_image_secret: typing.Optional[str] = None,
ngc_secret_group: typing.Optional[str] = None,
hf_token_group: typing.Optional[str] = None,
hf_token_key: typing.Optional[str] = None,
)
| Parameter |
Type |
Description |
ngc_secret_key |
str |
The key name for the NGC API key. |
secrets_prefix |
str |
The secrets prefix that Flyte appends to all mounted secrets. |
ngc_image_secret |
typing.Optional[str] |
The name of the Kubernetes secret containing the NGC image pull credentials. |
ngc_secret_group |
typing.Optional[str] |
The group name for the NGC API key. |
hf_token_group |
typing.Optional[str] |
The group name for the HuggingFace token. |
hf_token_key |
typing.Optional[str] |
The key name for the HuggingFace token. |