Merge pull request Pipelex#64 from Pipelex/release/v0.2.14

Release/v0.2.14

Author: thomashebrard

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [v0.2.14] - 2025-06-06
+
+- Added a feature flag for the `ReportingManager` in the config: 
+```bash
+[pipelex]
+[pipelex.feature_config]
+is_reporting_enabled = true
+```
+- Moved the reporting config form the `cogt`config to the Pipelex config.
+
 ## [v0.2.13] - 2025-06-06
 
 - Added Discord badge on the Readme. Join the community! -> https://discord.gg/SReshKQjWt

pipelex/cogt/config_cogt.py

@@ -9,15 +9,6 @@
 from pipelex.tools.config.models import ConfigModel
 
 
-class CogtReportConfig(ConfigModel):
-    is_log_costs_to_console: bool
-    is_generate_cost_report_file_enabled: bool
-    cost_report_dir_path: str
-    cost_report_base_name: str
-    cost_report_extension: str
-    cost_report_unit_scale: float
-
-
 class OcrConfig(ConfigModel):
     ocr_handles: List[str]
     page_output_text_file_name: str
@@ -70,7 +61,6 @@ class InferenceManagerConfig(ConfigModel):
 
 class Cogt(ConfigModel):
     inference_manager_config: InferenceManagerConfig
-    cogt_report_config: CogtReportConfig
     llm_config: LLMConfig
     imgg_config: ImggConfig
     ocr_config: OcrConfig

pipelex/config.py

@@ -46,6 +46,16 @@ def get_prompting_style(self, prompting_target: Optional[LLMPromptingTarget] = N
 class FeatureConfig(ConfigModel):
     is_pipeline_tracking_enabled: bool
     is_activity_tracking_enabled: bool
+    is_reporting_enabled: bool
+
+
+class ReportingConfig(ConfigModel):
+    is_log_costs_to_console: bool
+    is_generate_cost_report_file_enabled: bool
+    cost_report_dir_path: str
+    cost_report_base_name: str
+    cost_report_extension: str
+    cost_report_unit_scale: float
 
 
 class Pipelex(ConfigModel):
@@ -61,6 +71,7 @@ class Pipelex(ConfigModel):
     prompting_config: PromptingConfig
 
     pipe_run_config: PipeRunConfig
+    reporting_config: ReportingConfig
 
 
 class PipelexConfig(ConfigRoot):

pipelex/pipelex.py

@@ -26,6 +26,7 @@
 from pipelex.pipeline.pipeline_manager import PipelineManager
 from pipelex.pipeline.track.pipeline_tracker import PipelineTracker
 from pipelex.pipeline.track.pipeline_tracker_protocol import PipelineTrackerNoOp, PipelineTrackerProtocol
+from pipelex.reporting.reporting_manager import ReportingManager
 from pipelex.reporting.reporting_protocol import ReportingNoOp, ReportingProtocol
 from pipelex.test_extras.registry_test_models import PipelexTestModels
 from pipelex.tools.config.models import ConfigRoot
@@ -121,7 +122,11 @@ def __init__(
         self.inference_manager = inference_manager or InferenceManager()
         self.pipelex_hub.set_inference_manager(self.inference_manager)
 
-        self.reporting_delegate = reporting_delegate or ReportingNoOp()
+        self.reporting_delegate: ReportingProtocol
+        if get_config().pipelex.feature_config.is_reporting_enabled:
+            self.reporting_delegate = reporting_delegate or ReportingManager(reporting_config=get_config().pipelex.reporting_config)
+        else:
+            self.reporting_delegate = ReportingNoOp()
         self.pipelex_hub.set_report_delegate(self.reporting_delegate)
 
         # pipelex libraries

pipelex/pipelex.toml

@@ -7,6 +7,15 @@ extra_env_files = []
 # WIP/Experimental feature flags
 is_pipeline_tracking_enabled = false
 is_activity_tracking_enabled = false
+is_reporting_enabled = true
+
+[pipelex.reporting_config]
+is_log_costs_to_console = false
+is_generate_cost_report_file_enabled = true
+cost_report_dir_path = "reports"
+cost_report_base_name = "cost_report"
+cost_report_extension = "xlsx"
+cost_report_unit_scale = 1.0
 
 ####################################################################################################
 # Log config
@@ -74,14 +83,6 @@ is_auto_setup_preset_llm = true
 is_auto_setup_preset_imgg = true
 is_auto_setup_preset_ocr = true
 
-[cogt.cogt_report_config]
-is_log_costs_to_console = false
-is_generate_cost_report_file_enabled = true
-cost_report_dir_path = "reports"
-cost_report_base_name = "cost_report"
-cost_report_extension = "xlsx"
-cost_report_unit_scale = 1.0
-
 [cogt.llm_config]
 default_max_images = 100
 

pipelex/reporting/reporting_manager.py

@@ -4,12 +4,12 @@
 from typing_extensions import override
 
 from pipelex import log
-from pipelex.cogt.config_cogt import CogtReportConfig
 from pipelex.cogt.exceptions import ReportingManagerError
 from pipelex.cogt.inference.cost_registry import CostRegistry
 from pipelex.cogt.inference.inference_job_abstract import InferenceJobAbstract
 from pipelex.cogt.llm.llm_job import LLMJob
 from pipelex.cogt.llm.llm_report import LLMTokenCostReport, LLMTokensUsage
+from pipelex.config import ReportingConfig
 from pipelex.pipeline.pipeline_models import SpecialPipelineId
 from pipelex.reporting.reporting_protocol import ReportingProtocol
 from pipelex.tools.misc.file_utils import ensure_path, get_incremental_file_path
@@ -28,9 +28,9 @@ def add_tokens_usage(self, llm_tokens_usage: LLMTokensUsage):
 
 
 class ReportingManager(ReportingProtocol):
-    def __init__(self, report_config: CogtReportConfig):
+    def __init__(self, reporting_config: ReportingConfig):
         self._usage_registries: Dict[str, UsageRegistry] = {}
-        self._report_config = report_config
+        self._reporting_config = reporting_config
 
     ############################################################
     # Manager lifecycle
@@ -63,13 +63,13 @@ def _report_llm_job(self, llm_job: LLMJob):
 
         llm_token_cost_report: Optional[LLMTokenCostReport] = None
 
-        if self._report_config.is_log_costs_to_console:
+        if self._reporting_config.is_log_costs_to_console:
             llm_token_cost_report = CostRegistry.complete_cost_report(llm_tokens_usage=llm_tokens_usage)
 
         pipeline_run_id = llm_job.job_metadata.pipeline_run_id
         self._get_registry(pipeline_run_id).add_tokens_usage(llm_tokens_usage)
 
-        if self._report_config.is_log_costs_to_console:
+        if self._reporting_config.is_log_costs_to_console:
             log.verbose(llm_token_cost_report, title="Token Cost report")
 
     ############################################################
@@ -96,19 +96,19 @@ def report_inference_job(self, inference_job: InferenceJobAbstract):
     def generate_report(self, pipeline_run_id: Optional[str] = None):
         pipeline_run_id = pipeline_run_id or SpecialPipelineId.UNTITLED
         cost_report_file_path: Optional[str] = None
-        if self._report_config.is_generate_cost_report_file_enabled:
-            ensure_path(self._report_config.cost_report_dir_path)
+        if self._reporting_config.is_generate_cost_report_file_enabled:
+            ensure_path(self._reporting_config.cost_report_dir_path)
             cost_report_file_path = get_incremental_file_path(
-                base_path=self._report_config.cost_report_dir_path,
-                base_name=self._report_config.cost_report_base_name,
-                extension=self._report_config.cost_report_extension,
+                base_path=self._reporting_config.cost_report_dir_path,
+                base_name=self._reporting_config.cost_report_base_name,
+                extension=self._reporting_config.cost_report_extension,
             )
 
         registry = self._get_registry(pipeline_run_id)
         CostRegistry.generate_report(
             pipeline_run_id=pipeline_run_id,
             llm_tokens_usages=registry.get_current_tokens_usage(),
-            unit_scale=self._report_config.cost_report_unit_scale,
+            unit_scale=self._reporting_config.cost_report_unit_scale,
             cost_report_file_path=cost_report_file_path,
         )
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pipelex"
-version = "0.2.13"
+version = "0.2.14"
 description = "Pipelex is an open-source dev tool based on a simple declarative language that lets you define replicable, structured, composable LLM pipelines."
 authors = [{ name = "Evotis S.A.S.", email = "evotis@pipelex.com" }]
 maintainers = [{ name = "Pipelex staff", email = "oss@pipelex.com" }]