DOC Add section on compatibility of skops format #332
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
1. Promise to not break backwards compatibility 2. Warning about using skops main for persistence
|
@skops-dev/maintainers ready for review, the added section is here. |
adrinjalali
reviewed
Mar 28, 2023
docs/persistence.rst
Outdated
|
|
||
| One caveat to the backwards compatibility promise is that the skops files have | ||
| to be created based on a release version of skops. If you create skops files | ||
| using a skops version installed from the main branch, it is possible to end up |
There was a problem hiding this comment.
Suggested change
| using a skops version installed from the main branch, it is possible to end up | |
| using a skops version installed from the development branch, it is possible to end up |
or put main in backticks to make it code like. Otherwise the sentence might sound odd to the reader.
|
Adding that option to the CLI would also make sense. |
|
I reworded the paragraph a little bit, please look again. |
adrinjalali
approved these changes
Mar 28, 2023
adrinjalali
changed the title
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.
Added paragraphs:
NB: I made a short note that users may want to do a load-dump cycle of skops files to upgrade them to the latest format. I wonder if we should extend the skops CLI to make this work from command line. WDYT?