Skip to content
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

Merged
merged 3 commits into from
May 25, 2023
Merged

Update the README #113

merged 3 commits into from
May 25, 2023

Conversation

rlouf
Copy link
Member

@rlouf rlouf commented May 17, 2023

This PR updates the README to get the repo ready for release, and adds two example notebooks:

  • Update README
  • Add example that showcases "uncertainty"
  • Add simulation-based inference notebook

@rlouf rlouf force-pushed the readme branch 10 times, most recently from 546fb9a to 3c28e7f Compare May 17, 2023 16:32
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@rlouf rlouf force-pushed the readme branch 9 times, most recently from 7ba5532 to f9d47c8 Compare May 24, 2023 12:33
@rlouf rlouf requested a review from dgerlanc May 24, 2023 12:34
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@brandonwillard brandonwillard left a 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.

@rlouf rlouf force-pushed the readme branch 5 times, most recently from 2229325 to fbc895f Compare May 25, 2023 07:19
Copy link
Contributor

@zaqqwerty zaqqwerty left a 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

@rlouf
Copy link
Member Author

rlouf commented May 25, 2023

could it make sense to call out places where outlines is used more explicitly?

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"?

Perhaps with a brief explanation of how Outlines is simpler than other ways one might accomplish the task

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.

@zaqqwerty
Copy link
Contributor

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.

@farice farice self-requested a review May 25, 2023 09:53
Copy link
Collaborator

@farice farice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Woo!

@rlouf
Copy link
Member Author

rlouf commented May 25, 2023

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.

Ok I'll add a few sentences.

@rlouf rlouf merged commit d6fff5a into main May 25, 2023
@rlouf rlouf deleted the readme branch May 25, 2023 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants