Docs: Update HFAPIGenerator docstrings

deepset-ai / haystack

AI orchestration framework to build customizable, production-ready LLM applications. Connect components (models, vector DBs, file converters) to pipelines or agents that can interact with your data. With advanced retrieval methods, it's best suited for building RAG, question answering, semantic search or conversational agent chatbots.

https://haystack.deepset.ai

Apache License 2.0

17.72k stars 1.92k forks source link

Docs: Update HFAPIGenerator docstrings #8154

Closed agnieszka-m closed 3 months ago

agnieszka-m commented 3 months ago

Related Issues

fixes #8153

Proposed Changes:

How did you test it?

Notes for the reviewer

Checklist

I have read the contributors guidelines and the code of conduct
I have updated the related issue with new insights and changes
I added unit tests and updated the docstrings
I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test:.
I documented my code
I ran pre-commit hooks and fixed any issue

coveralls commented 3 months ago

Pull Request Test Coverage Report for Build 10215617861

Details

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall first build on hfapigen-docstrings at 90.115%

Totals
Change from base Build 10215604319:	90.1%
Covered Lines:	6883
Relevant Lines:	7638