.Net: Update PromptTemplateEngine to render code blocks in parallel #1889
Conversation
This file contains 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
changes both PromptTemplateEngine.RenderAsync and PromptTemplateEngine.RenderCodeAsync to render code blocks in parallel using Task.WhenAll() instead of awaiting each function call. to keep the same order, a placeholder is inserted into the output and is later replaced when the async action is complete. added a unit test to verify that code blocks are rendered in the correct order.
dehoward
added
.NET
|
fyi, we already mention the ability for parallelization in a comment at the top of the file: |
dmytrostruk
reviewed
Jul 7, 2023
dotnet/src/SemanticKernel/TemplateEngine/PromptTemplateEngine.cs
Outdated
Show resolved
Hide resolved
dotnet/src/SemanticKernel/TemplateEngine/PromptTemplateEngine.cs
Outdated
Show resolved
Hide resolved
dotnet/src/SemanticKernel/TemplateEngine/PromptTemplateEngine.cs
Outdated
Show resolved
Hide resolved
dmytrostruk
added
the
PR: feedback to address
shawncal
requested changes
Jul 8, 2023
dotnet/src/SemanticKernel/TemplateEngine/PromptTemplateEngine.cs
Outdated
Show resolved
Hide resolved
dotnet/src/SemanticKernel/TemplateEngine/PromptTemplateEngine.cs
Outdated
Show resolved
Hide resolved
dotnet/src/SemanticKernel/TemplateEngine/PromptTemplateEngine.cs
Outdated
Show resolved
Hide resolved
shawncal
reviewed
Jul 11, 2023
dotnet/src/SemanticKernel/TemplateEngine/PromptTemplateEngine.cs
Outdated
Show resolved
Hide resolved
dotnet/src/SemanticKernel/TemplateEngine/PromptTemplateEngine.cs
Outdated
Show resolved
Hide resolved
dotnet/src/SemanticKernel/TemplateEngine/PromptTemplateEngine.cs
Outdated
Show resolved
Hide resolved
removes RenderCodeAsync from IPromptTemplateEngine since it was pointed out that the function is not being used and does not have much value. in addition, adds a unit test for RenderAsync to ensure that variables remain immutable throughout the rendering process.
dehoward
added
PR: ready for review
shawncal
reviewed
Jul 11, 2023
dotnet/src/SemanticKernel/TemplateEngine/PromptTemplateEngine.cs
Outdated
Show resolved
Hide resolved
shawncal
approved these changes
Jul 12, 2023
piotrek-appstream
pushed a commit
to Appstream-Studio/semantic-kernel
that referenced
this pull request
Jul 19, 2023
…icrosoft#1889) ### Motivation and Context <!-- Thank you for your contribution to the semantic-kernel repo! Please help reviewers and future users, providing the following information: 1. Why is this change required? 2. What problem does it solve? 3. What scenario does it contribute to? 4. If it fixes an open issue, please link to the issue here. --> this PR looks to add basic parallelization when rendering code blocks in the template engine. today, functions are called sequentially but have the ability to be invoked in either way. ### Description <!-- Describe your changes, the overall approach, the underlying design. These notes will help understanding how your code works. Thanks! --> - changed `PromptTemplateEngine` to use `Task.WhenAll` instead of `await` when calling `ICodeRendering.RenderCodeAsync`. to ensure the code blocks are appended to the prompt in the same order, a placeholder is inserted into the output before the function call has completed. once it's done, the placeholder, a `Guid` in `RenderAsync` and `null` in `RenderCodeAsync`, is replaced with the result of the call. - added a test for `PromptTemplateEngine.RenderCodeAsync`. ### Contribution Checklist <!-- Before submitting this PR, please make sure: --> - [X] The code builds clean without any errors or warnings - [X] The PR follows SK Contribution Guidelines (https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md) - [X] The code follows the .NET coding conventions (https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions) verified with `dotnet format` - [X] All unit tests pass, and I have added new tests where possible - [ ] I didn't break anyone 😄 --------- Co-authored-by: Shawn Callegari <36091529+shawncal@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation and Context
this PR looks to add basic parallelization when rendering code blocks in the template engine.
today, functions are called sequentially but have the ability to be invoked in either way.
Description
PromptTemplateEngineto useTask.WhenAllinstead ofawaitwhen callingICodeRendering.RenderCodeAsync.to ensure the code blocks are appended to the prompt in the same order, a placeholder is inserted into the output before the function call has completed. once it's done, the placeholder, a
GuidinRenderAsyncandnullinRenderCodeAsync, is replaced with the result of the call.PromptTemplateEngine.RenderCodeAsync.Contribution Checklist
dotnet format