Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

.Net: Improved Logging for 06-memory-and-embeddings.ipynb #5638

Merged
merged 4 commits into from
Apr 2, 2024

Conversation

sangyuxiaowu
Copy link
Contributor

Motivation and Context

  1. This change is required to provide a more detailed and readable output from the memory search operation.
  2. It solves the problem of not having enough information about the relevance of the search results.
  3. This change contributes to the scenario where developers are debugging or monitoring the memory search operation, as the enhanced logging will provide more insight into the performance of the search.
  4. This change also facilitates learners to modify the search content and test with the stored vector data.

Description

This PR modifies the logging format in the 06-memory-and-embeddings.ipynb file in the semantic-kernel project. The change involves printing out the question and the corresponding response's relevance and text. This will help developers better understand the relevance information of the memory search results.

Contribution Checklist

@sangyuxiaowu sangyuxiaowu requested a review from a team as a code owner March 25, 2024 16:45
@markwallace-microsoft markwallace-microsoft added the .NET Issue or Pull requests regarding .NET code label Mar 25, 2024
@github-actions github-actions bot changed the title Improved Logging for 06-memory-and-embeddings.ipynb .Net: Improved Logging for 06-memory-and-embeddings.ipynb Mar 25, 2024
@markwallace-microsoft markwallace-microsoft self-assigned this Mar 25, 2024
@markwallace-microsoft markwallace-microsoft added this pull request to the merge queue Apr 2, 2024
Merged via the queue into microsoft:main with commit c65644a Apr 2, 2024
18 checks passed
LudoCorporateShark pushed a commit to LudoCorporateShark/semantic-kernel that referenced this pull request Aug 25, 2024
…5638)

### 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.
-->

1. This change is required to provide a more detailed and readable
output from the memory search operation.
2. It solves the problem of not having enough information about the
relevance of the search results.
3. This change contributes to the scenario where developers are
debugging or monitoring the memory search operation, as the enhanced
logging will provide more insight into the performance of the search.
4. This change also facilitates learners to modify the search content
and test with the stored vector data.

### Description

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

This PR modifies the logging format in the
06-memory-and-embeddings.ipynb file in the semantic-kernel project. The
change involves printing out the question and the corresponding
response's relevance and text. This will help developers better
understand the relevance information of the memory search results.

### 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 😄

Co-authored-by: Mark Wallace <127216156+markwallace-microsoft@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
.NET Issue or Pull requests regarding .NET code
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants