-
Notifications
You must be signed in to change notification settings - Fork 36
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
Create a proposal for a notebooks
repository
#194
Conversation
I think a decent counterproposal to this is that each component would house its own notebooks in their own repos given that it's likely they will become upstream projects in their own right housed under the instructlab org. WDYT about that? I think the orchestrated ones make sense to be put in a centralized repo, but unsure if putting component notebooks in a repo other than the component repos themselves makes sense from the standpoint of a contributor looking for examples. |
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.
LGTM
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 had a thought similar to what @cdoern was saying. I think this makes sense for this repo to maybe contain the combined workflow notebooks. Where the stages would go in the library repos.
At a high level, we already have one example notebook in our current SDG repo and are planning multiple more, along with integration tests that test these notebooks, in the updated SDG repo. I think we'll always want our notebooks that showcase the best of SDG in an SDG-specific repo, because they will only touch on SDG and also show ways SDG may be used that are outside of just the end-to-end opinionated InstructLab flow for producing models. With that said, I do think it's reasonable that we have some content (including notebooks) that show how all of the individual libraries can be used together. I would support a centralized place to collect some of these end-to-end examples, showing how someone can implement the opinionated InstructLab flow using notebooks as well as how they can plug their own steps and requirements into notebooks by starting with our opinions and customizing things. So, +1 from me on a place for these cross-cutting types of notebooks, but -1 from me if the desire is to house notebooks specific to individual libraries here. |
4b78e83
to
8a8937e
Compare
I've taken the feedback on this PR and removed the |
A bit of bikeshedding on my part, but perhaps |
Signed-off-by: Ali Maredia <amaredia@redhat.com>
8a8937e
to
fa7b2f6
Compare
@nimbinatus great idea. I changed the repo name and dev doc a bit for flexibility sake. |
See
docs/notebooks/notebooks-repo.md
in this pull request for more details.