From ecf4d5035149d7ce652c4a1719ebc7831776cf02 Mon Sep 17 00:00:00 2001 From: "FreshDocs[bot]" Date: Tue, 24 Feb 2026 17:35:14 -0500 Subject: [PATCH] docs: update docs for Foundry Local 0.9 Auto-generated by FreshDocs from release branch foundrylocalcore/rel-0.9. --- README.md | 27 +++++++++++++++++++++++---- docs/copilot-sdk-integration.md | 4 ++-- 2 files changed, 25 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 31fc95f0..d1847284 100644 --- a/README.md +++ b/README.md @@ -62,11 +62,32 @@ Foundry Local will automatically select and download a model _variant_ with the You can list all available models by running the following command: ```bash -foundry model ls +foundry model list ``` This will show you a list of all models that can be run locally, including their names, sizes, and other details. +### 📜 View model details and licenses + +To view detailed information about a specific model, including its license, use the following command: + +```bash +foundry model info --license +``` + +You can now use the following additional options with this command: + +- `--revision `: Specify a particular revision of the model to retrieve license information for that specific version. +- `--path `: Specify a relative path on the URI to fetch license details for a specific file or resource. + +For example: + +```bash +foundry model info phi-3.5-mini --license --revision v1.2 --path /license.txt +``` + +This command retrieves the license information for the `phi-3.5-mini` model, specifically for revision `v1.2`, and fetches the license file located at `/license.txt`. + ## 🧑‍💻 Integrate with your applications using the SDK Foundry Local has an easy-to-use SDK (C#, Python, JavaScript) to get you started with existing applications: @@ -127,7 +148,6 @@ foreach (var availableModel in models) // Get a model using an alias var model = await catalog.GetModelAsync("qwen2.5-0.5b") ?? throw new Exception("Model not found"); - // is model cached Console.WriteLine($"Is model cached: {await model.IsCachedAsync()}"); @@ -173,7 +193,6 @@ Console.WriteLine(); await model.UnloadAsync(); ``` - ### Python The Python SDK is available as a package on PyPI. You can install it using pip: @@ -399,4 +418,4 @@ We're actively looking for feedback during this preview phase. Please report iss ## ⚖️ License -Foundry Local is licensed under the Microsoft Software License Terms. For more details, read the [LICENSE](LICENSE) file. +Foundry Local is licensed under the Microsoft Software License Terms. For more details, read the [LICENSE](LICENSE) file. \ No newline at end of file diff --git a/docs/copilot-sdk-integration.md b/docs/copilot-sdk-integration.md index dfddfc64..2bdb9537 100644 --- a/docs/copilot-sdk-integration.md +++ b/docs/copilot-sdk-integration.md @@ -252,7 +252,7 @@ For the full BYOK reference including Azure, Anthropic, and other providers, see - **Timeouts**: Local inference is slower than cloud. `sendAndWait()` defaults to 60 s; pass a higher value (e.g. `120_000`) for on-device models, especially on CPU-only hardware. The [working sample](../samples/js/copilot-sdk-foundry-local/) uses a `FOUNDRY_TIMEOUT_MS` environment variable for easy tuning. - **Copilot CLI required**: The Copilot SDK requires the [Copilot CLI](https://docs.github.com/en/copilot/how-tos/set-up/install-copilot-cli) to be installed and authenticated. The SDK communicates with it over JSON-RPC. -- **Tool calling**: Depends on model support. Not all Foundry Local models support function calling. Check model capabilities with `foundry model ls`. +- **Tool calling**: Depends on model support. Not all Foundry Local models support function calling. Check model capabilities with `foundry model list`. - **Preview APIs**: Both Foundry Local's REST API and Copilot SDK may have breaking changes during preview. - **Model size**: On-device models are smaller than cloud models. Agentic performance (multi-step planning, complex tool use) may vary compared to cloud-hosted models. - **Platform**: Foundry Local supports Windows (x64/arm64) and macOS (Apple Silicon). @@ -267,4 +267,4 @@ See the complete working sample at [`samples/js/copilot-sdk-foundry-local/`](../ - [Copilot SDK Getting Started](https://github.com/github/copilot-sdk/blob/main/docs/getting-started.md) — Official tutorial - [Copilot SDK BYOK Documentation](https://github.com/github/copilot-sdk/blob/main/docs/auth/byok.md) — Full BYOK configuration reference - [Foundry Local Samples](../samples/) — Existing samples using Foundry Local SDK + OpenAI client -- [Foundry Local Documentation (Microsoft Learn)](https://learn.microsoft.com/azure/ai-foundry/foundry-local/) +- [Foundry Local Documentation (Microsoft Learn)](https://learn.microsoft.com/azure/ai-foundry/foundry-local/) \ No newline at end of file