Skip to content

Commit 47b3151

Browse files
committed
docs: update codeboarding documentation in advanced-customization
## 📚 Documentation Update This commit contains updated documentation files fetched from the CodeBoarding service and copied to the advanced-customization section. ### 📊 Summary - Documentation files created/updated: 6 - JSON files created/updated: 7 - Documentation directory: .codeboarding/ - JSON directory: .codeboarding/ - Output format: .md - Repository analyzed: https://github.com/Pipelex/pipelex - Destination: docs/pages/advanced-customization/ The generated .md files have been automatically copied to the advanced-customization documentation section. 🤖 This commit was automatically generated by the CodeBoarding documentation update workflow.
1 parent 584cecf commit 47b3151

33 files changed

Lines changed: 1313 additions & 1731 deletions

.codeboarding/AI_Integration_Layer.json

Lines changed: 0 additions & 176 deletions
This file was deleted.

.codeboarding/AI_Integration_Layer.md

Lines changed: 0 additions & 100 deletions
This file was deleted.
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
{
2+
"description": "This subsystem provides a unified facade for interacting with various AI/ML models (LLMs, Image Generators, OCR engines) from different platforms and manages the integration and lifecycle of external AI/ML SDKs and plugins. It is a critical part of the `pipelex` framework, embodying the \"Extensible AI Integration Layer\" and supporting the \"AI/ML Workflow Orchestration Framework/Library\" and \"Plugin/Extension Architecture\" patterns.",
3+
"components": [
4+
{
5+
"name": "InferenceManager",
6+
"description": "Acts as a unified facade and orchestrator for various AI/ML model workers, including Large Language Models (LLMs), Image Generators (Imgg), and Optical Character Recognition (OCR) engines. It is responsible for managing the lifecycle (setup, retrieval, and teardown) of these workers and provides a centralized point of access to different AI capabilities. It also supports dynamic registration of external LLM workers, reinforcing its role in extensibility. This component embodies aspects of the \"Core Workflow Engine\" (specifically the LLM Integration Layer) and the \"Facade Pattern.\"",
7+
"referenced_source_code": [
8+
{
9+
"qualified_name": "InferenceManager",
10+
"reference_file": "/home/ubuntu/CodeBoarding/repo/pipelex/pipelex/cogt/inference/inference_manager.py",
11+
"reference_start_line": 23,
12+
"reference_end_line": 186
13+
}
14+
],
15+
"can_expand": true
16+
},
17+
{
18+
"name": "ContentGenerator",
19+
"description": "Specializes in generating diverse content (text, structured objects, images, OCR extractions, Jinja2 templated text) by leveraging the underlying AI/ML models. It encapsulates the logic for preparing prompts, handling model settings, and processing the outputs from various AI models. This component represents a specialized \"Pipe Operator/Implementation\" within the \"LLM Integration Layer\" and extends to other AI modalities like image generation and OCR.",
20+
"referenced_source_code": [
21+
{
22+
"qualified_name": "ContentGenerator",
23+
"reference_file": "/home/ubuntu/CodeBoarding/repo/pipelex/pipelex/cogt/content_generation/content_generator.py",
24+
"reference_start_line": 39,
25+
"reference_end_line": 281
26+
}
27+
],
28+
"can_expand": true
29+
},
30+
{
31+
"name": "PluginManager",
32+
"description": "Manages the lifecycle of plugins, including their discovery, loading, registration, and provision to other parts of the system. It is crucial for enabling the extensibility of the `pipelex` framework, allowing new AI models, data sources, or custom logic to be integrated seamlessly. This component directly implements the \"Extensibility & Plugin System\" and \"Plugin Management\" architectural patterns.",
33+
"referenced_source_code": [
34+
{
35+
"qualified_name": "PluginManager",
36+
"reference_file": "/home/ubuntu/CodeBoarding/repo/pipelex/pipelex/plugins/plugin_manager.py",
37+
"reference_start_line": 9,
38+
"reference_end_line": 27
39+
}
40+
],
41+
"can_expand": true
42+
}
43+
],
44+
"components_relations": [
45+
{
46+
"relation": "leverages to discover and load",
47+
"src_name": "InferenceManager",
48+
"dst_name": "PluginManager"
49+
},
50+
{
51+
"relation": "provides AI model workers to",
52+
"src_name": "InferenceManager",
53+
"dst_name": "ContentGenerator"
54+
},
55+
{
56+
"relation": "relies on to obtain and utilize",
57+
"src_name": "ContentGenerator",
58+
"dst_name": "InferenceManager"
59+
},
60+
{
61+
"relation": "enables extensibility for by providing",
62+
"src_name": "PluginManager",
63+
"dst_name": "InferenceManager"
64+
}
65+
]
66+
}
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
```mermaid
2+
graph LR
3+
InferenceManager["InferenceManager"]
4+
ContentGenerator["ContentGenerator"]
5+
PluginManager["PluginManager"]
6+
InferenceManager -- "leverages to discover and load" --> PluginManager
7+
InferenceManager -- "provides AI model workers to" --> ContentGenerator
8+
ContentGenerator -- "relies on to obtain and utilize" --> InferenceManager
9+
PluginManager -- "enables extensibility for by providing" --> InferenceManager
10+
```
11+
12+
[![CodeBoarding](https://img.shields.io/badge/Generated%20by-CodeBoarding-9cf?style=flat-square)](https://github.com/CodeBoarding/GeneratedOnBoardings)[![Demo](https://img.shields.io/badge/Try%20our-Demo-blue?style=flat-square)](https://www.codeboarding.org/demo)[![Contact](https://img.shields.io/badge/Contact%20us%20-%20contact@codeboarding.org-lightgrey?style=flat-square)](mailto:contact@codeboarding.org)
13+
14+
## Details
15+
16+
This subsystem provides a unified facade for interacting with various AI/ML models (LLMs, Image Generators, OCR engines) from different platforms and manages the integration and lifecycle of external AI/ML SDKs and plugins. It is a critical part of the `pipelex` framework, embodying the "Extensible AI Integration Layer" and supporting the "AI/ML Workflow Orchestration Framework/Library" and "Plugin/Extension Architecture" patterns.
17+
18+
### InferenceManager
19+
Acts as a unified facade and orchestrator for various AI/ML model workers, including Large Language Models (LLMs), Image Generators (Imgg), and Optical Character Recognition (OCR) engines. It is responsible for managing the lifecycle (setup, retrieval, and teardown) of these workers and provides a centralized point of access to different AI capabilities. It also supports dynamic registration of external LLM workers, reinforcing its role in extensibility. This component embodies aspects of the "Core Workflow Engine" (specifically the LLM Integration Layer) and the "Facade Pattern."
20+
21+
22+
**Related Classes/Methods**:
23+
24+
- <a href="https://github.com/Pipelex/pipelex/blob/main/pipelex/cogt/inference/inference_manager.py#L23-L186" target="_blank" rel="noopener noreferrer">`InferenceManager`:23-186</a>
25+
26+
27+
### ContentGenerator
28+
Specializes in generating diverse content (text, structured objects, images, OCR extractions, Jinja2 templated text) by leveraging the underlying AI/ML models. It encapsulates the logic for preparing prompts, handling model settings, and processing the outputs from various AI models. This component represents a specialized "Pipe Operator/Implementation" within the "LLM Integration Layer" and extends to other AI modalities like image generation and OCR.
29+
30+
31+
**Related Classes/Methods**:
32+
33+
- <a href="https://github.com/Pipelex/pipelex/blob/main/pipelex/cogt/content_generation/content_generator.py#L39-L281" target="_blank" rel="noopener noreferrer">`ContentGenerator`:39-281</a>
34+
35+
36+
### PluginManager
37+
Manages the lifecycle of plugins, including their discovery, loading, registration, and provision to other parts of the system. It is crucial for enabling the extensibility of the `pipelex` framework, allowing new AI models, data sources, or custom logic to be integrated seamlessly. This component directly implements the "Extensibility & Plugin System" and "Plugin Management" architectural patterns.
38+
39+
40+
**Related Classes/Methods**:
41+
42+
- <a href="https://github.com/Pipelex/pipelex/blob/main/pipelex/plugins/plugin_manager.py#L9-L27" target="_blank" rel="noopener noreferrer">`PluginManager`:9-27</a>
43+
44+
45+
46+
47+
### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq)

0 commit comments

Comments
 (0)