Skip to content

Commit be55afe

Browse files
committed
more clarity on alias
1 parent f2fccb1 commit be55afe

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

articles/ai-foundry/foundry-local/includes/sdk-reference/javascript.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,15 @@ Available options:
3333
- `serviceUrl`: Base URL of the Foundry Local service
3434
- `fetch`: (optional) Custom fetch implementation for environments like Node.js
3535

36+
### A note on aliases
37+
38+
Many methods outlined in this reference have an `aliasOrModelId` parameter in the signature. You can pass into the method either an **alias** or **model ID** as a value. Using an alias will:
39+
40+
- Select the *best model* for the available hardware. For example, if a Nvidia CUDA GPU is available, Foundry Local selects the CUDA model. If a supported NPU is available, Foundry Local selects the NPU model.
41+
- Allow you to use a shorter name without needing to remember the model ID.
42+
43+
> [!TIP]
44+
> We recommend passing into the `aliasOrModelId` parameter an **alias** because when you deploy your application, Foundry Local acquires the best model for the end user's machine at run-time.
3645
3746
### Service Management
3847

articles/ai-foundry/foundry-local/includes/sdk-reference/python.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,16 @@ manager = FoundryLocalManager(alias_or_model_id=None, bootstrap=True)
3333
- `alias_or_model_id`: (optional) Alias or Model ID to download and load at startup.
3434
- `bootstrap`: (default True) If True, starts the service if not running and loads the model if provided.
3535

36+
### A note on aliases
37+
38+
Many methods outlined in this reference have an `alias_or_model_id` parameter in the signature. You can pass into the method either an **alias** or **model ID** as a value. Using an alias will:
39+
40+
- Select the *best model* for the available hardware. For example, if a Nvidia CUDA GPU is available, Foundry Local selects the CUDA model. If a supported NPU is available, Foundry Local selects the NPU model.
41+
- Allow you to use a shorter name without needing to remember the model ID.
42+
43+
> [!TIP]
44+
> We recommend passing into the `alias_or_model_id` parameter an **alias** because when you deploy your application, Foundry Local acquires the best model for the end user's machine at run-time.
45+
3646
### Service Management
3747

3848
| Method | Signature | Description |

0 commit comments

Comments
 (0)