-
Notifications
You must be signed in to change notification settings - Fork 286
Samuel100/update readmes #573
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
34d8abb
Update READMEs to position Foundry Local as E2E AI solution
samuel100 56b0257
readme init
samuel100 cfd64cc
fix typo on py quickstart
samuel100 69cc560
Merge branch 'main' into samuel100/update-readmes
samuel100 9998e11
clean cs and js
samuel100 322f83f
handle platform detection in requirements.txt
samuel100 c1f7937
rust samples updated to autodetect platform
samuel100 f47ecdd
update readme
samuel100 9013eec
get latest package
samuel100 050ef1c
Merge branch 'main' into samuel100/update-readmes
samuel100 190b575
Merge branch 'main' into samuel100/update-readmes
baijumeswani File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # Foundry Local Samples | ||
|
|
||
| Explore complete working examples that demonstrate how to use Foundry Local — an end-to-end local AI solution that runs entirely on-device. These samples cover chat completions, audio transcription, tool calling, LangChain integration, and more. | ||
|
|
||
| > **New to Foundry Local?** Check out the [main README](../README.md) for an overview and quickstart, or visit the [Foundry Local documentation](https://learn.microsoft.com/azure/foundry-local/) on Microsoft Learn. | ||
|
|
||
| ## Samples by Language | ||
|
|
||
| | Language | Samples | Description | | ||
| |----------|---------|-------------| | ||
| | [**C#**](cs/) | 12 | .NET SDK samples including native chat, audio transcription, tool calling, model management, web server, and tutorials. Uses WinML on Windows for hardware acceleration. | | ||
| | [**JavaScript**](js/) | 12 | Node.js SDK samples including native chat, audio transcription, Electron desktop app, Copilot SDK integration, LangChain, tool calling, web server, and tutorials. | | ||
| | [**Python**](python/) | 9 | Python samples using the OpenAI-compatible API, including chat, audio transcription, LangChain integration, tool calling, web server, and tutorials. | | ||
| | [**Rust**](rust/) | 8 | Rust SDK samples including native chat, audio transcription, tool calling, web server, and tutorials. | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
55 changes: 0 additions & 55 deletions
55
samples/cs/live-audio-transcription-example/LiveAudioTranscriptionExample.csproj
This file was deleted.
Oops, something went wrong.
34 changes: 0 additions & 34 deletions
34
samples/cs/live-audio-transcription-example/LiveAudioTranscriptionExample.sln
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| # 🚀 Foundry Local JavaScript Samples | ||
|
|
||
| These samples demonstrate how to use the Foundry Local JavaScript SDK (`foundry-local-sdk`) with Node.js. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - [Node.js](https://nodejs.org/) (v18 or later recommended) | ||
|
|
||
| ## Samples | ||
|
|
||
| | Sample | Description | | ||
| |--------|-------------| | ||
| | [native-chat-completions](native-chat-completions/) | Initialize the SDK, download a model, and run non-streaming and streaming chat completions. | | ||
| | [audio-transcription-example](audio-transcription-example/) | Transcribe audio files using the Whisper model with streaming output. | | ||
| | [chat-and-audio-foundry-local](chat-and-audio-foundry-local/) | Unified sample demonstrating both chat and audio transcription in one application. | | ||
| | [electron-chat-application](electron-chat-application/) | Full-featured Electron desktop chat app with voice transcription and model management. | | ||
| | [copilot-sdk-foundry-local](copilot-sdk-foundry-local/) | GitHub Copilot SDK integration with Foundry Local for agentic AI workflows. | | ||
| | [langchain-integration-example](langchain-integration-example/) | LangChain.js integration for building text generation chains. | | ||
| | [tool-calling-foundry-local](tool-calling-foundry-local/) | Tool calling with custom function definitions and streaming responses. | | ||
| | [web-server-example](web-server-example/) | Start a local OpenAI-compatible web server and call it with the OpenAI SDK. | | ||
| | [tutorial-chat-assistant](tutorial-chat-assistant/) | Build an interactive multi-turn chat assistant (tutorial). | | ||
| | [tutorial-document-summarizer](tutorial-document-summarizer/) | Summarize documents with AI (tutorial). | | ||
| | [tutorial-tool-calling](tutorial-tool-calling/) | Create a tool-calling assistant (tutorial). | | ||
| | [tutorial-voice-to-text](tutorial-voice-to-text/) | Transcribe and summarize audio (tutorial). | | ||
|
|
||
| ## Running a Sample | ||
|
|
||
| 1. Clone the repository: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/microsoft/Foundry-Local.git | ||
| cd Foundry-Local/samples/js | ||
| ``` | ||
|
|
||
| 1. Navigate to a sample and install dependencies: | ||
|
|
||
| ```bash | ||
| cd native-chat-completions | ||
| npm install | ||
| ``` | ||
|
|
||
| 1. Run the sample: | ||
|
|
||
| ```bash | ||
| npm start | ||
| ``` | ||
|
|
||
| > [!TIP] | ||
| > Each sample's `package.json` includes `foundry-local-sdk` as a dependency and `foundry-local-sdk-winml` as an optional dependency. On **Windows**, the WinML variant installs automatically for broader hardware acceleration. On **macOS and Linux**, the standard SDK is used. Just run `npm install` — platform detection is handled for you. | ||
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| { | ||
| "name": "audio-transcription-example", | ||
| "version": "1.0.0", | ||
| "type": "module", | ||
| "main": "app.js", | ||
| "scripts": { | ||
| "start": "node app.js" | ||
| }, | ||
| "dependencies": { | ||
| "foundry-local-sdk": "latest" | ||
| }, | ||
| "optionalDependencies": { | ||
| "foundry-local-sdk-winml": "latest" | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.