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

Various docs fixes #1429

Merged
merged 6 commits into from
Feb 20, 2025
Merged

Various docs fixes #1429

merged 6 commits into from
Feb 20, 2025

Conversation

EdAbati
Copy link
Contributor

@EdAbati EdAbati commented Feb 19, 2025

Follow up of #1343

In this PR I added:

  • all models to the API reference (we had only openai and transformers before)
  • fixes to the docstrings that were not following the numpy style
  • fixes to docstrings wrongly rendered by mkdocstring

Thanks :)

@@ -48,13 +48,6 @@ conda env create -f environment.yml

Then install the dependencies in editable mode, and install the `pre-commit` hooks:

```shell
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this was repeated


For exllamav2, it mainly accepts only a list or a string(they also do cfg sampling with tuples but we will ignore this for now).
The exllamav2's logic is:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

(we need a new line before the list)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Before
Screenshot 2025-02-19 at 23 50 36

After

Screenshot 2025-02-19 at 23 50 58

@EdAbati EdAbati changed the title Various doc fixes Various docs fixes Feb 19, 2025
@rlouf
Copy link
Member

rlouf commented Feb 20, 2025

Thank you so much for these fixes, they are much appreciated!

@rlouf rlouf merged commit f9e3af0 into dottxt-ai:main Feb 20, 2025
5 checks passed
@EdAbati EdAbati deleted the docs-imporvement branch February 20, 2025 20:59
rlouf pushed a commit that referenced this pull request Feb 24, 2025
Follow up of #1343

In this PR I added:
- all models to the API reference (we had only openai and transformers
before)
- fixes to the docstrings that were not following the numpy style
- fixes to docstrings wrongly rendered by mkdocstring

Thanks :)
rlouf pushed a commit to RobinPicard/outlines that referenced this pull request Feb 24, 2025
Follow up of dottxt-ai#1343

In this PR I added:
- all models to the API reference (we had only openai and transformers
before)
- fixes to the docstrings that were not following the numpy style
- fixes to docstrings wrongly rendered by mkdocstring

Thanks :)
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