-
Notifications
You must be signed in to change notification settings - Fork 399
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 the README #113
Update the README #113
Conversation
546fb9a
to
3c28e7f
Compare
7ba5532
to
f9d47c8
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.
I've added some comments, but they shouldn't block merging this.
2229325
to
fbc895f
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.
Great content here! In the notebooks, could it make sense to call out places where outlines is used more explicitly? Perhaps with a brief explanation of how Outlines is simpler than other ways one might accomplish the task
Not sure how I could make it more explicit than calling functions from outlines. Do you mean spelling it out "We use xxx from the library to do xxx"?
I think the code speaks for itself. At least it should, otherwise we have a problem. If you want a comparison it'd be better to do a side-by-side comparison in another notebook imo. |
Yeah I thought it would be useful to add spelling out sentences like that. For the comparison piece I just mean less than a sentence hinting at what you might need to do if you had python but no Outlines library to help out. |
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.
Woo!
Ok I'll add a few sentences. |
This PR updates the README to get the repo ready for release, and adds two example notebooks: