-
Notifications
You must be signed in to change notification settings - Fork 82
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
Document LlamaCppChatGenerator
#807
Comments
Given that I implemented it, I can at least add a README. I'm unsure if/how I could add a proper documentation page on the docs site as there is only an option to suggest changes to an existing page. |
Hey, @lbux! Currently, the process of adding docs for new components is manually handled. We hope to improve it in the future... In the meantime, if you create a markdown draft and add it to this issue, we can then take care of refining and publishing it. Similar examples: LlamaCppGenerator, OllamaChatGenerator I also attach the markdown file for the LlamaCppGenerator, to help you get started: What do you think? Let us know if you want to take care of it... 💙 |
Hello, @anakin87. Please see the updated file. I kept it very similar to the regular generator but added small bits that correspond to the additional options available for users (chat_format, json constraining, function calling, etc.). The examples have also been updated and ensured to be working with the exception of the "Using in a Pipeline" section which will work when deepset-ai/haystack#7897 is merged |
Thank you for the draft @lbux ! The doc page is live: https://docs.haystack.deepset.ai/docs/llamacppchatgenerator |
LlamaCppChatGenerator
was introduced in #723 but it was never documented.The text was updated successfully, but these errors were encountered: