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.
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
DOC Add secure persistence docs #145
DOC Add secure persistence docs #145
Changes from 2 commits
e9d6d92
f72c2da
8a3970f
d0e98e1
c5a9331
264d71e
4ffeb9e
803edba
0535c23
119bd5e
25dd8df
4bb174a
867e72c
a130032
9e86569
6d2f3c9
e00bfa4
d8a8d8c
c263ae2
23de6bb
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this opening would be much stronger if you presented it as an issue with
pickle
+ howskops
addresses it. It may not be obvious to a user why they shouldn't usepickle
especially if it is so common. Something like:The
pickle
module is not secure, but withskops
, you can securely save and load sklearn models without usingpickle
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it'd be a little clearer if you also explain why its flexibility means it's insecure. Maybe something like:
but this flexibility also means that it's inherently insecure because [insert reason here].
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd personally avoid using a "value" word like
simple
oreasy
since it is relative to a user's experience and can make the tone not as friendly for beginners. I think the code snippet below already does a great job of showing how simple it is without having us tell the user it is simple :)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, I'd maybe rename this section to just Roadmap and combine it with the section below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it makes sense to put warnings only to load rather than save, but feel free to ignore if you think it doesn't make sense😅
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know I went overboard with warnings, but I really wanted to make sure users don't miss the fact that we're still early in development and know that it's not secure yet. Hopefully, we can fill these gaps soon and then remove the warnings. Until then, I'd rather leave them in.