[API] Deprecate engine.generate() #541
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
CharlieFRuan
changed the title
CharlieFRuan
added a commit
that referenced
this pull request
Aug 13, 2024
### Changes - #541 - #542 - When single model loaded, no change in behavior - When multiple models loaded, some APIs need to specify which model it is targeting - For more, see PR description (the user-facing section) - Also see `examples/multi-models` ### TVMjs Still compiled at apache/tvm@1fcb620, no change
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.
This PR deprecates
generate()from allMLCEngineInterface. Its usage can be completely covered byengine.chat.completions()for conversation-style generation, andengine.completions()for raw text completion.Specifically for using the above two OpenAI APIs for multi-round chat with KV reuse, see
examples/multi-round-chat.We deprecate this because future changes on the engine (e.g. allowing multiple models to be loaded in engine) would break this
generate()API and require extra effort to maintain.Tested with streaming/non-streaming on MLCEngine/WebWorkerMLCEngine to ensure other APIs are not affected.