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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: move provider examples to hub #449

Merged
merged 8 commits into from
Feb 20, 2024

Conversation

ethanleifer
Copy link
Contributor

@ethanleifer ethanleifer commented Feb 19, 2024

Ellipsis 馃殌 This PR description was created by Ellipsis for commit 1384edd.

Summary:

This PR adds three new documentation files providing examples of using the Instructor library with different open-source Language Learning Models (LLMs), and updates the site navigation to include these new files.

Key points:

  • Added llama-cpp-python.md, ollama.md, and together.md under /docs/hub/.
  • Each file provides examples of using Instructor with different open-source LLMs.
  • Demonstrates the use of Instructor's patch function to enhance create calls.
  • Updated mkdocs.yml to include these new files in the site navigation.

Generated with 鉂わ笍 by ellipsis.dev

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

Looks good to me! Reviewed entire PR up to commit 1384edd

Reviewed 338 lines of code across 4 files in 36 second(s).

See details
  • Skipped files: 0
  • Confidence threshold: 85%
  • Drafted 1 additional comments.
  • Workflow ID: wflow_j9EKdYymFKl8Q6Zp
View 1 draft comments

These comments were drafted by Ellipsis, but were filtered out of the final review. They're included here so you can see our internal thought process and help you configure your ellipsis.yaml.

Drafted 1 additional comments

Filtered comment at mkdocs.yml:173

Notes: The new markdown files created in the docs/hub directory are not added to the mkdocs.yml file. This means they won't be included in the generated documentation site.

The new markdown files created in the docs/hub directory are not added to the mkdocs.yml file. Please add the new files to the mkdocs.yml under the appropriate section to ensure they are included in the generated documentation site.

- Ollama: 'hub/ollama.md'
- Llama CPP: 'hub/llama-cpp-python.md'
- Together: 'hub/together.md'

Confidence changes required: 100%

Score: 0%


Something look wrong? Tag @ellipsis-dev in a comment, or customize the ellipsis.yaml for this repository.

Generated with 鉂わ笍 by ellipsis.dev

@jxnl
Copy link
Owner

jxnl commented Feb 20, 2024

we technically need the old ones too cause they are linked in other places now

@ethanleifer
Copy link
Contributor Author

Thoughts on https://github.com/mkdocs/mkdocs-redirects? instead of duplication?

@jxnl
Copy link
Owner

jxnl commented Feb 20, 2024

oh that sounds good

@jxnl jxnl changed the title move provider examples doc: move provider examples to hub Feb 20, 2024
@ethanleifer
Copy link
Contributor Author

@jxnl Anything else you want me to move real quick?

@jxnl jxnl merged commit 2389768 into jxnl:main Feb 20, 2024
7 of 8 checks passed
@ethanleifer ethanleifer deleted the move-provider-examples branch February 20, 2024 02:43
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.

None yet

2 participants