-
Notifications
You must be signed in to change notification settings - Fork 32
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
Update README and documentation #47
Conversation
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.
Looks mostly good to me, just proposed a few minor clarifying changes.
This is now ready to review, though it depends on the decision we're taking in #46 as this impacts provenance for the TF models which are a folder instead of a single file. |
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.
The new Contributing section looks great! Adding a few comments on the other sections.
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.
left minor comments, but LGTM!
@@ -1,69 +1,106 @@ | |||
# Model Signing | |||
|
|||
This project demonstrates how to protect the integrity of a model by signing it with [Sigstore](https://www.sigstore.dev/). | |||
This project demonstrates how to protect the integrity of a model by signing it |
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.
the Sigstore diagram image is slightly big
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 @haydentherapper already fixed this)
developed for traditional software to protect against tampering with builds, | ||
such as in the [Solarwinds attack][solarwinds], and this project is a proof of | ||
concept that the _same supply chain protections can be applied to ML_. | ||
|
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 we should add one line about that the verification of provenance gives you. You're guaranteed the training was done in the repo at a particular commit sha / tag. We might cross-link to to blog post as well
You can use --print-provenance
option to see the output of provenance if needed. I'd simply link to https://github.com/slsa-framework/slsa-verifier#artifacts for further information.
Signed-off-by: Mihai Maruseac <mihaimaruseac@google.com>
Signed-off-by: Mihai Maruseac <mihaimaruseac@google.com> Co-authored-by: Bob Callaway <bobcallaway@users.noreply.github.com>
Signed-off-by: Mihai Maruseac <mihaimaruseac@google.com> Co-authored-by: Bob Callaway <bobcallaway@users.noreply.github.com>
Signed-off-by: Mihai Maruseac <mihaimaruseac@google.com> Co-authored-by: Bob Callaway <bobcallaway@users.noreply.github.com>
Signed-off-by: Mihai Maruseac <mihaimaruseac@google.com>
Signed-off-by: Mihai Maruseac <mihaimaruseac@google.com>
Signed-off-by: Mihai Maruseac <mihaimaruseac@google.com> Co-authored-by: olivekl <83081275+olivekl@users.noreply.github.com>
Signed-off-by: Mihai Maruseac <mihaimaruseac@google.com> Co-authored-by: olivekl <83081275+olivekl@users.noreply.github.com>
Signed-off-by: Mihai Maruseac <mihaimaruseac@google.com>
Signed-off-by: Mihai Maruseac <mihaimaruseac@google.com>
Signed-off-by: Mihai Maruseac <mihaimaruseac@google.com>
Signed-off-by: Mihai Maruseac <mihaimaruseac@google.com>
Signed-off-by: Hayden Blauzvern <hblauzvern@google.com>
Signed-off-by: Hayden Blauzvern <hblauzvern@google.com>
Signed-off-by: Mihai Maruseac <mihaimaruseac@google.com>
This is still WIP for now. Will continue to update tomorrow
CC @olivekl