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

Improve sampler docs #1141

Merged
merged 15 commits into from
Sep 12, 2024
Merged

Improve sampler docs #1141

merged 15 commits into from
Sep 12, 2024

Conversation

cpfiffer
Copy link
Contributor

The docs did not fully convey how to set temperature, and I figured I'd update the sampler docs more generally. A user was having issues with this in the Discord.

I update the documentation to include a few things:

Changes:

  • Brief overview in layman's terms of what the samplers actually do
  • How multinomial sampling works
  • Added "Parameters" sections for beam search and multinomial sampling
  • Added more headers to break up the various parameters in multinomial sampling
  • Provided a simple comparison table to help users choose from the available samplers

Misc doc convenience stuff:

  • gitignore for mkdocs-generated folders
  • Manually triggered build/publish GitHub Actions for the docs

@rlouf rlouf merged commit ba8a52b into dottxt-ai:main Sep 12, 2024
7 checks passed
@cpfiffer cpfiffer deleted the sampler-docs branch September 13, 2024 17:38
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.

2 participants