Update push source and one way examples

Author: achanana

examples/one_way/common.py

@@ -3,7 +3,7 @@
 import argparse
 import logging
 
-DEFAULT_ENGINE_NAME = "0"
+DEFAULT_ENGINE_ID = "0"
 DEFAULT_SERVER_HOST = "localhost"
 SERVER_FRONTEND_PORT = 9099
 SERVER_BACKEND_PORT = 5555
@@ -16,9 +16,9 @@ def configure_logging():
     )
 
 
-def parse_engine_name_server_host():
+def parse_engine_id_server_host():
     """Parses command line arguments for engine name and server host."""
     parser = argparse.ArgumentParser()
-    parser.add_argument("engine_name", nargs="?", default=DEFAULT_ENGINE_NAME)
+    parser.add_argument("engine_id", nargs="?", default=DEFAULT_ENGINE_ID)
     parser.add_argument("server_host", nargs="?", default=DEFAULT_SERVER_HOST)
     return parser.parse_args()

examples/one_way/engine.py

@@ -14,38 +14,33 @@
 class DisplayEngine(cognitive_engine.Engine):
     """A simple cognitive engine that displays the input frame."""
 
-    def __init__(self, engine_name):
+    def __init__(self, engine_id):
         """Initializes the display engine."""
-        self._engine_name = engine_name
+        self._engine_id = engine_id
 
     def handle(self, input_frame):
         """Handles an input frame."""
         status = gabriel_pb2.Status()
         status.code = gabriel_pb2.StatusCode.SUCCESS
 
-        return Result(status, "Hello from engine")
-        np_data = np.frombuffer(input_frame.payloads[0], dtype=np.uint8)
+        np_data = np.frombuffer(input_frame.byte_payload, dtype=np.uint8)
         frame = cv2.imdecode(np_data, cv2.IMREAD_COLOR)
-        cv2.imshow(f"Image from engine: {self._engine_name}", frame)
+        cv2.imshow(f"Image from engine: {self._engine_id}", frame)
         cv2.waitKey(1)
 
-        status = gabriel_pb2.ResultWrapper.Status.SUCCESS
-        result_wrapper = cognitive_engine.create_result_wrapper(status)
-        return result_wrapper
+        return Result(status, "Hello from engine")
 
 
 def main():
     """Starts the Gabriel engine."""
     common.configure_logging()
-    args = common.parse_engine_name_server_host()
-    engine = DisplayEngine(args.engine_name)
+    args = common.parse_engine_id_server_host()
+    engine = DisplayEngine(args.engine_id)
 
     server_address = SERVER_ADDRESS_FORMAT.format(
         args.server_host, common.SERVER_BACKEND_PORT
     )
-    runner = engine_runner.EngineRunner(
-        engine, args.engine_name, server_address
-    )
+    runner = engine_runner.EngineRunner(engine, args.engine_id, server_address)
     runner.run()
 
 

examples/one_way/producer_client.py

@@ -48,7 +48,7 @@ async def producer():
     input_producers = [
         InputProducer(
             producer=gen_producer(i),
-            target_engine_ids=[common.DEFAULT_ENGINE_NAME],
+            target_engine_ids=[common.DEFAULT_ENGINE_ID],
         )
         for i in range(args.num_sources)
     ]

examples/one_way/push_client.py

@@ -18,7 +18,7 @@ def send_frames(source):
         _, jpeg_frame = cv2.imencode(".jpg", frame)
         input_frame = gabriel_pb2.InputFrame()
         input_frame.payload_type = gabriel_pb2.PayloadType.IMAGE
-        input_frame.payloads.append(jpeg_frame.tobytes())
+        input_frame.byte_payload = jpeg_frame.tobytes()
 
         source.send(input_frame)
         time.sleep(0.1)
@@ -27,8 +27,8 @@ def send_frames(source):
 def main():
     """Starts the Gabriel client."""
     common.configure_logging()
-    args = common.parse_engine_name_server_host()
-    source = push_source.Source(args.engine_name, [common.DEFAULT_ENGINE_NAME])
+    args = common.parse_engine_id_server_host()
+    source = push_source.Source(args.engine_id, [common.DEFAULT_ENGINE_ID])
     p = multiprocessing.Process(target=send_frames, args=(source,))
     p.start()
     input_producers = [source.get_input_producer()]

python-client/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "gabriel-client"
-version = "4.1.2"
+version = "4.1.4"
 description = "Client library for the Gabriel real-time AI orchestration framework"
 requires-python = ">=3.10"
 

python-client/src/gabriel_client/push_source.py

@@ -16,9 +16,9 @@ def consumer(_):
 class Source:
     """A push-based source used to send frames to Gabriel server."""
 
-    def __init__(self, source_name, target_engine_ids):
+    def __init__(self, producer_name, target_engine_ids):
         """Initialize the push-based source."""
-        self._source_name = source_name
+        self._producer_name = producer_name
         self._frame_available = asyncio.Semaphore(0)
         self._latest_input_frame = None
         self._read, self._write = multiprocessing.Pipe(duplex=False)
@@ -47,7 +47,7 @@ async def producer():
         return InputProducer(
             producer=producer,
             target_engine_ids=self._target_engine_ids,
-            source_name=self._source_name,
+            producer_name=self._producer_name,
         )
 
     def send(self, input_frame):