Improve readme inconsistency #5691
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (1)
README.md:128
- [nitpick] The 'Tutorial' row still displays a 'Quickstart' badge in the studio column. It would improve consistency if this badge text were updated to reflect 'Tutorial' instead.
| Tutorial | [](https://microsoft.github.io/autogen/stable/user-guide/agentchat-user-guide/tutorial/index.html) | [](https://microsoft.github.io/autogen/dotnet/dev/core/tutorial.html) | [](https://microsoft.github.io/autogen/stable/user-guide/autogenstudio-user-guide/usage.html#) |
rysweet
approved these changes
Feb 24, 2025
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5691 +/- ##
=======================================
Coverage 75.66% 75.67%
=======================================
Files 171 171
Lines 10576 10576
=======================================
+ Hits 8002 8003 +1
+ Misses 2574 2573 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
kadenbking
added a commit
to kadenbking/autogen
that referenced
this pull request
Feb 25, 2025
* doc: Enrich AssistantAgent API documentation with usage examples. (microsoft#5653) Resolves microsoft#5562 * remove dep on aspire - add google.protobuf (microsoft#5645) <!-- Thank you for your contribution! Please review https://microsoft.github.io/autogen/docs/Contribute before opening a pull request. --> <!-- Please add a reviewer to the assignee section when you create a PR. If you don't have the access to it, we will shortly find a reviewer and assign them to your PR. --> ## Why are these changes needed? <!-- Please give a short summary of the change and the problem this solves. --> removes unneeded deps ## Related issue number <!-- For example: "Closes microsoft#1234" --> Closes microsoft#5644 ## Checks - [ ] I've included any doc changes needed for <https://microsoft.github.io/autogen/>. See <https://github.com/microsoft/autogen/blob/main/CONTRIBUTING.md> to build and test documentation locally. - [ ] I've added tests (if relevant) corresponding to the changes introduced in this PR. - [ ] I've made sure all auto checks have passed. * [dotnet] Add mixin for easier state save/load apis (microsoft#5438) Co-authored-by: Ryan Sweet <rysweet@microsoft.com> * Replace the undefined tools variable with tool_schema parameter in ToolUseAgent class (microsoft#5684) Replace the undefined `tools` variable with `tool_schema` parameter <!-- Thank you for your contribution! Please review https://microsoft.github.io/autogen/docs/Contribute before opening a pull request. --> <!-- Please add a reviewer to the assignee section when you create a PR. If you don't have the access to it, we will shortly find a reviewer and assign them to your PR. --> ## Why are these changes needed? This change keeps the documentation up to date : https://microsoft.github.io/autogen/stable//user-guide/core-user-guide/components/tools.html <!-- Please give a short summary of the change and the problem this solves. --> ## Related issue number <!-- For example: "Closes microsoft#1234" --> ## Checks - [ ] I've included any doc changes needed for <https://microsoft.github.io/autogen/>. See <https://github.com/microsoft/autogen/blob/main/CONTRIBUTING.md> to build and test documentation locally. - [x] I've added tests (if relevant) corresponding to the changes introduced in this PR. - [ ] I've made sure all auto checks have passed. * Improve readme inconsistency (microsoft#5691) ### Before <img width="823" alt="image" src="https://github.com/user-attachments/assets/d5ba1671-9433-4fa4-9884-c0de6fafb82e" /> ### After <img width="803" alt="image" src="https://github.com/user-attachments/assets/07fdd32a-d2ad-450d-8b7f-b21f10f14c85" /> * pack agenthost as tool (microsoft#5647) <!-- Thank you for your contribution! Please review https://microsoft.github.io/autogen/docs/Contribute before opening a pull request. --> <!-- Please add a reviewer to the assignee section when you create a PR. If you don't have the access to it, we will shortly find a reviewer and assign them to your PR. --> ## Why are these changes needed? convenience - allows to just run "agenthost" ``` dotnet pack --no-build --configuration Release --output './output/release' -bl\n dotnet tool install --add-source ./output/release Microsoft.AutoGen.AgentHost agenthost ``` <!-- Please give a short summary of the change and the problem this solves. --> ## Related issue number <!-- For example: "Closes microsoft#1234" --> closes microsoft#5646 ## Checks - [ ] I've included any doc changes needed for <https://microsoft.github.io/autogen/>. See <https://github.com/microsoft/autogen/blob/main/CONTRIBUTING.md> to build and test documentation locally. - [ ] I've added tests (if relevant) corresponding to the changes introduced in this PR. - [ ] I've made sure all auto checks have passed. * update versions to 0.4.8 (microsoft#5689) * Update issue templates (microsoft#5686) * doc & sample: Update documentation for human-in-the-loop and UserProxyAgent; Add UserProxyAgent to ChainLit sample; (microsoft#5656) Resolves microsoft#5610 And address various questions regarding to how to use user proxy agent and human-in-the-loop. * doc: Update SelectorGroupChat doc on how to use O3-mini model. (microsoft#5657) Resolves microsoft#5408 Co-authored-by: Jack Gerrits <jackgerrits@users.noreply.github.com> * Add metadata field to basemessage (microsoft#5372) Add metadata field to BaseMessage. Why? - additional metadata field can track 1) timestamp if needed, 2) flags about the message. For instance, a use case is a metadata field {"internal":"yes"} that would hide messages from being displayed in an application or studio. As long as an extra field is added to basemessage that is not consumed by existing agents, I am happy. Notes: - We can also only add it to BaseChatMessage, that would be fine - I don't care what the extra field is called as long as there is an extra field somewhere - I don't have preference for the type, a str could work, but a dict would be more useful. --------- Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com> * Change base image to one with arm64 support (microsoft#5681) --------- Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com> Co-authored-by: Ryan Sweet <rysweet@microsoft.com> Co-authored-by: Jack Gerrits <jackgerrits@users.noreply.github.com> Co-authored-by: Shubham Shukla <shubhamshkl@gmail.com> Co-authored-by: gagb <gagb@users.noreply.github.com> Co-authored-by: Hussein Mozannar <hmozannar@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before
After