From 48b6e2a44c454e474b6c296ab42b75a0991838d6 Mon Sep 17 00:00:00 2001 From: Mark Wallace <127216156+markwallace-microsoft@users.noreply.github.com> Date: Fri, 22 Sep 2023 13:57:00 +0100 Subject: [PATCH] .Net: Rename 'Skills' -> 'Plugins' - Part 7 Update .md files terminology from SKILLS to PLUGINS (#2939) ### Motivation and Context Replace `Skill` with `Plugin` in docs and dotnet readme's ### Contribution Checklist - [ ] The code builds clean without any errors or warnings - [ ] The PR follows the [SK Contribution Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md) and the [pre-submission formatting script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts) raises no violations - [ ] All unit tests pass, and I have added new tests where possible - [ ] I didn't break anyone :smile: ## Summary This set of commits updates the terminology used in the project from SKILLS to PLUGINS. SKILLS have been renamed to PLUGINS throughout the codebase, and related documentation and comments have been updated accordingly. Additionally, the telemetry metrics have been updated to reflect the new naming convention. ## Changes - Rename SKILLS to PLUGINS throughout the codebase - Update related documentation and comments - Update telemetry metrics to reflect new naming convention --- *Powered by [Microsoft Semantic Kernel](https://github.com/microsoft/semantic-kernel)* --- docs/GLOSSARY.md | 10 +++++----- docs/{SKILLS.md => PLUGINS.md} | 0 dotnet/README.md | 14 +++++++------- dotnet/docs/TELEMETRY.md | 16 ++++++++-------- 4 files changed, 20 insertions(+), 20 deletions(-) rename docs/{SKILLS.md => PLUGINS.md} (100%) diff --git a/docs/GLOSSARY.md b/docs/GLOSSARY.md index 93f4a7c5aa..53ff349789 100644 --- a/docs/GLOSSARY.md +++ b/docs/GLOSSARY.md @@ -3,19 +3,19 @@ To wrap your mind around the concepts we present throughout the kernel, here is a glossary of commonly used terms -**Semantic Kernel (SK)** - The orchestrator that fulfills a user's ASK with SK's available [SKILLS](SKILLS.md). +**Semantic Kernel (SK)** - The orchestrator that fulfills a user's ASK with SK's available [PLUGINS](PLUGINS.md). **Ask** - What a user requests to the Semantic Kernel to help achieve the user's goal. - "We make ASKs to the SK" -**Skill** - A domain-specific collection made available to the SK as a group of finely-tuned functions. +**Plugins** - A domain-specific collection made available to the SK as a group of finely-tuned functions. -- "We have a SKILL for using Office better" +- "We have a PLUGIN for using Office better" -**Function** - A computational machine comprised of Semantic AI and/or native code that's available in a [SKILL](SKILLS.md). +**Function** - A computational machine comprised of Semantic AI and/or native code that's available in a [PLUGIN](PLUGINS.md). -- "The Office SKILL has many FUNCTIONS" +- "The Office PLUGIN has many FUNCTIONS" **Native Function** - expressed with traditional computing language (C#, Python, Typescript) and easily integrates with SK diff --git a/docs/SKILLS.md b/docs/PLUGINS.md similarity index 100% rename from docs/SKILLS.md rename to docs/PLUGINS.md diff --git a/dotnet/README.md b/dotnet/README.md index 97388ca07a..85e2f3ff48 100644 --- a/dotnet/README.md +++ b/dotnet/README.md @@ -117,7 +117,7 @@ requirements and setup instructions. # Nuget packages Semantic Kernel provides a set of nuget packages to allow extending the core with -more features, such as connectors to services and Skills to perform specific actions. +more features, such as connectors to services and plugins to perform specific actions. Unless you need to optimize which packages to include in your app, you will usually start by installing this meta-package first: @@ -139,14 +139,14 @@ Packages included in **Microsoft.SemanticKernel**: Other SK packages available at nuget.org: 1. **Microsoft.SemanticKernel.Connectors.Memory.Qdrant**: Qdrant connector for - skills and semantic memory. + plugins and semantic memory. 2. **Microsoft.SemanticKernel.Connectors.Memory.Sqlite**: SQLite connector for - skills and semantic memory -3. **Microsoft.SemanticKernel.Skills.Document**: Document Skill: Word processing, + plugins and semantic memory +3. **Microsoft.SemanticKernel.Plugins.Document**: Document Plugin: Word processing, OpenXML, etc. -4. **Microsoft.SemanticKernel.Skills.MsGraph**: Microsoft Graph Skill: access your +4. **Microsoft.SemanticKernel.Plugins.MsGraph**: Microsoft Graph Plugin: access your tenant data, schedule meetings, send emails, etc. -5. **Microsoft.SemanticKernel.Skills.OpenAPI**: OpenAPI skill. -6. **Microsoft.SemanticKernel.Skills.Web**: Web Skill: search the web, download +5. **Microsoft.SemanticKernel.Plugins.OpenAPI**: OpenAPI Plugin. +6. **Microsoft.SemanticKernel.Plugins.Web**: Web Plugin: search the web, download files, etc. 7. **Microsoft.SemanticKernel.Reliability.Polly**: Extension for http resiliency. diff --git a/dotnet/docs/TELEMETRY.md b/dotnet/docs/TELEMETRY.md index 4a171f7da1..a031ffb26a 100644 --- a/dotnet/docs/TELEMETRY.md +++ b/dotnet/docs/TELEMETRY.md @@ -71,11 +71,11 @@ Available meters: - `SK.Plan.Execution.ExecutionTotal` - total number of plan executions - `SK.Plan.Execution.ExecutionSuccess` - number of successful plan executions - `SK.Plan.Execution.ExecutionFailure` - number of failed plan executions -- _Microsoft.SemanticKernel.SkillDefinition.SKFunction_ - captures metrics for `SKFunction`. List of metrics: - - `SK..ExecutionTime` - function execution time (in milliseconds) - - `SK..ExecutionTotal` - total number of function executions - - `SK..ExecutionSuccess` - number of successful function executions - - `SK..ExecutionFailure` - number of failed function executions +- _Microsoft.SemanticKernel.SKFunction_ - captures metrics for `SKFunction`. List of metrics: + - `SK..ExecutionTime` - function execution time (in milliseconds) + - `SK..ExecutionTotal` - total number of function executions + - `SK..ExecutionSuccess` - number of successful function executions + - `SK..ExecutionFailure` - number of failed function executions - _Microsoft.SemanticKernel.Connectors.AI.OpenAI_ - captures metrics for OpenAI functionality. List of metrics: - `SK.Connectors.OpenAI.PromptTokens` - number of prompt tokens used. - `SK.Connectors.OpenAI.CompletionTokens` - number of completion tokens used. @@ -115,7 +115,7 @@ instrument.Meter.Name.StartsWith("Microsoft.SemanticKernel", StringComparison.Or It's also possible to subscribe to specific meter. Following condition will allow to subscribe to meter for `SKFunction` only: ```csharp -instrument.Meter.Name.Equals("Microsoft.SemanticKernel.SkillDefinition.SKFunction", StringComparison.Ordinal) +instrument.Meter.Name.Equals("Microsoft.SemanticKernel.SKFunction", StringComparison.Ordinal) ``` ## Tracing @@ -128,7 +128,7 @@ Available activity sources: - _Microsoft.SemanticKernel.Planning.Sequential.InstrumentedSequentialPlanner_ - creates activities for `SequentialPlanner`. - _Microsoft.SemanticKernel.Planning.Stepwise.StepwisePlanner_ - creates activities for `StepwisePlanner`. - _Microsoft.SemanticKernel.Planning.Plan_ - creates activities for `Plan`. -- _Microsoft.SemanticKernel.SkillDefinition.SKFunction_ - creates activities for `SKFunction`. +- _Microsoft.SemanticKernel.SKFunction_ - creates activities for `SKFunction`. ### Examples @@ -152,5 +152,5 @@ activitySource.Name.StartsWith("Microsoft.SemanticKernel", StringComparison.Ordi It's also possible to subscribe to specific activity source. Following condition will allow to subscribe to activity source for `SKFunction` only: ```csharp -activitySource.Name.Equals("Microsoft.SemanticKernel.SkillDefinition.SKFunction", StringComparison.Ordinal) +activitySource.Name.Equals("Microsoft.SemanticKernel.SKFunction", StringComparison.Ordinal) ```