Commit Graph
38 Commits
Author SHA1 Message Date
Devis Lucato ab35598ef4 Update README.md (#3287)
Update docs about Kernel Memory
2023-10-24 12:19:35 -07:00
7677dc0c61 Fix typo in README.md (#2692)
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

### Description
projoect -> project
<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [x] 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
- [x] I didn't break anyone 😄

Co-authored-by: Dmytro Struk <[email protected]>
Co-authored-by: Lee Miller <[email protected]>
2023-09-05 19:14:25 +00:00
nacharya1 317725efea Update README.md (#2631)
Added comment to promote staring of the repo

### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required? Adding callout to star repo
  2. What problem does it solve? understand trending of repo
  3. What scenario does it contribute to? community feedback
  4. If it fixes an open issue, please link to the issue here.
-->

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [x] 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
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄
2023-08-29 19:07:14 +00:00
Matthew Bolaños 2b82637c15 Update readme (#2313)
### Motivation and Context
This update cleans up the initial readme and provides additional links
to documentation and other Semantic Kernel projects.


### 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 😄
2023-08-09 14:39:57 +00:00
Matthew Bolaños 54ee340ca2 Python: Move notebooks into language folders (#2368)
### Motivation and Context
In an effort to move all samples to their respective language folder,
I've moved all of the notebooks to the correct language folder.


### 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 😄
2023-08-09 14:29:56 +00:00
Mark Wallace 5885b95d00 Add Java to the getting started section (#2110)
### Motivation and Context

Please help reviewers and future users, providing the following
information:
1. Why is this change required? Update the readme to include getting
started information for the Java version.

### Description
Preview the file to see the changes.

### Contribution Checklist

- [x] The code builds clean without any errors or warnings
- [x] 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#dev-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄
2023-07-27 16:55:49 +00:00
Matthew Bolaños 39395422b6 Create pointers to learn.microsoft.com (#2159)
### Motivation and Context
To align docs, we should redirect developers to the documents on the
official learn site.

### Description
- Create redirects for docs files in repo that point users to
learn.microsoft.com.
- Update readme links to point to learn.microsoft.com

### 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 😄
2023-07-25 22:41:13 +00:00
Alex ChaoandAlex Chao d454735d5b Python: Update Python README and FEATURE_MATRIX (#2004)
Update the README for Python to include latest notebooks and add a link
to Learn Documentation site for the feature matrix

---------

Co-authored-by: Alex Chao <achao@achao>
2023-07-17 16:42:03 +00:00
MixeroTN 69fb41131d Improve README.md (#1870)
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

`README.md` had several visual problems, which I decided to fix.

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

- The first problem was a `dotnet-ci` status badge, which is no longer
available. I replaced it with two status badges: `dotnet-ci-docker` and
`dotnet-ci-windows`.
- The second one was *Using Semantic Kernel in C# and Python*. The icons
were positioned out of place. I have made a small table with the icons
and hyperlinks present earlier.
- And finally, small corrections such as h3 lines for C# and Python
approaches above *getting started with the basics* instructions.

### Contribution Checklist
<!-- Before submitting this PR, please make sure: -->
- [x] The code builds clean without any errors or warnings
- [x] The PR follows SK Contribution Guidelines
(https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
- [x] The code follows the .NET coding conventions
(https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions)
verified with `dotnet format`
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄
2023-07-06 16:27:36 +00:00
527d3782f8 [README] Add community calendar link to the main README (#1662)
Adding the SK Community calendar to the main README for office hours and
community events

### Motivation and Context
<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->


### Description
<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->


### Contribution Checklist
<!-- Before submitting this PR, please make sure: -->
- [ ] The code builds clean without any errors or warnings
- [ ] The PR follows SK Contribution Guidelines
(https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
- [ ] The code follows the .NET coding conventions
(https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions)
verified with `dotnet format`
- [ ] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄

---------

Co-authored-by: Alex Chao <achao@achao>
Co-authored-by: Shawn Callegari <[email protected]>
2023-06-25 23:05:11 +00:00
nacharya1 e874fe767a Update to main readme to add SK Deploy to Azure as Web App (#1184) 2023-05-23 11:14:10 -07:00
Shawn Callegari c0ab238f58 Azure Functions net7.0 Support (#1126)
### Description
KernelHttpServer Azure Functions project targets net6.0. Building with
net7.0 SDK succeeds, but then running it in an environment with only a
net7.0 runtime installed fails, as it requires the net6.0 runtime to
boot.

With this change, we apply the `<RollForward>LatestMajor</RollForward>`
MSBuild tag to the KernelHttpServer csproj file. This instructs the
project to target the highest version of dotnet installed (min net6.0).
2023-05-22 14:36:58 -07:00
nacharya1andHarleen Thind e33e195ad4 Updates to main readme to remove top image and add call outs for plug-ins (#1155)
### Motivation and Context
<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required? Removed outdates top image
2. What problem does it solve? not giving readers inaccurate information
3. What scenario does it contribute to? new developers learning about SK
  4. If it fixes an open issue, please link to the issue here.
-->


### Description
<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->
N/A

### Contribution Checklist
<!-- Before submitting this PR, please make sure: -->
- [x] The code builds clean without any errors or warnings
- [x] The PR follows SK Contribution Guidelines
(https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
- [x] The code follows the .NET coding conventions
(https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions)
verified with `dotnet format`
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄

---------

Co-authored-by: Harleen Thind <[email protected]>
2023-05-22 19:38:51 +00:00
Vivien Hung f627566907 Fix Yarn link and add QnA in CopilotChat (#1124)
### Motivation and Context
Copilot Chat uses packages that can only be supported by Yarn v1.x.
However, we have multiple reported cases where customers follow the
instructions to install the wrong version of Yarn that causes errors in
the Copilot Chat app.


### Description
1. Update the Semantic Kernel top README to use classic Yarn
installation link.
2. Add Troubleshooting guidance for Yarn 2.x+ in Copilot Chat README.


### Contribution Checklist
<!-- Before submitting this PR, please make sure: -->
- [x] The code builds clean without any errors or warnings
- [x] The PR follows SK Contribution Guidelines
(https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
~- [ ] The code follows the .NET coding conventions
(https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions)
verified with `dotnet format`~
~- [ ] All unit tests pass, and I have added new tests where possible~
- [x] I didn't break anyone 😄
2023-05-19 20:56:33 -07:00
nacharya1andHarleen Thind fa9d388fe5 Update to Readme.MD Note (#1068)
### Motivation and Context
<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
1. Why is this change required? Update to notice due to the evolution of
this project
2. What problem does it solve? Notice to inform that Semantic Kernel
will continue to evolve rapidly
3. What scenario does it contribute to? Sets precedent of current status
of project and on-going changes in velocity.
  4. If it fixes an open issue, please link to the issue here.
-->


### Description
<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->
Changes to update main readme.md notice.

### Contribution Checklist
<!-- Before submitting this PR, please make sure: -->
- [x] The code builds clean without any errors or warnings
- [x] The PR follows SK Contribution Guidelines
(https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
- [x] The code follows the .NET coding conventions
(https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions)
verified with `dotnet format`
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄

Co-authored-by: Harleen Thind <[email protected]>
2023-05-18 18:16:08 +00:00
Devis Lucato e8cca62c7a Update packages' and planning docs (#852)
* Fix #735: broken links in pip README. Sync nuget and pip readmes.
* Update planning doc, use plural for "planners".
* Add RAG to list of patterns supported by SK.
2023-05-08 00:39:38 -07:00
Abby Harrison c2b3a6bf7a Feature matrix improvements (#509)
### Motivation and Context
With the official publishing of the Python Semantic Kernel, we should be
informing the public of feature parity between Python and C#. Python is
currently playing catch up.


### Description
Removed the FEATURE_PARITY.md file from the python directory and added a
FEATURE_MATRIX.md file to the top level of the repo. The main REAME.md
now links to this file. Added a stronger breakdown of features that we
are tracking for SK.
2023-04-18 23:41:26 -07:00
lightningRalf 1b9efa954e changed name_of_button+discord_logo+color (#498)
### Motivation and Context
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?                 -> more consistancy
2. What problem does it solve? -> make it clear on the button that
discord is used
  3. What scenario does it contribute to?     -> visibility of discord

### Description
- changed name of button
  + the color to match it with the 'Kernel' color.
  + added discord logo
2023-04-18 14:36:08 +00:00
Devis Lucato b2be938e4f Fix typos and improve docs (#447)
### Motivation and Context

Fix typos and improve docs.
2023-04-13 17:43:34 -07:00
Devis Lucato e2e5e2dad3 Python: docs update + ruff config + fix tests 2023-04-13 16:12:36 -07:00
Devis Lucato 5fc05b2bea * Update notebooks to use pip package
* Add python getting started notebook
* Fix notebooks usage of Azure text completion
* Fix bug with skills definition
* Update READMEs
* New release version 0.2.2
2023-04-13 16:12:36 -07:00
d4335a7518 Update README.md (#399)
Updated readme to include Copilot Chat.

---------

Co-authored-by: Devis Lucato <[email protected]>
Co-authored-by: Devis Lucato <[email protected]>
Co-authored-by: Adrian Bonar <[email protected]>
2023-04-12 12:37:29 -07:00
Devis Lucato 0d9727a385 Update readme (#376)
Change code example, fix typo, reduce lenght
2023-04-09 17:40:30 -07:00
Devis Lucato 43bc6f5452 Sync README with nuget (#327)
Update README with latest syntax from new nuget
2023-04-04 22:18:44 +00:00
Jeff Kramer cf1d2b4911 Update README.md (#263)
Fix README to reflect the content of the latest nuget (AddAzureOpenAITextCompletion call and required libs)
2023-03-31 18:14:41 -07:00
Devis Lucato 215933efaa Name refactoring + move OpenAI code to Connectors namespace (#204)
### Motivation and Context

Cleaning up tech debt as per plan, last couple of months

* Moved OpenAI code to Connectors namespace
* Label => Service Id
* Backend => Service / Connector
* EmbeddingGenerator => EmbeddingGeneration / TextEmbeddingGeneration
2023-03-30 11:29:56 -07:00
Devis Lucato ab80c7c92d Update README and lock notebooks to 0.9 (#206)
### Motivation and Context

Update README with new API.
Lock notebooks to 0.9 so we can release new APIs breaking notebooks.
2023-03-29 10:13:42 -07:00
b89c0faf6c Sample 4: Using memory and embeddings with GitHub (#94) (#96)
### Motivation and Context
This sample continues in the spirit of prior samples in the samples/apps
folder with a goal of teaching developers how the concepts of memory and
embeddings can be integrated.

### Description
This sample includes a frontend app that allows the developer to enter
the address of a publicly available Github repository, which is
downloaded to the temp directory of the machine hosting the
KernelHttpService sample application (can be the same machine).

Once downloaded the developer is able to have a conversation with the
repository and see the impact of the relevance slider on the responses.

---------

Co-authored-by: Craig Presti <[email protected]>
Co-authored-by: teresaqhoang <[email protected]>
Co-authored-by: markwallace-microsoft <[email protected]>
Co-authored-by: Tao Chen <[email protected]>
Co-authored-by: Mark Wallace <[email protected]>
Co-authored-by: Devis Lucato <[email protected]>
Co-authored-by: Devis Lucato <[email protected]>
Co-authored-by: Adrian Bonar <[email protected]>
2023-03-21 19:28:27 -07:00
Devis Lucato 5d1ef668b0 Add Discord widget to Readme (#101)
Add Discord widget to Readme
2023-03-17 17:26:31 -07:00
Shawn Callegari fadbf4532a Add python-preview link to README (#92)
Adding notice to Python developers and link to python-preview branch
2023-03-17 00:17:30 -07:00
Devis Lucato d6fd667581 Readme updates (#91)
Update dotnet install instuctions and add a link to help with Azure
OpenAI setup
2023-03-16 19:17:42 -07:00
Shawn Callegari 2a113cbb12 Update main README.md links to public docs site (#90)
Updating links on main readme.

### Contribution Checklist

- [X] The code builds clean without any errors or warnings
- [X] The PR follows SK Contribution Guidelines
(https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
- [X] The code follows the .NET coding conventions
(https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions)
verified with `dotnet format`
- [X] All unit tests pass, and I have added new tests where possible
- [X] I didn't break anyone 😄
2023-03-16 18:03:40 -07:00
Devis Lucato e0d6a3c96e Invite people to collaborate :-) (#57)
### Motivation and Context

The project is very early and we want to hear feedback from everyone.
Adding a more visible note early in the README is important to boost
collaboration and to improve SK.

### Description

Extend the note in the README with links inviting the community to work
together.
2023-03-10 13:30:55 -08:00
Alex Chao 1ed81a4d3a Add line to README that project is alpha (#40)
### Motivation and Context
Communicate to the community that the Semantic Kernel is an early preview and will rapidly
evolve. Also invite the community to build the project together.
2023-03-09 11:08:49 -08:00
Devis Lucato 61ee601f91 Add nuget and license badges to README (#24)
Add a couple of badges to the README. There are a few more we can add
later.
2023-03-03 17:55:14 -08:00
Devis Lucato 4a496ecf5d Improve README notes about .NET version, and allow to run samples with .net6 and .net7, (#11)
Make sure users can run all the examples in case they have only .NET 7
installed.
Clarify the .NET version requirements. While SK works fine with .NET
Core 3.1, that version is not supported and builds would throw several
warning about untested dependencies.
2023-03-01 12:02:13 -08:00
Devis Lucato fe0be192ab Update docs (#3)
Improve the main readme, supporting both users willing to clone and run
samples, developers looking to create a new app using the nuget package,
and contributors looking for ways to participate.

Added additional technical docs, explaining some important concepts and
touching on various aspects of the project, e.g. architecture and
nomenclature.
2023-02-28 13:04:22 -08:00
Devis Lucato 89fe9a9ce3 First commit, let the journey begin! 2023-02-24 16:38:23 -08:00