From b751eeedaf633fa94dde7f734a38d8ba7be12149 Mon Sep 17 00:00:00 2001 From: Jun Date: Wed, 19 Mar 2025 15:46:15 +0800 Subject: [PATCH] Python: Update README.md (#11024) Fixed some potential misspellings/errors. ### Motivation and Context ### Description ### 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: --------- Co-authored-by: Roger Barreto <19890735+RogerBarreto@users.noreply.github.com> --- README.md | 8 ++++---- python/README.md | 10 +++++----- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index cb6bedfd18..85f771ffb2 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ from either OpenAI or Azure OpenAI and to run one of the C#, Python, and Java co ### For C#: 1. Go to the Quick start page [here](https://learn.microsoft.com/en-us/semantic-kernel/get-started/quick-start-guide?pivots=programming-language-csharp) and follow the steps to dive in. -2. After Installing the SDK, we advise you follow the steps and code detailed to write your first console app. +2. After installing the SDK, we advise you follow the steps and code detailed to write your first console app. ![dotnetmap](https://learn.microsoft.com/en-us/semantic-kernel/media/dotnetmap.png) ### For Python: @@ -95,7 +95,7 @@ The Java code is in the [semantic-kernel-java](https://github.com/microsoft/sema [semantic-kernel-java build](https://github.com/microsoft/semantic-kernel-java/blob/main/BUILD.md) for instructions on how to build and run the Java code. -Please file Java Semantic Kernel specific issues in +Please file Java Semantic Kernel-specific issues in the [semantic-kernel-java](https://github.com/microsoft/semantic-kernel-java) repository. ## Learning how to use Semantic Kernel @@ -125,7 +125,7 @@ The Semantic Kernel extension for Visual Studio Code makes it easy to design and ## Join the community -We welcome your contributions and suggestions to SK community! One of the easiest +We welcome your contributions and suggestions to the SK community! One of the easiest ways to participate is to engage in discussions in the GitHub repository. Bug reports and fixes are welcome! @@ -151,7 +151,7 @@ To learn more and get started: This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). -For more information see the +For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. diff --git a/python/README.md b/python/README.md index 166d4ed387..837c22b875 100644 --- a/python/README.md +++ b/python/README.md @@ -23,7 +23,7 @@ Make sure you have an There are two methods to manage keys, secrets, and endpoints: -1. Store them in environment variables. SK Python leverages pydantic settings to load keys, secrets, and endpoints. This means that there is a first attempt to load them from environment variables. The `.env` file naming applies to how the names should be stored as environment variables. +1. Store them in environment variables. SK Python leverages Pydantic settings to load keys, secrets, and endpoints. This means that there is a first attempt to load them from environment variables. The `.env` file naming applies to how the names should be stored as environment variables. 2. If you'd like to use the `.env` file, you will need to configure the `.env` file with the following keys in the file (see the `.env.example` file): @@ -151,7 +151,7 @@ The force is proportional to the product of the two masses and inversely proport # Semantic Kernel Notebooks -The repository contains a few Python and C# notebooks that demonstrates how to +The repository contains a few Python and C# notebooks that demonstrate how to get started with the Semantic Kernel. Python notebooks: @@ -173,10 +173,10 @@ Python notebooks: ## How does Python SK compare to the C# version of Semantic Kernel? -The two SDKs are compatible and at the core they follow the same design principles. -Some features are still available only in the C# version, and being ported +The two SDKs are compatible and at their core they follow the same design principles. +Some features are still available only in the C# version and are being ported. Refer to the [FEATURE MATRIX](../FEATURE_MATRIX.md) doc to see where things stand in matching the features and functionality of the main SK branch. Over time there will be some features available only in the Python version, and -others only in the C# version, for example adapters to external services, +others only in the C# version, for example, adapters to external services, scientific libraries, etc.