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

Document LlamaCppChatGenerator #807

Closed
anakin87 opened this issue Jun 13, 2024 · 5 comments
Closed

Document LlamaCppChatGenerator #807

anakin87 opened this issue Jun 13, 2024 · 5 comments
Assignees
Labels
integration:llama_cpp P1 type:documentation Improvements or additions to documentation

Comments

@anakin87
Copy link
Member

LlamaCppChatGenerator was introduced in #723 but it was never documented.

@anakin87 anakin87 added type:documentation Improvements or additions to documentation integration:llama_cpp labels Jun 13, 2024
@shadeMe shadeMe added the P2 label Jun 14, 2024
@lbux
Copy link
Contributor

lbux commented Jun 26, 2024

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.

@anakin87
Copy link
Member Author

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:
llamacppgenerator.md.

What do you think? Let us know if you want to take care of it... 💙

@lbux
Copy link
Contributor

lbux commented Jun 27, 2024

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
llamacppchatgenerator.md

@anakin87
Copy link
Member Author

@lbux thank you!

@dfokina coud you please review the markdown and create a new documentation page for LlamaCppChatGenerator?

@dfokina
Copy link
Contributor

dfokina commented Jul 3, 2024

Thank you for the draft @lbux ! The doc page is live: https://docs.haystack.deepset.ai/docs/llamacppchatgenerator

@dfokina dfokina closed this as completed Jul 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integration:llama_cpp P1 type:documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

5 participants