Skip to content

Commit db2c1ef

Browse files
lightningRalfdluc
andauthored
corrected python documentation (microsoft#501)
### Motivation and Context 1. Why is this change required? prompts are not semantic functions with input <-> other way round 2. What problem does it solve? clearer understanding 3. What scenario does it contribute to? documentation ### Description - corrected wording - added a table for Q&A ### Contribution Checklist - [x] I didn't break anyone 😄 --------- Co-authored-by: Devis Lucato <[email protected]> Co-authored-by: Devis Lucato <[email protected]>
1 parent 4e924ef commit db2c1ef

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

python/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Give me the TLDR in exactly 5 words.""")
5656
print(prompt()) # => Robots must not harm humans.
5757
```
5858

59-
# Prompts are **semantic functions** with input parameters
59+
# **Semantic functions** are Prompts with input parameters
6060

6161
```python
6262
# Create a reusable function with one input parameter
@@ -99,14 +99,14 @@ Python notebooks:
9999
* [Using Context Variables to Build a Chat Experience](../samples/notebooks/python/04-context-variables-chat.ipynb)
100100
* [Building Memory with Embeddings](../samples/notebooks/python/06-memory-and-embeddings.ipynb)
101101

102-
# Frequently asked questions
102+
# SK Frequently Asked Questions
103103

104-
* How does Python SK compare to the C# version of Semantic Kernel?
104+
## How does Python SK compare to the C# version of Semantic Kernel?
105105

106-
The two SDKs are compatible and at the core they follow the same design principles.
107-
Some features are still available only in the C# version, and being ported
108-
Refer to the [FEATURE PARITY](FEATURE_PARITY.md) doc to see where
109-
things stand in matching the features and functionality of the main SK branch.
110-
Over time there will be some features available only in the Python version, and
111-
others only in the C# version, for example adapters to external services,
112-
scientific libraries, etc.
106+
The two SDKs are compatible and at the core they follow the same design principles.
107+
Some features are still available only in the C# version, and being ported
108+
Refer to the [FEATURE PARITY](FEATURE_PARITY.md) doc to see where
109+
things stand in matching the features and functionality of the main SK branch.
110+
Over time there will be some features available only in the Python version, and
111+
others only in the C# version, for example adapters to external services,
112+
scientific libraries, etc.

0 commit comments

Comments
 (0)