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 #999

Closed
rlouf opened this issue Jun 22, 2024 · 0 comments · Fixed by #1059
Closed

Version the documentation #999

rlouf opened this issue Jun 22, 2024 · 0 comments · Fixed by #1059
Labels
documentation Linked to documentation and examples

Comments

@rlouf
Copy link
Member

rlouf commented Jun 22, 2024

The documentation points to the code in main, and not the latest release. Material Mkdocs allows to version the docs and we should set this so as to not confuse our users.

@rlouf rlouf added the documentation Linked to documentation and examples label Jun 22, 2024
rlouf pushed a commit that referenced this issue 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Linked to documentation and examples
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant