Skip to content

Commit 97b7c86

Browse files
committed
Added more small asks, illuminated issues after testing.
1 parent a559612 commit 97b7c86

File tree

4 files changed

+25
-28
lines changed

4 files changed

+25
-28
lines changed

articles/ai-foundry/foundry-local/concepts/foundry-local-architecture.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The Foundry Local architecture consists of these main components:
3939

4040
The Foundry Local Service includes an OpenAI-compatible REST server that provides a standard interface for working with the inference engine. It's also possible to manage models over REST. Developers use this API to send requests, run models, and get results programmatically.
4141

42-
- **Endpoint**: The endpoint is *dynamically allocated* when the service starts. You can find the endpoint by running the `foundry service status` command. When using Foundry Local in your applications, we recommend using the SDK that automatically handles the endpoint for you. For more details on how to use the Foundry Local SDK, read the [Integrated inferencing SDKs with Foundry Local](../how-to/how-to-integrate-with-inference-sdks.md) article.
42+
- **Endpoint**: The endpoint is _dynamically allocated_ when the service starts. You can find the endpoint by running the `foundry service status` command. When using Foundry Local in your applications, we recommend using the SDK that automatically handles the endpoint for you. For more details on how to use the Foundry Local SDK, read the [Integrated inferencing SDKs with Foundry Local](../how-to/how-to-integrate-with-inference-sdks.md) article.
4343
- **Use Cases**:
4444
- Connect Foundry Local to your custom applications
4545
- Execute models through HTTP requests
@@ -111,9 +111,7 @@ The Foundry CLI is a powerful tool for managing models, the inference engine, an
111111
112112
#### Inferencing SDK integration
113113

114-
Foundry Local supports integration with various SDKs, such as the OpenAI SDK, enabling developers to use familiar programming interfaces to interact with the local inference engine.
115-
116-
- **Supported SDKs**: Python, JavaScript, C#, and more.
114+
Foundry Local supports integration with various SDKs in most languages, such as the OpenAI SDK, enabling developers to use familiar programming interfaces to interact with the local inference engine.
117115

118116
> [!TIP]
119117
> To learn more about integrating with inferencing SDKs, read [Integrate inferencing SDKs with Foundry Local](../how-to/how-to-integrate-with-inference-sdks.md).

articles/ai-foundry/foundry-local/reference/reference-best-practice.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Foundry Local is designed for on-device inference and *not* distributed, contain
4343
| --- | --- | --- |
4444
| Slow inference | CPU-only model with large parameter count | Use GPU-optimized model variants when available |
4545
| Model download failures | Network connectivity issues | Check your internet connection and run `foundry cache list` to verify cache status |
46-
| The service fails to start | Port conflicts or permission issues | Try `foundry service restart` or report an issue with logs using `foundry zip-logs` |
46+
| The service fails to start | Port conflicts or permission issues | Try `foundry service restart` or [report an issue](https://github.com/microsoft/Foundry-Local/issues) with logs using `foundry zip-logs` |
4747

4848
### Improving performance
4949

articles/ai-foundry/foundry-local/reference/reference-cli.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -35,31 +35,31 @@ The CLI organizes commands into three main categories:
3535

3636
The following table summarizes the commands related to managing and running models:
3737

38-
| **Command** | **Description** |
39-
| -------------------------------- | -------------------------------------------------------------------------------- |
40-
| `foundry model --help` | Displays all available model-related commands and their usage. |
41-
| `foundry model run <model>` | Runs a specified model, downloading it if not cached, and starts an interaction. |
42-
| `foundry model list` | Lists all available models for local use. |
43-
| `foundry model info <model>` | Displays detailed information about a specific model. |
38+
| **Command** | **Description** |
39+
| -------------------------------------- | -------------------------------------------------------------------------------- |
40+
| `foundry model --help` | Displays all available model-related commands and their usage. |
41+
| `foundry model run <model>` | Runs a specified model, downloading it if not cached, and starts an interaction. |
42+
| `foundry model list` | Lists all available models for local use. |
43+
| `foundry model info <model>` | Displays detailed information about a specific model. |
4444
| `foundry model info <model> --license` | Displays the license information for a specific model. |
45-
| `foundry model download <model>` | Downloads a model to the local cache without running it. |
46-
| `foundry model load <model>` | Loads a model into the service. |
47-
| `foundry model unload <model>` | Unloads a model from the service. |
45+
| `foundry model download <model>` | Downloads a model to the local cache without running it. |
46+
| `foundry model load <model>` | Loads a model into the service. |
47+
| `foundry model unload <model>` | Unloads a model from the service. |
4848

4949
## Service commands
5050

5151
The following table summarizes the commands related to managing and running the Foundry Local service:
5252

53-
| **Command** | **Description** |
54-
| ------------------------- | ---------------------------------------------------------------- |
55-
| `foundry service --help` | Displays all available service-related commands and their usage. |
56-
| `foundry service start` | Starts the Foundry Local service. |
57-
| `foundry service stop` | Stops the Foundry Local service. |
58-
| `foundry service restart` | Restarts the Foundry Local service. |
59-
| `foundry service status` | Displays the current status of the Foundry Local service. |
60-
| `foundry service ps` | Lists all models currently loaded in the Foundry Local service. |
61-
| `foundry service diag` | Displays the logs of the Foundry Local service. |
62-
| `foundry service set` | Set configuration of the Foundry Local service. |
53+
| **Command** | **Description** |
54+
| ------------------------------- | ---------------------------------------------------------------- |
55+
| `foundry service --help` | Displays all available service-related commands and their usage. |
56+
| `foundry service start` | Starts the Foundry Local service. |
57+
| `foundry service stop` | Stops the Foundry Local service. |
58+
| `foundry service restart` | Restarts the Foundry Local service. |
59+
| `foundry service status` | Displays the current status of the Foundry Local service. |
60+
| `foundry service ps` | Lists all models currently loaded in the Foundry Local service. |
61+
| `foundry service diag` | Displays the logs of the Foundry Local service. |
62+
| `foundry service set <options>` | Set configuration of the Foundry Local service. |
6363

6464
## Cache commands
6565

@@ -68,7 +68,7 @@ The following table summarizes the commands related to managing the local cache
6868
| **Command** | **Description** |
6969
| ------------------------------ | -------------------------------------------------------------- |
7070
| `foundry cache --help` | Displays all available cache-related commands and their usage. |
71-
| `foundry cache location` | Displays the current cache directory. |
71+
| `foundry cache location` | Displays the current cache directory. |
7272
| `foundry cache list` | Lists all models stored in the local cache. |
7373
| `foundry cache remove <model>` | Deletes a model from the local cache. |
7474
| `foundry cache cd <path>` | Changes the cache directory. |

articles/ai-foundry/foundry-local/what-is-foundry-local.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ ms.custom: build-2025
1818

1919
[!INCLUDE [foundry-local-preview](./includes/foundry-local-preview.md)]
2020

21-
Foundry Local is an on-device AI inference solution offering performance, privacy, customization, and cost advantages. It integrates seamlessly into your existing workflows and applications through an intuitive CLI and REST API.
21+
Foundry Local is an on-device AI inference solution offering performance, privacy, customization, and cost advantages. It integrates seamlessly into your existing workflows and applications through an intuitive CLI, SDK, and REST API.
2222

2323
## Key features
2424

@@ -28,7 +28,7 @@ Foundry Local is an on-device AI inference solution offering performance, privac
2828

2929
- **Cost Efficiency**: Eliminate recurring cloud service costs by using your existing hardware, making AI more accessible.
3030

31-
- **Seamless Integration**: Connect with your applications through API endpoints or the CLI, with easy scaling to Azure AI Foundry as your needs grow.
31+
- **Seamless Integration**: Connect with your applications through an SDK, API endpoints, or the CLI, with easy scaling to Azure AI Foundry as your needs grow.
3232

3333
## Use cases
3434

@@ -52,4 +52,3 @@ Install and run your first model by following the [Get started with Foundry Loca
5252

5353
- [Get started with Foundry Local](get-started.md)
5454
- [How to compile Hugging Face models to run on Foundry Local](how-to/how-to-compile-hugging-face-models.md)
55-

0 commit comments

Comments
 (0)