Create the migration guide to v1 #1543
Open
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
rlouf
reviewed
Apr 16, 2025
|
|
||
| ### Text generation return types | ||
|
|
||
| In the previous version of Outlines, the return type of the generators depended on the output type provided. For instance, if you passed a Pydantic model to the `generate.json` function, the return type was a Pydantic model instance. In the v1, the return type of a generator is always a `str`, the raw text generated by the model. You are responsible for parsing the text into the desired format. |
There was a problem hiding this comment.
Either we change this before releasing (cf Cameron's issue), or we can say "for now".
There was a problem hiding this comment.
Related issue for those reading along: #1526
cpfiffer
reviewed
Apr 16, 2025
Comment on lines
+32
to
+39
| For instance, instead of: | ||
|
|
||
| ```python | ||
| from outlines import generate | ||
|
|
||
| model = ... | ||
| generator = generate.choice(model, ["foo", "bar"]) | ||
| ``` |
There was a problem hiding this comment.
Can we add a Pydantic model example here as well?
| ```python | ||
| from outlines import generate | ||
|
|
||
| model = ... |
There was a problem hiding this comment.
We have a few places in here where we omit the model construction (model = ... or model = <transformers model>). I'm wondering we add explicit constructors to continuously hammer the new interface into the reader's mind.
|
|
||
| ### Text generation return types | ||
|
|
||
| In the previous version of Outlines, the return type of the generators depended on the output type provided. For instance, if you passed a Pydantic model to the `generate.json` function, the return type was a Pydantic model instance. In the v1, the return type of a generator is always a `str`, the raw text generated by the model. You are responsible for parsing the text into the desired format. |
There was a problem hiding this comment.
Related issue for those reading along: #1526
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 creates a migration guide to help users of outlines v0 migrate their code to v1. For the location of the file, I followed the organization proposed by @cpfiffer in #1529