Properly close model clients in documentation and samples #5898
Conversation
This file contains hidden or 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
Ensure that model clients are explicitly closed after use to prevent resource leaks.
Contributor
Author
|
@microsoft-github-policy-service agree |
ekzhu
reviewed
Mar 11, 2025
Contributor
ekzhu
left a comment
ekzhu
left a comment
There was a problem hiding this comment.
Thanks for the PR. Two things:
- We can share the model clients across agents. So in many cases we can keep the same usage of a single model client.
agent.close()doesn't close the model clients, so we should change those to callcloseon the model clinet.
...es/autogen-core/docs/src/user-guide/core-user-guide/design-patterns/multi-agent-debate.ipynb
Outdated
Show resolved
Hide resolved
- Added shared model clients across agents - Remove `agent.close()`
Fixed `memory.ipynb` file after incurring in merge conflict issues.
Contributor
Author
|
@ekzhu thank you for the feedback. I’ve addressed both points in the updates. Let me know if further adjustments are needed! |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5898 +/- ##
=======================================
Coverage 76.73% 76.73%
=======================================
Files 191 191
Lines 13170 13170
=======================================
Hits 10106 10106
Misses 3064 3064
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
ekzhu
approved these changes
Mar 18, 2025
Contributor
|
Just a few more lint errors |
- Added `model_client` param in `migration_guide.md` - Moved model client initialization to `main` function of chess game example.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Why are these changes needed?
These changes ensures that the model clients in the documentation and samples are explicitly closed to prevent resource leaks and avoid runtime errors.
Refs:
Related issue number
Closes #5873
Checks