yujunjun/haystack
1
0
Fork 0
mirror of https://github.com/deepset-ai/haystack.git synced 2025-07-04 15:41:00 +00:00
Code Issues Packages Projects Releases Wiki Activity
haystack/docs/pydoc/config/generators_api.yml

39 lines
1008 B
YAML
Raw Normal View History

docs: Add readme sync for API docs 2.0 (#6173) * add sync docs for preview * add example config for audio docs * hardcode version in renderer * use custom renderer for preview docs * update comment and excerpt
2023-10-27 14:53:03 +02:00
loaders:
use haystack-pydoc-tools package instead of local code (#6818)
2024-01-23 18:28:52 +01:00
- type: haystack_pydoc_tools.loaders.CustomPythonLoader
docs: add Data Classes API ref and cleanup (#6482) * Data Classes and cleanup * Update pydoc-markdown.sh * Update converter.yml
2023-12-04 14:03:28 +01:00
search_path: [../../../haystack/components/generators]
add missing components to docs (#6813)
2024-01-23 14:03:15 +01:00
modules:
[
"azure",
"hugging_face_local",
feat: `HuggingFaceAPIGenerator` (#7464) * draft * docstrings and more tests * deprecation; reno * pydoc config * better error messages * rm unneeded else * make params mandatory * Apply suggestions from code review Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com> * document enum * Update haystack/utils/hf.py Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com> * fix test --------- Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>
2024-04-05 18:48:13 +02:00
"hugging_face_api",
add missing components to docs (#6813)
2024-01-23 14:03:15 +01:00
"openai",
feat: Adding DALLE image generator (#8448) * First pass at adding DALLE image generator * Add missing header * Fix tests * Add tests * Fix mypy * Make mypy happy * More unit tests * Adding release notes * Add a test for run * Update haystack/components/generators/openai_dalle.py Co-authored-by: Silvano Cerza <3314350+silvanocerza@users.noreply.github.com> * Fix pylint * Update haystack/components/generators/openai_dalle.py Co-authored-by: Amna Mubashar <amnahkhan.ak@gmail.com> * Update haystack/components/generators/openai_dalle.py Co-authored-by: Daria Fokina <daria.fokina@deepset.ai> * Update haystack/components/generators/openai_dalle.py Co-authored-by: Daria Fokina <daria.fokina@deepset.ai> * Update haystack/components/generators/openai_dalle.py Co-authored-by: Daria Fokina <daria.fokina@deepset.ai> * Update haystack/components/generators/openai_dalle.py Co-authored-by: Daria Fokina <daria.fokina@deepset.ai> * Update haystack/components/generators/openai_dalle.py Co-authored-by: Daria Fokina <daria.fokina@deepset.ai> --------- Co-authored-by: Silvano Cerza <3314350+silvanocerza@users.noreply.github.com> Co-authored-by: Amna Mubashar <amnahkhan.ak@gmail.com> Co-authored-by: Daria Fokina <daria.fokina@deepset.ai>
2024-11-14 16:19:49 +01:00
"openai_dalle",
add missing components to docs (#6813)
2024-01-23 14:03:15 +01:00
"chat/azure",
"chat/hugging_face_local",
feat: `HuggingFaceAPIChatGenerator` (#7480) * draft * docstrings and more tests * deprecation; reno * pydoc config * better error messages * wip * add test * better docstrings * deprecation; reno * pylint * typo * rm unneeded else * rm unneeded else * fixes from feedback * docstring showing the enum * improve docstring * make params mandatory * Apply suggestions from code review Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com> * document enum * Update haystack/utils/hf.py Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com> * mandatory params * fix test * fix test --------- Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>
2024-04-05 18:48:34 +02:00
"chat/hugging_face_api",
refact: Rename helper function (#6831) * change function name * add api docs * release notes
2024-01-26 16:00:02 +01:00
"chat/openai",
add missing components to docs (#6813)
2024-01-23 14:03:15 +01:00
]
docs: Add readme sync for API docs 2.0 (#6173) * add sync docs for preview * add example config for audio docs * hardcode version in renderer * use custom renderer for preview docs * update comment and excerpt
2023-10-27 14:53:03 +02:00
ignore_when_discovered: ["__init__"]
processors:
- type: filter
expression:
documented_only: true
do_not_filter_modules: false
skip_empty_modules: true
- type: smart
- type: crossref
renderer:
Update docs renderer (#7349)
2024-03-13 12:30:13 +01:00
type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
docs: 2.0 API reference (#6262) * docs: 2.0 API reference * add builders and generators * classifiers file path
2023-11-14 10:12:28 +01:00
excerpt: Enables text generation using LLMs.
chore: rename categories in the API docs (#6885) * rename API categories * fix * update slugs * rename files for consistency * fix category ID * try getting the right version
2024-02-01 16:47:26 +01:00
category_slug: haystack-api
title: Generators
slug: generators-api
docs: add Data Classes API ref and cleanup (#6482) * Data Classes and cleanup * Update pydoc-markdown.sh * Update converter.yml
2023-12-04 14:03:28 +01:00
order: 70
docs: Add readme sync for API docs 2.0 (#6173) * add sync docs for preview * add example config for audio docs * hardcode version in renderer * use custom renderer for preview docs * update comment and excerpt
2023-10-27 14:53:03 +02:00
markdown:
descriptive_class_title: false
docs: disable class def rendering (#7329)
2024-03-07 15:54:16 +01:00
classdef_code_block: false
docs: Add readme sync for API docs 2.0 (#6173) * add sync docs for preview * add example config for audio docs * hardcode version in renderer * use custom renderer for preview docs * update comment and excerpt
2023-10-27 14:53:03 +02:00
descriptive_module_title: true
add_method_class_prefix: true
add_member_class_prefix: false
chore: rename categories in the API docs (#6885) * rename API categories * fix * update slugs * rename files for consistency * fix category ID * try getting the right version
2024-02-01 16:47:26 +01:00
filename: generators_api.md
Reference in New Issue Copy Permalink