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

Version the Documentation #1059

Merged
merged 1 commit into from
Oct 7, 2024
Merged

Conversation

lapp0
Copy link
Contributor

@lapp0 lapp0 commented Jul 21, 2024

Fixes #999

Changes

Versions the documentation using mike.

Demo:

Behavior:

Set Up

Must have https://github.com/outlines-dev/outlines/settings/pages set to "deploy from a branch" with branch of gh-pages

Must cut a release after merging for the following reason:

@lapp0 lapp0 marked this pull request as draft July 21, 2024 19:53
@lapp0 lapp0 marked this pull request as ready for review July 21, 2024 19:54
@lapp0 lapp0 requested a review from rlouf July 21, 2024 20:29
@rlouf rlouf added this to the 0.1 milestone Jul 22, 2024
@cpfiffer cpfiffer mentioned this pull request Aug 22, 2024
rlouf pushed a commit that referenced this pull request Aug 29, 2024
I updated some of the text of the modal example to add more information
on what's happening where, since Modal's general structure may be
unfamiliar to new users.

List of changes:

- Removed version constraints on the image. I think this is a
questionable choice so I'd love input -- in general, this should
probably better be addressed by versioning the docs #999. There's an
open PR #1059 here that can help with this too -- I'm happy to revert to
pinned versions, or at least update to the current version of outlines
(0.0.46).
- Added a brief note that the Mistral model is gated and requires you to
request access on HuggingFace.
- Moved the environment variable setting from `import_model` to a `.env`
call when the image is created. This is more idiomatic Modal code. It
was previously addressed in #1058, but this should be more current.
- More comments and prep.
@rlouf rlouf merged commit ef4e819 into dottxt-ai:main Oct 7, 2024
6 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.

Version the documentation
2 participants