-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[paddle-pipelines] Add pipelines documentation (#8308)
* Add pipelines documentation * Update pipeline docs * remove rss module * Update docs * Update site url
- Loading branch information
Showing
23 changed files
with
491 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# .readthedocs.yaml | ||
# Read the Docs configuration file | ||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
||
# Required | ||
version: 2 | ||
|
||
# Set the version of Python and other tools you might need | ||
build: | ||
os: ubuntu-22.04 | ||
tools: | ||
python: "3.12" | ||
|
||
mkdocs: | ||
configuration: mkdocs.yml | ||
|
||
# Optionally declare the Python requirements required to build your docs | ||
python: | ||
install: | ||
- requirements: docs/requirements.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Agent Module | ||
|
||
::: pipelines.agents.base | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
members: | ||
- Agent | ||
- ToolsManager | ||
- Tool | ||
|
||
|
||
::: pipelines.agents.agent_step | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
members: | ||
- AgentStep |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Elasticsearch Module | ||
|
||
::: pipelines.document_stores.elasticsearch | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# FAISS Module | ||
|
||
::: pipelines.document_stores.faiss | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Milvus2 Module | ||
|
||
::: pipelines.document_stores.milvus2 | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Answer Extractor Module | ||
|
||
::: pipelines.nodes.answer_extractor.answer_extractor_preprocessor | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
::: pipelines.nodes.answer_extractor.answer_extractor | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
::: pipelines.nodes.answer_extractor.qa_filter_postprocessor | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
::: pipelines.nodes.answer_extractor.qa_filter | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Document Intelligence Module | ||
|
||
::: pipelines.nodes.document.document_intelligence | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
::: pipelines.nodes.document.document_preprocessor | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# File Converter Module | ||
|
||
::: pipelines.nodes.file_converter.docx | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
::: pipelines.nodes.file_converter.image | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
::: pipelines.nodes.file_converter.markdown | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
::: pipelines.nodes.file_converter.pdf | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
|
||
::: pipelines.nodes.file_converter.txt | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# LLM Module | ||
|
||
::: pipelines.nodes.llm.chatglm | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
|
||
::: pipelines.nodes.llm.ernie_bot | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
|
||
::: pipelines.nodes.llm.history | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
|
||
::: pipelines.nodes.llm.prompt_template | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
members: | ||
- LLMPromptTemplate |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Other Module | ||
|
||
::: pipelines.nodes.other.docs2answers | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
::: pipelines.nodes.other.join_answers | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
::: pipelines.nodes.other.join_docs | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
|
||
::: pipelines.nodes.other.route_documents | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Preprocesssor Module | ||
|
||
::: pipelines.nodes.preprocessor.preprocessor | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
::: pipelines.nodes.preprocessor.text_splitter | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Question Generator Module | ||
|
||
::: pipelines.nodes.question_generator.question_generator | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Ranker Module | ||
|
||
::: pipelines.nodes.ranker.ernie_ranker | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Reader Module | ||
|
||
::: pipelines.nodes.reader.ernie_dureader | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# Retriever Module | ||
|
||
::: pipelines.nodes.retriever.dense | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
::: pipelines.nodes.retriever.embedder | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
::: pipelines.nodes.retriever.ernie_encoder | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
|
||
::: pipelines.nodes.retriever.multimodal_retriever | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
::: pipelines.nodes.retriever.parallel_retriever | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
|
||
::: pipelines.nodes.retriever.sparse | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
::: pipelines.nodes.retriever.web | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Search Engine Module | ||
|
||
::: pipelines.nodes.search_engine.providers | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
::: pipelines.nodes.search_engine.web | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Sentiment Analysis Module | ||
|
||
::: pipelines.nodes.sentiment_analysis.senta_preprocessor | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
|
||
::: pipelines.nodes.sentiment_analysis.senta_visualization | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 | ||
|
||
::: pipelines.nodes.sentiment_analysis.senta | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Pipeline Module | ||
|
||
::: pipelines.pipelines.standard_pipelines | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Application Module | ||
|
||
::: rest_api.application | ||
options: | ||
summary: true | ||
separate_signature: true | ||
show_signature_annotations: true | ||
line_length: 60 |
Oops, something went wrong.