[GenAI] Introduce CausalLMPipelineChatClient for MEAI.IChatClient - #7270

Merged
LittleLittleCloud merged 7 commits into
dotnet:mainfrom
LittleLittleCloud:u/MEAI
Nov 5, 2024
Merged

[GenAI] Introduce CausalLMPipelineChatClient for MEAI.IChatClient#7270
LittleLittleCloud merged 7 commits into
dotnet:mainfrom
LittleLittleCloud:u/MEAI

Conversation

@LittleLittleCloud

@LittleLittleCloudLittleLittleCloud commented Oct 13, 2024

Copy link
Copy Markdown
Member

We are excited to review your PR.

So we can do the best job, please check:

  • There's a descriptive title that will make sense to other developers some time from now.
  • There's associated issues. All PR's should have issue(s) associated - unless a trivial self-evident change such as fixing a typo. You can use the format Fixes #nnnn in your description to cause GitHub to automatically close the issue(s) when your PR is merged.
  • Your change description explains what the change does, why you chose your approach, and anything else that reviewers should know.
  • You have included any necessary tests in the same PR.

This PR implements CausalLMPipelineChatClient<TTokenizer, TCausalLMModel> class for MEAI.IChatClient's intergration.

This PR also refactors the AutoGen and semantic kernel intergretion for Phi3, which pulls out the prompt template parts into an individual Phi3ChatTemplateBuilder class.

This PR also update STJ to 8.0.5 to address a security warning for that package

The CausalLMPipelineChatClient is used as the abstract class for all IChatClient implementation in GenAI models. For now, the following implementations are available

  • Phi3CausalLMChatClient
  • Llama3CausalLMChatClient

The MistralCausalLMChatClient will come in the following PR with additional support for tool call.

Usage

Checkout the MEAI folder under Microsoft.ML.GenAI.Samples` for examples. The following examples are added

  • Llama3_1
  • Phi3

@codecov

codecovBot commented Oct 13, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 33.33333% with 152 lines in your changes missing coverage. Please review.

Project coverage is 68.84%. Comparing base (823fc17) to head (c5b9603).
Report is 10 commits behind head on main.

Files with missing linesPatch %Lines
...rosoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs0.00%48 Missing ⚠️
...osoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs43.83%35 Missing and 6 partials ⚠️
...crosoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs0.00%24 Missing ⚠️
...rosoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs0.00%24 Missing ⚠️
...soft.ML.GenAI.LLaMA/Llama3_1ChatTemplateBuilder.cs69.23%5 Missing and 3 partials ⚠️
...c/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMAgent.cs60.00%6 Missing ⚠️
...enAI.Phi/Phi3/Phi3CausalLMChatCompletionService.cs83.33%1 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #7270 +/- ##
==========================================
+ Coverage 68.81% 68.84% +0.03% 
==========================================
Files 1461 1471 +10 Lines 272405 274124 +1719 Branches 28176 28411 +235 ==========================================
+ Hits 187442 188734 +1292 - Misses 77727 78079 +352 - Partials 7236 7311 +75 
FlagCoverage Δ
Debug68.84% <33.33%> (+0.03%)⬆️
production63.30% <30.27%> (-0.01%)⬇️
test89.18% <100.00%> (+0.10%)⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing linesCoverage Δ
...enAI.Phi/Phi3/Phi3CausalLMTextGenerationService.cs35.71% <100.00%> (+1.56%)⬆️
...st/Microsoft.ML.GenAI.LLaMA.Tests/LLaMA3_1Tests.cs94.73% <100.00%> (+0.79%)⬆️
...enAI.Phi/Phi3/Phi3CausalLMChatCompletionService.cs61.90% <83.33%> (-3.10%)⬇️
...c/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMAgent.cs52.00% <60.00%> (-4.72%)⬇️
...soft.ML.GenAI.LLaMA/Llama3_1ChatTemplateBuilder.cs68.83% <69.23%> (+0.20%)⬆️
...crosoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs0.00% <0.00%> (ø)
...rosoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs0.00% <0.00%> (ø)
...osoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs43.83% <43.83%> (ø)
...rosoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs0.00% <0.00%> (ø)

... and 29 files with indirect coverage changes

@LittleLittleCloudLittleLittleCloud mentioned this pull request Oct 7, 2024
13 tasks
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs
Comment threadsrc/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs
Comment threadsrc/Microsoft.ML.GenAI.Core/Microsoft.ML.GenAI.Core.csproj Outdated
@michaelgsharp

Copy link
Copy Markdown
Contributor

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 2 pipeline(s).

@LittleLittleCloud
LittleLittleCloud merged commit 3659a48 into dotnet:mainNov 5, 2024
@michaelgsharp

Copy link
Copy Markdown
Contributor

/backport to release/4.0

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/4.0: https://github.com/dotnet/machinelearning/actions/runs/11749726947

@github-actions

Copy link
Copy Markdown
Contributor

@michaelgsharp backporting to release/4.0 failed, the patch most likely resulted in conflicts:

$ git am --3way --empty=keep --ignore-whitespace --keep-non-patch changes.patch
Applying: leverage MEAI abstraction
Applying: Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Applying: Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Applying: Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Applying: fix comments
Using index info to reconstruct a base tree...
M	src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
M	src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Falling back to patching base and 3-way merge...
Auto-merging src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Auto-merging src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
CONFLICT (content): Merge conflict in src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0005 fix comments
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

@github-actions

Copy link
Copy Markdown
Contributor

@michaelgsharp an error occurred while backporting to release/4.0, please check the run log for details!

Error: git am failed, most likely due to a merge conflict.

michaelgsharp pushed a commit to michaelgsharp/machinelearning that referenced this pull request Nov 11, 2024
…tnet#7270)
* leverage MEAI abstraction
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* fix comments
* Update Microsoft.ML.GenAI.Core.csproj
---------
Co-authored-by: Stephen Toub <stoub@microsoft.com>
michaelgsharp added a commit that referenced this pull request Nov 11, 2024
) (#7298)
* leverage MEAI abstraction
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
* Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
* fix comments
* Update Microsoft.ML.GenAI.Core.csproj
---------
Co-authored-by: Xiaoyun Zhang <xiaoyuz@microsoft.com>
Co-authored-by: Stephen Toub <stoub@microsoft.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Dec 9, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@LittleLittleCloud@michaelgsharp@stephentoub
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

[GenAI] Introduce CausalLMPipelineChatClient for MEAI.IChatClient - #7270

Merged
LittleLittleCloud merged 7 commits into
dotnet:mainfrom
LittleLittleCloud:u/MEAI
Nov 5, 2024
Merged

[GenAI] Introduce CausalLMPipelineChatClient for MEAI.IChatClient#7270
LittleLittleCloud merged 7 commits into
dotnet:mainfrom
LittleLittleCloud:u/MEAI

Conversation

@LittleLittleCloud

@LittleLittleCloudLittleLittleCloud commented Oct 13, 2024

Copy link
Copy Markdown
Member

We are excited to review your PR.

So we can do the best job, please check:

  • There's a descriptive title that will make sense to other developers some time from now.
  • There's associated issues. All PR's should have issue(s) associated - unless a trivial self-evident change such as fixing a typo. You can use the format Fixes #nnnn in your description to cause GitHub to automatically close the issue(s) when your PR is merged.
  • Your change description explains what the change does, why you chose your approach, and anything else that reviewers should know.
  • You have included any necessary tests in the same PR.

This PR implements CausalLMPipelineChatClient<TTokenizer, TCausalLMModel> class for MEAI.IChatClient's intergration.

This PR also refactors the AutoGen and semantic kernel intergretion for Phi3, which pulls out the prompt template parts into an individual Phi3ChatTemplateBuilder class.

This PR also update STJ to 8.0.5 to address a security warning for that package

The CausalLMPipelineChatClient is used as the abstract class for all IChatClient implementation in GenAI models. For now, the following implementations are available

  • Phi3CausalLMChatClient
  • Llama3CausalLMChatClient

The MistralCausalLMChatClient will come in the following PR with additional support for tool call.

Usage

Checkout the MEAI folder under Microsoft.ML.GenAI.Samples` for examples. The following examples are added

  • Llama3_1
  • Phi3

@codecov

codecovBot commented Oct 13, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 33.33333% with 152 lines in your changes missing coverage. Please review.

Project coverage is 68.84%. Comparing base (823fc17) to head (c5b9603).
Report is 10 commits behind head on main.

Files with missing linesPatch %Lines
...rosoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs0.00%48 Missing ⚠️
...osoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs43.83%35 Missing and 6 partials ⚠️
...crosoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs0.00%24 Missing ⚠️
...rosoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs0.00%24 Missing ⚠️
...soft.ML.GenAI.LLaMA/Llama3_1ChatTemplateBuilder.cs69.23%5 Missing and 3 partials ⚠️
...c/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMAgent.cs60.00%6 Missing ⚠️
...enAI.Phi/Phi3/Phi3CausalLMChatCompletionService.cs83.33%1 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #7270 +/- ##
==========================================
+ Coverage 68.81% 68.84% +0.03% 
==========================================
Files 1461 1471 +10 Lines 272405 274124 +1719 Branches 28176 28411 +235 ==========================================
+ Hits 187442 188734 +1292 - Misses 77727 78079 +352 - Partials 7236 7311 +75 
FlagCoverage Δ
Debug68.84% <33.33%> (+0.03%)⬆️
production63.30% <30.27%> (-0.01%)⬇️
test89.18% <100.00%> (+0.10%)⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing linesCoverage Δ
...enAI.Phi/Phi3/Phi3CausalLMTextGenerationService.cs35.71% <100.00%> (+1.56%)⬆️
...st/Microsoft.ML.GenAI.LLaMA.Tests/LLaMA3_1Tests.cs94.73% <100.00%> (+0.79%)⬆️
...enAI.Phi/Phi3/Phi3CausalLMChatCompletionService.cs61.90% <83.33%> (-3.10%)⬇️
...c/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMAgent.cs52.00% <60.00%> (-4.72%)⬇️
...soft.ML.GenAI.LLaMA/Llama3_1ChatTemplateBuilder.cs68.83% <69.23%> (+0.20%)⬆️
...crosoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs0.00% <0.00%> (ø)
...rosoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs0.00% <0.00%> (ø)
...osoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs43.83% <43.83%> (ø)
...rosoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs0.00% <0.00%> (ø)

... and 29 files with indirect coverage changes

@LittleLittleCloudLittleLittleCloud mentioned this pull request Oct 7, 2024
13 tasks
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs
Comment threadsrc/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs
Comment threadsrc/Microsoft.ML.GenAI.Core/Microsoft.ML.GenAI.Core.csproj Outdated
@michaelgsharp

Copy link
Copy Markdown
Contributor

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 2 pipeline(s).

@LittleLittleCloud
LittleLittleCloud merged commit 3659a48 into dotnet:mainNov 5, 2024
@michaelgsharp

Copy link
Copy Markdown
Contributor

/backport to release/4.0

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/4.0: https://github.com/dotnet/machinelearning/actions/runs/11749726947

@github-actions

Copy link
Copy Markdown
Contributor

@michaelgsharp backporting to release/4.0 failed, the patch most likely resulted in conflicts:

$ git am --3way --empty=keep --ignore-whitespace --keep-non-patch changes.patch
Applying: leverage MEAI abstraction
Applying: Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Applying: Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Applying: Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Applying: fix comments
Using index info to reconstruct a base tree...
M	src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
M	src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Falling back to patching base and 3-way merge...
Auto-merging src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Auto-merging src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
CONFLICT (content): Merge conflict in src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0005 fix comments
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

@github-actions

Copy link
Copy Markdown
Contributor

@michaelgsharp an error occurred while backporting to release/4.0, please check the run log for details!

Error: git am failed, most likely due to a merge conflict.

michaelgsharp pushed a commit to michaelgsharp/machinelearning that referenced this pull request Nov 11, 2024
…tnet#7270)
* leverage MEAI abstraction
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* fix comments
* Update Microsoft.ML.GenAI.Core.csproj
---------
Co-authored-by: Stephen Toub <stoub@microsoft.com>
michaelgsharp added a commit that referenced this pull request Nov 11, 2024
) (#7298)
* leverage MEAI abstraction
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
* Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
* fix comments
* Update Microsoft.ML.GenAI.Core.csproj
---------
Co-authored-by: Xiaoyun Zhang <xiaoyuz@microsoft.com>
Co-authored-by: Stephen Toub <stoub@microsoft.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Dec 9, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@LittleLittleCloud@michaelgsharp@stephentoub
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

[GenAI] Introduce CausalLMPipelineChatClient for MEAI.IChatClient - #7270

Merged
LittleLittleCloud merged 7 commits into
dotnet:mainfrom
LittleLittleCloud:u/MEAI
Nov 5, 2024
Merged

[GenAI] Introduce CausalLMPipelineChatClient for MEAI.IChatClient#7270
LittleLittleCloud merged 7 commits into
dotnet:mainfrom
LittleLittleCloud:u/MEAI

Conversation

@LittleLittleCloud

@LittleLittleCloudLittleLittleCloud commented Oct 13, 2024

Copy link
Copy Markdown
Member

We are excited to review your PR.

So we can do the best job, please check:

  • There's a descriptive title that will make sense to other developers some time from now.
  • There's associated issues. All PR's should have issue(s) associated - unless a trivial self-evident change such as fixing a typo. You can use the format Fixes #nnnn in your description to cause GitHub to automatically close the issue(s) when your PR is merged.
  • Your change description explains what the change does, why you chose your approach, and anything else that reviewers should know.
  • You have included any necessary tests in the same PR.

This PR implements CausalLMPipelineChatClient<TTokenizer, TCausalLMModel> class for MEAI.IChatClient's intergration.

This PR also refactors the AutoGen and semantic kernel intergretion for Phi3, which pulls out the prompt template parts into an individual Phi3ChatTemplateBuilder class.

This PR also update STJ to 8.0.5 to address a security warning for that package

The CausalLMPipelineChatClient is used as the abstract class for all IChatClient implementation in GenAI models. For now, the following implementations are available

  • Phi3CausalLMChatClient
  • Llama3CausalLMChatClient

The MistralCausalLMChatClient will come in the following PR with additional support for tool call.

Usage

Checkout the MEAI folder under Microsoft.ML.GenAI.Samples` for examples. The following examples are added

  • Llama3_1
  • Phi3

@codecov

codecovBot commented Oct 13, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 33.33333% with 152 lines in your changes missing coverage. Please review.

Project coverage is 68.84%. Comparing base (823fc17) to head (c5b9603).
Report is 10 commits behind head on main.

Files with missing linesPatch %Lines
...rosoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs0.00%48 Missing ⚠️
...osoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs43.83%35 Missing and 6 partials ⚠️
...crosoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs0.00%24 Missing ⚠️
...rosoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs0.00%24 Missing ⚠️
...soft.ML.GenAI.LLaMA/Llama3_1ChatTemplateBuilder.cs69.23%5 Missing and 3 partials ⚠️
...c/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMAgent.cs60.00%6 Missing ⚠️
...enAI.Phi/Phi3/Phi3CausalLMChatCompletionService.cs83.33%1 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #7270 +/- ##
==========================================
+ Coverage 68.81% 68.84% +0.03% 
==========================================
Files 1461 1471 +10 Lines 272405 274124 +1719 Branches 28176 28411 +235 ==========================================
+ Hits 187442 188734 +1292 - Misses 77727 78079 +352 - Partials 7236 7311 +75 
FlagCoverage Δ
Debug68.84% <33.33%> (+0.03%)⬆️
production63.30% <30.27%> (-0.01%)⬇️
test89.18% <100.00%> (+0.10%)⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing linesCoverage Δ
...enAI.Phi/Phi3/Phi3CausalLMTextGenerationService.cs35.71% <100.00%> (+1.56%)⬆️
...st/Microsoft.ML.GenAI.LLaMA.Tests/LLaMA3_1Tests.cs94.73% <100.00%> (+0.79%)⬆️
...enAI.Phi/Phi3/Phi3CausalLMChatCompletionService.cs61.90% <83.33%> (-3.10%)⬇️
...c/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMAgent.cs52.00% <60.00%> (-4.72%)⬇️
...soft.ML.GenAI.LLaMA/Llama3_1ChatTemplateBuilder.cs68.83% <69.23%> (+0.20%)⬆️
...crosoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs0.00% <0.00%> (ø)
...rosoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs0.00% <0.00%> (ø)
...osoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs43.83% <43.83%> (ø)
...rosoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs0.00% <0.00%> (ø)

... and 29 files with indirect coverage changes

@LittleLittleCloudLittleLittleCloud mentioned this pull request Oct 7, 2024
13 tasks
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs
Comment threadsrc/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs
Comment threadsrc/Microsoft.ML.GenAI.Core/Microsoft.ML.GenAI.Core.csproj Outdated
@michaelgsharp

Copy link
Copy Markdown
Contributor

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 2 pipeline(s).

@LittleLittleCloud
LittleLittleCloud merged commit 3659a48 into dotnet:mainNov 5, 2024
@michaelgsharp

Copy link
Copy Markdown
Contributor

/backport to release/4.0

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/4.0: https://github.com/dotnet/machinelearning/actions/runs/11749726947

@github-actions

Copy link
Copy Markdown
Contributor

@michaelgsharp backporting to release/4.0 failed, the patch most likely resulted in conflicts:

$ git am --3way --empty=keep --ignore-whitespace --keep-non-patch changes.patch
Applying: leverage MEAI abstraction
Applying: Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Applying: Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Applying: Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Applying: fix comments
Using index info to reconstruct a base tree...
M	src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
M	src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Falling back to patching base and 3-way merge...
Auto-merging src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Auto-merging src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
CONFLICT (content): Merge conflict in src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0005 fix comments
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

@github-actions

Copy link
Copy Markdown
Contributor

@michaelgsharp an error occurred while backporting to release/4.0, please check the run log for details!

Error: git am failed, most likely due to a merge conflict.

michaelgsharp pushed a commit to michaelgsharp/machinelearning that referenced this pull request Nov 11, 2024
…tnet#7270)
* leverage MEAI abstraction
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* fix comments
* Update Microsoft.ML.GenAI.Core.csproj
---------
Co-authored-by: Stephen Toub <stoub@microsoft.com>
michaelgsharp added a commit that referenced this pull request Nov 11, 2024
) (#7298)
* leverage MEAI abstraction
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
* Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
* fix comments
* Update Microsoft.ML.GenAI.Core.csproj
---------
Co-authored-by: Xiaoyun Zhang <xiaoyuz@microsoft.com>
Co-authored-by: Stephen Toub <stoub@microsoft.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Dec 9, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@LittleLittleCloud@michaelgsharp@stephentoub
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

[GenAI] Introduce CausalLMPipelineChatClient for MEAI.IChatClient - #7270

Merged
LittleLittleCloud merged 7 commits into
dotnet:mainfrom
LittleLittleCloud:u/MEAI
Nov 5, 2024
Merged

[GenAI] Introduce CausalLMPipelineChatClient for MEAI.IChatClient#7270
LittleLittleCloud merged 7 commits into
dotnet:mainfrom
LittleLittleCloud:u/MEAI

Conversation

@LittleLittleCloud

@LittleLittleCloudLittleLittleCloud commented Oct 13, 2024

Copy link
Copy Markdown
Member

We are excited to review your PR.

So we can do the best job, please check:

  • There's a descriptive title that will make sense to other developers some time from now.
  • There's associated issues. All PR's should have issue(s) associated - unless a trivial self-evident change such as fixing a typo. You can use the format Fixes #nnnn in your description to cause GitHub to automatically close the issue(s) when your PR is merged.
  • Your change description explains what the change does, why you chose your approach, and anything else that reviewers should know.
  • You have included any necessary tests in the same PR.

This PR implements CausalLMPipelineChatClient<TTokenizer, TCausalLMModel> class for MEAI.IChatClient's intergration.

This PR also refactors the AutoGen and semantic kernel intergretion for Phi3, which pulls out the prompt template parts into an individual Phi3ChatTemplateBuilder class.

This PR also update STJ to 8.0.5 to address a security warning for that package

The CausalLMPipelineChatClient is used as the abstract class for all IChatClient implementation in GenAI models. For now, the following implementations are available

  • Phi3CausalLMChatClient
  • Llama3CausalLMChatClient

The MistralCausalLMChatClient will come in the following PR with additional support for tool call.

Usage

Checkout the MEAI folder under Microsoft.ML.GenAI.Samples` for examples. The following examples are added

  • Llama3_1
  • Phi3

@codecov

codecovBot commented Oct 13, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 33.33333% with 152 lines in your changes missing coverage. Please review.

Project coverage is 68.84%. Comparing base (823fc17) to head (c5b9603).
Report is 10 commits behind head on main.

Files with missing linesPatch %Lines
...rosoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs0.00%48 Missing ⚠️
...osoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs43.83%35 Missing and 6 partials ⚠️
...crosoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs0.00%24 Missing ⚠️
...rosoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs0.00%24 Missing ⚠️
...soft.ML.GenAI.LLaMA/Llama3_1ChatTemplateBuilder.cs69.23%5 Missing and 3 partials ⚠️
...c/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMAgent.cs60.00%6 Missing ⚠️
...enAI.Phi/Phi3/Phi3CausalLMChatCompletionService.cs83.33%1 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #7270 +/- ##
==========================================
+ Coverage 68.81% 68.84% +0.03% 
==========================================
Files 1461 1471 +10 Lines 272405 274124 +1719 Branches 28176 28411 +235 ==========================================
+ Hits 187442 188734 +1292 - Misses 77727 78079 +352 - Partials 7236 7311 +75 
FlagCoverage Δ
Debug68.84% <33.33%> (+0.03%)⬆️
production63.30% <30.27%> (-0.01%)⬇️
test89.18% <100.00%> (+0.10%)⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing linesCoverage Δ
...enAI.Phi/Phi3/Phi3CausalLMTextGenerationService.cs35.71% <100.00%> (+1.56%)⬆️
...st/Microsoft.ML.GenAI.LLaMA.Tests/LLaMA3_1Tests.cs94.73% <100.00%> (+0.79%)⬆️
...enAI.Phi/Phi3/Phi3CausalLMChatCompletionService.cs61.90% <83.33%> (-3.10%)⬇️
...c/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMAgent.cs52.00% <60.00%> (-4.72%)⬇️
...soft.ML.GenAI.LLaMA/Llama3_1ChatTemplateBuilder.cs68.83% <69.23%> (+0.20%)⬆️
...crosoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs0.00% <0.00%> (ø)
...rosoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs0.00% <0.00%> (ø)
...osoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs43.83% <43.83%> (ø)
...rosoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs0.00% <0.00%> (ø)

... and 29 files with indirect coverage changes

@LittleLittleCloudLittleLittleCloud mentioned this pull request Oct 7, 2024
13 tasks
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs
Comment threadsrc/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs
Comment threadsrc/Microsoft.ML.GenAI.Core/Microsoft.ML.GenAI.Core.csproj Outdated
@michaelgsharp

Copy link
Copy Markdown
Contributor

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 2 pipeline(s).

@LittleLittleCloud
LittleLittleCloud merged commit 3659a48 into dotnet:mainNov 5, 2024
@michaelgsharp

Copy link
Copy Markdown
Contributor

/backport to release/4.0

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/4.0: https://github.com/dotnet/machinelearning/actions/runs/11749726947

@github-actions

Copy link
Copy Markdown
Contributor

@michaelgsharp backporting to release/4.0 failed, the patch most likely resulted in conflicts:

$ git am --3way --empty=keep --ignore-whitespace --keep-non-patch changes.patch
Applying: leverage MEAI abstraction
Applying: Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Applying: Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Applying: Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Applying: fix comments
Using index info to reconstruct a base tree...
M	src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
M	src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Falling back to patching base and 3-way merge...
Auto-merging src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Auto-merging src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
CONFLICT (content): Merge conflict in src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0005 fix comments
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

@github-actions

Copy link
Copy Markdown
Contributor

@michaelgsharp an error occurred while backporting to release/4.0, please check the run log for details!

Error: git am failed, most likely due to a merge conflict.

michaelgsharp pushed a commit to michaelgsharp/machinelearning that referenced this pull request Nov 11, 2024
…tnet#7270)
* leverage MEAI abstraction
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* fix comments
* Update Microsoft.ML.GenAI.Core.csproj
---------
Co-authored-by: Stephen Toub <stoub@microsoft.com>
michaelgsharp added a commit that referenced this pull request Nov 11, 2024
) (#7298)
* leverage MEAI abstraction
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
* Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
* fix comments
* Update Microsoft.ML.GenAI.Core.csproj
---------
Co-authored-by: Xiaoyun Zhang <xiaoyuz@microsoft.com>
Co-authored-by: Stephen Toub <stoub@microsoft.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Dec 9, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@LittleLittleCloud@michaelgsharp@stephentoub
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

[GenAI] Introduce CausalLMPipelineChatClient for MEAI.IChatClient - #7270

Merged
LittleLittleCloud merged 7 commits into
dotnet:mainfrom
LittleLittleCloud:u/MEAI
Nov 5, 2024
Merged

[GenAI] Introduce CausalLMPipelineChatClient for MEAI.IChatClient#7270
LittleLittleCloud merged 7 commits into
dotnet:mainfrom
LittleLittleCloud:u/MEAI

Conversation

@LittleLittleCloud

@LittleLittleCloudLittleLittleCloud commented Oct 13, 2024

Copy link
Copy Markdown
Member

We are excited to review your PR.

So we can do the best job, please check:

  • There's a descriptive title that will make sense to other developers some time from now.
  • There's associated issues. All PR's should have issue(s) associated - unless a trivial self-evident change such as fixing a typo. You can use the format Fixes #nnnn in your description to cause GitHub to automatically close the issue(s) when your PR is merged.
  • Your change description explains what the change does, why you chose your approach, and anything else that reviewers should know.
  • You have included any necessary tests in the same PR.

This PR implements CausalLMPipelineChatClient<TTokenizer, TCausalLMModel> class for MEAI.IChatClient's intergration.

This PR also refactors the AutoGen and semantic kernel intergretion for Phi3, which pulls out the prompt template parts into an individual Phi3ChatTemplateBuilder class.

This PR also update STJ to 8.0.5 to address a security warning for that package

The CausalLMPipelineChatClient is used as the abstract class for all IChatClient implementation in GenAI models. For now, the following implementations are available

  • Phi3CausalLMChatClient
  • Llama3CausalLMChatClient

The MistralCausalLMChatClient will come in the following PR with additional support for tool call.

Usage

Checkout the MEAI folder under Microsoft.ML.GenAI.Samples` for examples. The following examples are added

  • Llama3_1
  • Phi3

@codecov

codecovBot commented Oct 13, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 33.33333% with 152 lines in your changes missing coverage. Please review.

Project coverage is 68.84%. Comparing base (823fc17) to head (c5b9603).
Report is 10 commits behind head on main.

Files with missing linesPatch %Lines
...rosoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs0.00%48 Missing ⚠️
...osoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs43.83%35 Missing and 6 partials ⚠️
...crosoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs0.00%24 Missing ⚠️
...rosoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs0.00%24 Missing ⚠️
...soft.ML.GenAI.LLaMA/Llama3_1ChatTemplateBuilder.cs69.23%5 Missing and 3 partials ⚠️
...c/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMAgent.cs60.00%6 Missing ⚠️
...enAI.Phi/Phi3/Phi3CausalLMChatCompletionService.cs83.33%1 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #7270 +/- ##
==========================================
+ Coverage 68.81% 68.84% +0.03% 
==========================================
Files 1461 1471 +10 Lines 272405 274124 +1719 Branches 28176 28411 +235 ==========================================
+ Hits 187442 188734 +1292 - Misses 77727 78079 +352 - Partials 7236 7311 +75 
FlagCoverage Δ
Debug68.84% <33.33%> (+0.03%)⬆️
production63.30% <30.27%> (-0.01%)⬇️
test89.18% <100.00%> (+0.10%)⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing linesCoverage Δ
...enAI.Phi/Phi3/Phi3CausalLMTextGenerationService.cs35.71% <100.00%> (+1.56%)⬆️
...st/Microsoft.ML.GenAI.LLaMA.Tests/LLaMA3_1Tests.cs94.73% <100.00%> (+0.79%)⬆️
...enAI.Phi/Phi3/Phi3CausalLMChatCompletionService.cs61.90% <83.33%> (-3.10%)⬇️
...c/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMAgent.cs52.00% <60.00%> (-4.72%)⬇️
...soft.ML.GenAI.LLaMA/Llama3_1ChatTemplateBuilder.cs68.83% <69.23%> (+0.20%)⬆️
...crosoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs0.00% <0.00%> (ø)
...rosoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs0.00% <0.00%> (ø)
...osoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs43.83% <43.83%> (ø)
...rosoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs0.00% <0.00%> (ø)

... and 29 files with indirect coverage changes

@LittleLittleCloudLittleLittleCloud mentioned this pull request Oct 7, 2024
13 tasks
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs
Comment threadsrc/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs
Comment threadsrc/Microsoft.ML.GenAI.Core/Microsoft.ML.GenAI.Core.csproj Outdated
@michaelgsharp

Copy link
Copy Markdown
Contributor

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 2 pipeline(s).

@LittleLittleCloud
LittleLittleCloud merged commit 3659a48 into dotnet:mainNov 5, 2024
@michaelgsharp

Copy link
Copy Markdown
Contributor

/backport to release/4.0

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/4.0: https://github.com/dotnet/machinelearning/actions/runs/11749726947

@github-actions

Copy link
Copy Markdown
Contributor

@michaelgsharp backporting to release/4.0 failed, the patch most likely resulted in conflicts:

$ git am --3way --empty=keep --ignore-whitespace --keep-non-patch changes.patch
Applying: leverage MEAI abstraction
Applying: Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Applying: Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Applying: Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Applying: fix comments
Using index info to reconstruct a base tree...
M	src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
M	src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Falling back to patching base and 3-way merge...
Auto-merging src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Auto-merging src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
CONFLICT (content): Merge conflict in src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0005 fix comments
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

@github-actions

Copy link
Copy Markdown
Contributor

@michaelgsharp an error occurred while backporting to release/4.0, please check the run log for details!

Error: git am failed, most likely due to a merge conflict.

michaelgsharp pushed a commit to michaelgsharp/machinelearning that referenced this pull request Nov 11, 2024
…tnet#7270)
* leverage MEAI abstraction
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* fix comments
* Update Microsoft.ML.GenAI.Core.csproj
---------
Co-authored-by: Stephen Toub <stoub@microsoft.com>
michaelgsharp added a commit that referenced this pull request Nov 11, 2024
) (#7298)
* leverage MEAI abstraction
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
* Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
* fix comments
* Update Microsoft.ML.GenAI.Core.csproj
---------
Co-authored-by: Xiaoyun Zhang <xiaoyuz@microsoft.com>
Co-authored-by: Stephen Toub <stoub@microsoft.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Dec 9, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@LittleLittleCloud@michaelgsharp@stephentoub
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

[GenAI] Introduce CausalLMPipelineChatClient for MEAI.IChatClient - #7270

Merged
LittleLittleCloud merged 7 commits into
dotnet:mainfrom
LittleLittleCloud:u/MEAI
Nov 5, 2024
Merged

[GenAI] Introduce CausalLMPipelineChatClient for MEAI.IChatClient#7270
LittleLittleCloud merged 7 commits into
dotnet:mainfrom
LittleLittleCloud:u/MEAI

Conversation

@LittleLittleCloud

@LittleLittleCloudLittleLittleCloud commented Oct 13, 2024

Copy link
Copy Markdown
Member

We are excited to review your PR.

So we can do the best job, please check:

  • There's a descriptive title that will make sense to other developers some time from now.
  • There's associated issues. All PR's should have issue(s) associated - unless a trivial self-evident change such as fixing a typo. You can use the format Fixes #nnnn in your description to cause GitHub to automatically close the issue(s) when your PR is merged.
  • Your change description explains what the change does, why you chose your approach, and anything else that reviewers should know.
  • You have included any necessary tests in the same PR.

This PR implements CausalLMPipelineChatClient<TTokenizer, TCausalLMModel> class for MEAI.IChatClient's intergration.

This PR also refactors the AutoGen and semantic kernel intergretion for Phi3, which pulls out the prompt template parts into an individual Phi3ChatTemplateBuilder class.

This PR also update STJ to 8.0.5 to address a security warning for that package

The CausalLMPipelineChatClient is used as the abstract class for all IChatClient implementation in GenAI models. For now, the following implementations are available

  • Phi3CausalLMChatClient
  • Llama3CausalLMChatClient

The MistralCausalLMChatClient will come in the following PR with additional support for tool call.

Usage

Checkout the MEAI folder under Microsoft.ML.GenAI.Samples` for examples. The following examples are added

  • Llama3_1
  • Phi3

@codecov

codecovBot commented Oct 13, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 33.33333% with 152 lines in your changes missing coverage. Please review.

Project coverage is 68.84%. Comparing base (823fc17) to head (c5b9603).
Report is 10 commits behind head on main.

Files with missing linesPatch %Lines
...rosoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs0.00%48 Missing ⚠️
...osoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs43.83%35 Missing and 6 partials ⚠️
...crosoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs0.00%24 Missing ⚠️
...rosoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs0.00%24 Missing ⚠️
...soft.ML.GenAI.LLaMA/Llama3_1ChatTemplateBuilder.cs69.23%5 Missing and 3 partials ⚠️
...c/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMAgent.cs60.00%6 Missing ⚠️
...enAI.Phi/Phi3/Phi3CausalLMChatCompletionService.cs83.33%1 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #7270 +/- ##
==========================================
+ Coverage 68.81% 68.84% +0.03% 
==========================================
Files 1461 1471 +10 Lines 272405 274124 +1719 Branches 28176 28411 +235 ==========================================
+ Hits 187442 188734 +1292 - Misses 77727 78079 +352 - Partials 7236 7311 +75 
FlagCoverage Δ
Debug68.84% <33.33%> (+0.03%)⬆️
production63.30% <30.27%> (-0.01%)⬇️
test89.18% <100.00%> (+0.10%)⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing linesCoverage Δ
...enAI.Phi/Phi3/Phi3CausalLMTextGenerationService.cs35.71% <100.00%> (+1.56%)⬆️
...st/Microsoft.ML.GenAI.LLaMA.Tests/LLaMA3_1Tests.cs94.73% <100.00%> (+0.79%)⬆️
...enAI.Phi/Phi3/Phi3CausalLMChatCompletionService.cs61.90% <83.33%> (-3.10%)⬇️
...c/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMAgent.cs52.00% <60.00%> (-4.72%)⬇️
...soft.ML.GenAI.LLaMA/Llama3_1ChatTemplateBuilder.cs68.83% <69.23%> (+0.20%)⬆️
...crosoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs0.00% <0.00%> (ø)
...rosoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs0.00% <0.00%> (ø)
...osoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs43.83% <43.83%> (ø)
...rosoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs0.00% <0.00%> (ø)

... and 29 files with indirect coverage changes

@LittleLittleCloudLittleLittleCloud mentioned this pull request Oct 7, 2024
13 tasks
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs
Comment threadsrc/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs
Comment threadsrc/Microsoft.ML.GenAI.Core/Microsoft.ML.GenAI.Core.csproj Outdated
@michaelgsharp

Copy link
Copy Markdown
Contributor

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 2 pipeline(s).

@LittleLittleCloud
LittleLittleCloud merged commit 3659a48 into dotnet:mainNov 5, 2024
@michaelgsharp

Copy link
Copy Markdown
Contributor

/backport to release/4.0

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/4.0: https://github.com/dotnet/machinelearning/actions/runs/11749726947

@github-actions

Copy link
Copy Markdown
Contributor

@michaelgsharp backporting to release/4.0 failed, the patch most likely resulted in conflicts:

$ git am --3way --empty=keep --ignore-whitespace --keep-non-patch changes.patch
Applying: leverage MEAI abstraction
Applying: Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Applying: Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Applying: Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Applying: fix comments
Using index info to reconstruct a base tree...
M	src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
M	src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Falling back to patching base and 3-way merge...
Auto-merging src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Auto-merging src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
CONFLICT (content): Merge conflict in src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0005 fix comments
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

@github-actions

Copy link
Copy Markdown
Contributor

@michaelgsharp an error occurred while backporting to release/4.0, please check the run log for details!

Error: git am failed, most likely due to a merge conflict.

michaelgsharp pushed a commit to michaelgsharp/machinelearning that referenced this pull request Nov 11, 2024
…tnet#7270)
* leverage MEAI abstraction
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* fix comments
* Update Microsoft.ML.GenAI.Core.csproj
---------
Co-authored-by: Stephen Toub <stoub@microsoft.com>
michaelgsharp added a commit that referenced this pull request Nov 11, 2024
) (#7298)
* leverage MEAI abstraction
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
* Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
* fix comments
* Update Microsoft.ML.GenAI.Core.csproj
---------
Co-authored-by: Xiaoyun Zhang <xiaoyuz@microsoft.com>
Co-authored-by: Stephen Toub <stoub@microsoft.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Dec 9, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@LittleLittleCloud@michaelgsharp@stephentoub
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

[GenAI] Introduce CausalLMPipelineChatClient for MEAI.IChatClient - #7270

Merged
LittleLittleCloud merged 7 commits into
dotnet:mainfrom
LittleLittleCloud:u/MEAI
Nov 5, 2024
Merged

[GenAI] Introduce CausalLMPipelineChatClient for MEAI.IChatClient#7270
LittleLittleCloud merged 7 commits into
dotnet:mainfrom
LittleLittleCloud:u/MEAI

Conversation

@LittleLittleCloud

@LittleLittleCloudLittleLittleCloud commented Oct 13, 2024

Copy link
Copy Markdown
Member

We are excited to review your PR.

So we can do the best job, please check:

  • There's a descriptive title that will make sense to other developers some time from now.
  • There's associated issues. All PR's should have issue(s) associated - unless a trivial self-evident change such as fixing a typo. You can use the format Fixes #nnnn in your description to cause GitHub to automatically close the issue(s) when your PR is merged.
  • Your change description explains what the change does, why you chose your approach, and anything else that reviewers should know.
  • You have included any necessary tests in the same PR.

This PR implements CausalLMPipelineChatClient<TTokenizer, TCausalLMModel> class for MEAI.IChatClient's intergration.

This PR also refactors the AutoGen and semantic kernel intergretion for Phi3, which pulls out the prompt template parts into an individual Phi3ChatTemplateBuilder class.

This PR also update STJ to 8.0.5 to address a security warning for that package

The CausalLMPipelineChatClient is used as the abstract class for all IChatClient implementation in GenAI models. For now, the following implementations are available

  • Phi3CausalLMChatClient
  • Llama3CausalLMChatClient

The MistralCausalLMChatClient will come in the following PR with additional support for tool call.

Usage

Checkout the MEAI folder under Microsoft.ML.GenAI.Samples` for examples. The following examples are added

  • Llama3_1
  • Phi3

@codecov

codecovBot commented Oct 13, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 33.33333% with 152 lines in your changes missing coverage. Please review.

Project coverage is 68.84%. Comparing base (823fc17) to head (c5b9603).
Report is 10 commits behind head on main.

Files with missing linesPatch %Lines
...rosoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs0.00%48 Missing ⚠️
...osoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs43.83%35 Missing and 6 partials ⚠️
...crosoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs0.00%24 Missing ⚠️
...rosoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs0.00%24 Missing ⚠️
...soft.ML.GenAI.LLaMA/Llama3_1ChatTemplateBuilder.cs69.23%5 Missing and 3 partials ⚠️
...c/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMAgent.cs60.00%6 Missing ⚠️
...enAI.Phi/Phi3/Phi3CausalLMChatCompletionService.cs83.33%1 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #7270 +/- ##
==========================================
+ Coverage 68.81% 68.84% +0.03% 
==========================================
Files 1461 1471 +10 Lines 272405 274124 +1719 Branches 28176 28411 +235 ==========================================
+ Hits 187442 188734 +1292 - Misses 77727 78079 +352 - Partials 7236 7311 +75 
FlagCoverage Δ
Debug68.84% <33.33%> (+0.03%)⬆️
production63.30% <30.27%> (-0.01%)⬇️
test89.18% <100.00%> (+0.10%)⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing linesCoverage Δ
...enAI.Phi/Phi3/Phi3CausalLMTextGenerationService.cs35.71% <100.00%> (+1.56%)⬆️
...st/Microsoft.ML.GenAI.LLaMA.Tests/LLaMA3_1Tests.cs94.73% <100.00%> (+0.79%)⬆️
...enAI.Phi/Phi3/Phi3CausalLMChatCompletionService.cs61.90% <83.33%> (-3.10%)⬇️
...c/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMAgent.cs52.00% <60.00%> (-4.72%)⬇️
...soft.ML.GenAI.LLaMA/Llama3_1ChatTemplateBuilder.cs68.83% <69.23%> (+0.20%)⬆️
...crosoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs0.00% <0.00%> (ø)
...rosoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs0.00% <0.00%> (ø)
...osoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs43.83% <43.83%> (ø)
...rosoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs0.00% <0.00%> (ø)

... and 29 files with indirect coverage changes

@LittleLittleCloudLittleLittleCloud mentioned this pull request Oct 7, 2024
13 tasks
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs
Comment threadsrc/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs
Comment threadsrc/Microsoft.ML.GenAI.Core/Microsoft.ML.GenAI.Core.csproj Outdated
@michaelgsharp

Copy link
Copy Markdown
Contributor

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 2 pipeline(s).

@LittleLittleCloud
LittleLittleCloud merged commit 3659a48 into dotnet:mainNov 5, 2024
@michaelgsharp

Copy link
Copy Markdown
Contributor

/backport to release/4.0

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/4.0: https://github.com/dotnet/machinelearning/actions/runs/11749726947

@github-actions

Copy link
Copy Markdown
Contributor

@michaelgsharp backporting to release/4.0 failed, the patch most likely resulted in conflicts:

$ git am --3way --empty=keep --ignore-whitespace --keep-non-patch changes.patch
Applying: leverage MEAI abstraction
Applying: Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Applying: Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Applying: Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Applying: fix comments
Using index info to reconstruct a base tree...
M	src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
M	src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Falling back to patching base and 3-way merge...
Auto-merging src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Auto-merging src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
CONFLICT (content): Merge conflict in src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0005 fix comments
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

@github-actions

Copy link
Copy Markdown
Contributor

@michaelgsharp an error occurred while backporting to release/4.0, please check the run log for details!

Error: git am failed, most likely due to a merge conflict.

michaelgsharp pushed a commit to michaelgsharp/machinelearning that referenced this pull request Nov 11, 2024
…tnet#7270)
* leverage MEAI abstraction
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* fix comments
* Update Microsoft.ML.GenAI.Core.csproj
---------
Co-authored-by: Stephen Toub <stoub@microsoft.com>
michaelgsharp added a commit that referenced this pull request Nov 11, 2024
) (#7298)
* leverage MEAI abstraction
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
* Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
* fix comments
* Update Microsoft.ML.GenAI.Core.csproj
---------
Co-authored-by: Xiaoyun Zhang <xiaoyuz@microsoft.com>
Co-authored-by: Stephen Toub <stoub@microsoft.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Dec 9, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@LittleLittleCloud@michaelgsharp@stephentoub
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

[GenAI] Introduce CausalLMPipelineChatClient for MEAI.IChatClient - #7270

Merged
LittleLittleCloud merged 7 commits into
dotnet:mainfrom
LittleLittleCloud:u/MEAI
Nov 5, 2024
Merged

[GenAI] Introduce CausalLMPipelineChatClient for MEAI.IChatClient#7270
LittleLittleCloud merged 7 commits into
dotnet:mainfrom
LittleLittleCloud:u/MEAI

Conversation

@LittleLittleCloud

@LittleLittleCloudLittleLittleCloud commented Oct 13, 2024

Copy link
Copy Markdown
Member

We are excited to review your PR.

So we can do the best job, please check:

  • There's a descriptive title that will make sense to other developers some time from now.
  • There's associated issues. All PR's should have issue(s) associated - unless a trivial self-evident change such as fixing a typo. You can use the format Fixes #nnnn in your description to cause GitHub to automatically close the issue(s) when your PR is merged.
  • Your change description explains what the change does, why you chose your approach, and anything else that reviewers should know.
  • You have included any necessary tests in the same PR.

This PR implements CausalLMPipelineChatClient<TTokenizer, TCausalLMModel> class for MEAI.IChatClient's intergration.

This PR also refactors the AutoGen and semantic kernel intergretion for Phi3, which pulls out the prompt template parts into an individual Phi3ChatTemplateBuilder class.

This PR also update STJ to 8.0.5 to address a security warning for that package

The CausalLMPipelineChatClient is used as the abstract class for all IChatClient implementation in GenAI models. For now, the following implementations are available

  • Phi3CausalLMChatClient
  • Llama3CausalLMChatClient

The MistralCausalLMChatClient will come in the following PR with additional support for tool call.

Usage

Checkout the MEAI folder under Microsoft.ML.GenAI.Samples` for examples. The following examples are added

  • Llama3_1
  • Phi3

@codecov

codecovBot commented Oct 13, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 33.33333% with 152 lines in your changes missing coverage. Please review.

Project coverage is 68.84%. Comparing base (823fc17) to head (c5b9603).
Report is 10 commits behind head on main.

Files with missing linesPatch %Lines
...rosoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs0.00%48 Missing ⚠️
...osoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs43.83%35 Missing and 6 partials ⚠️
...crosoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs0.00%24 Missing ⚠️
...rosoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs0.00%24 Missing ⚠️
...soft.ML.GenAI.LLaMA/Llama3_1ChatTemplateBuilder.cs69.23%5 Missing and 3 partials ⚠️
...c/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMAgent.cs60.00%6 Missing ⚠️
...enAI.Phi/Phi3/Phi3CausalLMChatCompletionService.cs83.33%1 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #7270 +/- ##
==========================================
+ Coverage 68.81% 68.84% +0.03% 
==========================================
Files 1461 1471 +10 Lines 272405 274124 +1719 Branches 28176 28411 +235 ==========================================
+ Hits 187442 188734 +1292 - Misses 77727 78079 +352 - Partials 7236 7311 +75 
FlagCoverage Δ
Debug68.84% <33.33%> (+0.03%)⬆️
production63.30% <30.27%> (-0.01%)⬇️
test89.18% <100.00%> (+0.10%)⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing linesCoverage Δ
...enAI.Phi/Phi3/Phi3CausalLMTextGenerationService.cs35.71% <100.00%> (+1.56%)⬆️
...st/Microsoft.ML.GenAI.LLaMA.Tests/LLaMA3_1Tests.cs94.73% <100.00%> (+0.79%)⬆️
...enAI.Phi/Phi3/Phi3CausalLMChatCompletionService.cs61.90% <83.33%> (-3.10%)⬇️
...c/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMAgent.cs52.00% <60.00%> (-4.72%)⬇️
...soft.ML.GenAI.LLaMA/Llama3_1ChatTemplateBuilder.cs68.83% <69.23%> (+0.20%)⬆️
...crosoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs0.00% <0.00%> (ø)
...rosoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs0.00% <0.00%> (ø)
...osoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs43.83% <43.83%> (ø)
...rosoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs0.00% <0.00%> (ø)

... and 29 files with indirect coverage changes

@LittleLittleCloudLittleLittleCloud mentioned this pull request Oct 7, 2024
13 tasks
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Core/CausalLMPipelineChatClient.cs
Comment threadsrc/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs Outdated
Comment threadsrc/Microsoft.ML.GenAI.Phi/Phi3/Phi3ChatTemplateBuilder.cs
Comment threadsrc/Microsoft.ML.GenAI.Core/Microsoft.ML.GenAI.Core.csproj Outdated
@michaelgsharp

Copy link
Copy Markdown
Contributor

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 2 pipeline(s).

@LittleLittleCloud
LittleLittleCloud merged commit 3659a48 into dotnet:mainNov 5, 2024
@michaelgsharp

Copy link
Copy Markdown
Contributor

/backport to release/4.0

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/4.0: https://github.com/dotnet/machinelearning/actions/runs/11749726947

@github-actions

Copy link
Copy Markdown
Contributor

@michaelgsharp backporting to release/4.0 failed, the patch most likely resulted in conflicts:

$ git am --3way --empty=keep --ignore-whitespace --keep-non-patch changes.patch
Applying: leverage MEAI abstraction
Applying: Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Applying: Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Applying: Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Applying: fix comments
Using index info to reconstruct a base tree...
M	src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
M	src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Falling back to patching base and 3-way merge...
Auto-merging src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Auto-merging src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
CONFLICT (content): Merge conflict in src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0005 fix comments
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

@github-actions

Copy link
Copy Markdown
Contributor

@michaelgsharp an error occurred while backporting to release/4.0, please check the run log for details!

Error: git am failed, most likely due to a merge conflict.

michaelgsharp pushed a commit to michaelgsharp/machinelearning that referenced this pull request Nov 11, 2024
…tnet#7270)
* leverage MEAI abstraction
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
Co-authored-by: Stephen Toub <stoub@microsoft.com>
* fix comments
* Update Microsoft.ML.GenAI.Core.csproj
---------
Co-authored-by: Stephen Toub <stoub@microsoft.com>
michaelgsharp added a commit that referenced this pull request Nov 11, 2024
) (#7298)
* leverage MEAI abstraction
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
* Update src/Microsoft.ML.GenAI.LLaMA/Llama3CausalLMChatClient.cs
* Update src/Microsoft.ML.GenAI.Phi/Phi3/Phi3CausalLMChatClient.cs
* fix comments
* Update Microsoft.ML.GenAI.Core.csproj
---------
Co-authored-by: Xiaoyun Zhang <xiaoyuz@microsoft.com>
Co-authored-by: Stephen Toub <stoub@microsoft.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Dec 9, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@LittleLittleCloud@michaelgsharp@stephentoub