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 Documentation #1063

Merged
merged 3 commits into from
Aug 13, 2024
Merged

Update Documentation #1063

merged 3 commits into from
Aug 13, 2024

Conversation

lapp0
Copy link
Contributor

@lapp0 lapp0 commented Jul 22, 2024

Rendered: https://lapp0.github.io/outlines/quickstart/

Changes

  • Create model.md documentation with feature matrix
  • Update quickstart.md so its more concise, and links to relevant reference/generation/index.md and reference/models/index.md documentation pages. Moves most structured generation examples to reference/generation/index.md
  • Include structured_generation_explanation.md which details automata construction and logits processing.
  • Use phi-3-mini instead of mistral in all pages except external libraries cookbooks because it doesn't require an access token and is a more performant model for its size.
  • Add Remi's AI Engineer World’s Fair Presentation

Fixes

@lapp0 lapp0 force-pushed the update-documentation branch 12 times, most recently from 5c1f769 to 3946fd4 Compare July 22, 2024 22:41
@rlouf
Copy link
Member

rlouf commented Jul 23, 2024

Thanks for the doc update! Two comments:

  • We can remove Mistral-7B from the README as well. I also saw it in a couple of places in the rendered doc.
  • For the talk we'll have to do with the current video for now.

@lapp0
Copy link
Contributor Author

lapp0 commented Jul 27, 2024

Updated docs

  • added Remi's AI Engineer World’s Fair Presentation
  • removed mistralai/Mistral-7B-* everywhere
  • kept documentation which uses quants, e.g. TheBloke/Mistral-7B-Instruct-v0.2-GPTQ
  • kept external library guides in cookbook using mistral, e.g.
docs/cookbook/simtom.md:MODEL_NAME = "mistral-community/Mistral-7B-Instruct-v0.3"

@rlouf
Copy link
Member

rlouf commented Aug 7, 2024

We need to fix the merge conflict and then it should be ready to merge.

@rlouf rlouf merged commit 7218cdd into dottxt-ai:main Aug 13, 2024
7 checks passed
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.

Json schema generation not outputting full schema. Feature Matrix Add documentation for models
2 participants