-
Notifications
You must be signed in to change notification settings - Fork 332
Add overview document for clustering #301
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
Add overview document for clustering #301
Conversation
566a99c
to
4cbe787
Compare
2396355
to
7ee5c71
Compare
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.
@arovir01, I have spotted a couple of minor things. Please, have a look.
2d8ada2
to
0d1b0b4
Compare
0d1b0b4
to
803798d
Compare
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.
This mentions it's a work in progress, is the intention to add more docs to a /clustering section?
What goes here will publish on tensorflow.org when pulled in. If this shouldn't get published yet, you can prefix the file name with an underscore like: _index.md
Also need to update the leftnav file: https://github.com/tensorflow/model-optimization/blob/master/tensorflow_model_optimization/g3doc/_book.yaml
Yes it's not ready for users to view since the other docs need to be added first. This doc itself is good though. The idea was to not link it into the left nav via _book.yaml so people cannot really view it on tensorflow.org. Only prior to launch, would the _book.yaml changes be made. If underscore is preferred, we can do that for TFMOT going forward. |
Up to you. If only working in GitHub, I'd probably recommend a feature branch or something and then merge everything when ready to publish. Files prefixed with an underscore are skipped when importing---but that also means the file won't get executed (for testing). It's fine to publish as normal and then add a nav link when ready, as long as you're not leaking anything, etc. (But if that were the case, we wouldn't be chatting out here in GitHub :) |
Ok thanks. Think it's fine to keep the file name as is then. It matters less for this file, but for the colabs (written by another person), it's nice to be able to get things automatically tested and reviewed document by document. |
Is this something I should do or will one of you guys handle it after merging this? |
803798d
to
874120b
Compare
I have added the latest experimental results to the document. Please advise if there is anything else that you consider needs changing. Otherwise I will proceed with squashing the commits together in preparation for merging. |
@arovir01 for this PR, it sounds like the entry in _book.yaml will be added later by @alanchiao |
Billy, yes that's correct. Or Aron / the others will make it shortly prior to launch. |
Just leaving a note that Billy approved this PR internally. |
This PR adds the overview document for clustering.
This is still to be viewed as work in progress until the tutorial document will have been finalized.