docs: enhance Profiler class with detailed docstrings for initialization and event handling

Author: yarikdevcom

agents-core/vision_agents/core/profiling/base.py

@@ -8,7 +8,27 @@
 
 
 class Profiler:
+    """Profiles agent execution using pyinstrument and generates an HTML report.
+
+    The profiler automatically starts when instantiated and stops when the agent
+    finishes (on AgentFinishEvent), saving an HTML performance report to disk.
+
+    Example:
+        agent = Agent(
+            edge=getstream.Edge(),
+            agent_user=User(name="Agent", id="agent"),
+            llm=gemini.LLM("gemini-2.0-flash"),
+            profiler=Profiler(output_path='./profile.html'),
+        )
+    """
+
     def __init__(self, output_path='./profile.html'):
+        """Initialize the profiler.
+
+        Args:
+            output_path: Path where the HTML profile report will be saved.
+                Defaults to './profile.html'.
+        """
         self.output_path = output_path
         self.events = EventManager()
         self.events.register_events_from_module(events)
@@ -17,6 +37,11 @@ def __init__(self, output_path='./profile.html'):
         self.events.subscribe(self.on_finish)
 
     async def on_finish(self, event: events.AgentFinishEvent):
+        """Handle agent finish event by stopping profiler and saving report.
+
+        Args:
+            event: The AgentFinishEvent emitted when the agent finishes.
+        """
         self.profiler.stop()
         logger.info(f"Profiler stopped. Time file saved at: {self.output_path}")
         with open(self.output_path, 'w') as f: