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

Document Migration to TransformMessages #2247

Merged
merged 21 commits into from
Apr 9, 2024

Conversation

WaelKarkoub
Copy link
Contributor

@WaelKarkoub WaelKarkoub commented Apr 2, 2024

Why are these changes needed?

This PR clarifies the migration from TransformChatHistory and CompressibleAgent to TransformMessages to users:

  • Added a detailed guide on how to use TransformMessages to handle long contexts.
  • Updates the site with the appropriate FAQ.
  • Update compressible agent with a proper deprecation notice

NOTE: #2256 handles some of the migration by linking the new notebooks in website/docs/Examples.md

NOTE 2: I couldn't render the website locally (probably because I couldn't install quatro on a Fedora machine), so I'm not sure how the blog looks. I plan to try again using Docker later on.

Related issue number

Checks

@codecov-commenter
Copy link

codecov-commenter commented Apr 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 50.06%. Comparing base (4a44093) to head (a2388d4).

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #2247       +/-   ##
===========================================
+ Coverage   38.14%   50.06%   +11.92%     
===========================================
  Files          78       78               
  Lines        7865     7867        +2     
  Branches     1683     1821      +138     
===========================================
+ Hits         3000     3939      +939     
+ Misses       4615     3599     -1016     
- Partials      250      329       +79     
Flag Coverage Δ
unittest 14.21% <0.00%> (?)
unittests 49.04% <100.00%> (+10.90%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@ekzhu ekzhu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR removes some significant chunks of code. I suggest use 3-step approach:

  1. Add documentation for new API, remove old code from documentation, and add an FAQ entry about the migration.
  2. Add depreciation notices to the old code and specify a future release version after which it will be removed.
  3. Remove the old code starting the target release version.

website/docs/topics/long_contexts.md Outdated Show resolved Hide resolved
Copy link
Contributor

@giorgossideris giorgossideris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for not including the comment above before. Excluding this point I think it is at a good state.

website/docs/topics/long_contexts.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@gagb gagb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good! Thank you!

@sonichi
Copy link
Contributor

sonichi commented Apr 9, 2024

@ekzhu this PR is blocked by your change request.

Copy link
Contributor

@qingyun-wu qingyun-wu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks!

@qingyun-wu qingyun-wu added this pull request to the merge queue Apr 9, 2024
Merged via the queue into main with commit eca6c04 Apr 9, 2024
63 of 75 checks passed
@qingyun-wu qingyun-wu deleted the deprecate-chat-history-transform branch April 9, 2024 16:37
whiskyboy pushed a commit to whiskyboy/autogen that referenced this pull request Apr 17, 2024
* wip

* tweaks

* undo fix

* undo removal

* adds to FAQ

* modify docs

* undo formatter

* updates docs

* update deprec notice in compressible agent

* restore notebooks

* giorgossideris comments

* cleanup

* resolve comments

* improve english

* improve english

* cleanup

---------

Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants