refactor: remove rai.utils module (#524)

Author: maciejmajek

README.md

@@ -118,7 +118,7 @@ rosdep install --from-paths src --ignore-src -r -y
 Run the configuration tool to set up your vendor and other settings:
 
 ```bash
-poetry run streamlit run src/rai_core/rai/utils/configurator.py
+poetry run streamlit run src/rai_core/rai/frontend/configurator.py
 ```
 
 > [!TIP]  

docs/debugging_assistant.md

@@ -22,7 +22,7 @@ The ROS 2 Debugging Assistant is an interactive tool that helps developers inspe
 
 ```sh
 source setup_shell.sh
-streamlit run src/rai_core/rai/tools/debugging_assistant.py
+streamlit run examples/debugging_assistant.py
 ```
 
 ## Usage Examples

docs/developer_guide.md

@@ -132,7 +132,7 @@ from myrobot import robot
 
 from rai.agents.conversational_agent import create_conversational_agent
 from rai.agents.state_based import create_state_based_agent
-from rai.utils.model_initialization import get_llm_model
+from rai import get_llm_model
 
 SYSTEM_PROMPT = "You are a robot with interfaces..."
 

docs/developer_guide/tools.md

@@ -195,7 +195,8 @@ TODO(docs): add link to the BaseAgent docs (regarding distributed setup)
 from rai.agents import ReActAgent
 from rai.communication import ROS2ARIConnector, ROS2HRIConnector
 from rai.tools.ros2 import ROS2Toolkit
-from rai.utils import ROS2Context, wait_for_shutdown
+from rai.communication.ros2 import ROS2Context
+from rai import AgentRunner
 
 @ROS2Context()
 def main() -> None:
@@ -206,8 +207,8 @@ def main() -> None:
         connectors={"hri": connector},
         tools=initialize_tools(connector=ari_connector),
     )
-    agent.run()
-    wait_for_shutdown([agent])
+    runner = AgentRunner([agent])
+    runner.run_and_wait_for_shutdown()
 
 # Example:
 # ros2 topic pub /from_human rai_interfaces/msg/HRIMessage "{\"text\": \"What do you see?\"}"
@@ -221,7 +222,7 @@ def main() -> None:
 ```python
 from rai.agents.langchain import create_react_runnable
 from langchain.schema import HumanMessage
-from rai.utils import ROS2Context, wait_for_shutdown
+from rai.communication.ros2 import ROS2Context
 
 @ROS2Context()
 def main():

docs/multimodal_messages.md

@@ -18,7 +18,7 @@ Example:
 
 ```python
 from rai.messages import HumanMultimodalMessage, preprocess_image
-from rai.utils.model_initialization import get_llm_model
+from rai import get_llm_model
 
 base64_image = preprocess_image('https://raw.githubusercontent.com/RobotecAI/RobotecGPULidar/develop/docs/image/rgl-logo.png')
 

docs/tracing.md

@@ -40,7 +40,7 @@ To enable tracing in your RAI application, you need to import the get_tracing_ca
 1. First, import the get_tracing_callbacks() function:
 
 ```python
-from rai.utils.model_initialization import get_tracing_callbacks
+from rai import get_tracing_callbacks
 ```
 
 2. Then, add it to the configuration when invoking your agent or model:

examples/agents/react.py

@@ -12,10 +12,9 @@
 # See the License for the specific language goveself.rning permissions and
 # limitations under the License.
 
-from rai.agents import ReActAgent
-from rai.communication.ros2 import ROS2ARIConnector, ROS2HRIConnector
+from rai.agents import AgentRunner, ReActAgent
+from rai.communication.ros2 import ROS2ARIConnector, ROS2Context, ROS2HRIConnector
 from rai.tools.ros2 import ROS2Toolkit
-from rai.utils import ROS2Context, wait_for_shutdown
 
 
 @ROS2Context()
@@ -26,8 +25,8 @@ def main():
         connectors={"hri": connector},
         tools=ROS2Toolkit(connector=ari_connector).get_tools(),
     )  # type: ignore
-    agent.run()
-    wait_for_shutdown([agent])
+    runner = AgentRunner([agent])
+    runner.run_and_wait_for_shutdown()
 
 
 if __name__ == "__main__":

examples/agriculture-demo.py

@@ -17,11 +17,11 @@
 import rclpy
 from langchain_core.messages import HumanMessage
 from langchain_core.runnables import Runnable
+from rai import get_llm_model
 from rai.agents.conversational_agent import State, create_conversational_agent
 from rai.communication.ros2.connectors import ROS2ARIConnector
 from rai.tools.ros2 import ROS2ServicesToolkit, ROS2TopicsToolkit
 from rai.tools.time import WaitForSecondsTool
-from rai.utils.model_initialization import get_llm_model
 from rclpy.callback_groups import ReentrantCallbackGroup
 from rclpy.executors import MultiThreadedExecutor
 from rclpy.node import Node

examples/debugging_assistant.py

@@ -0,0 +1,50 @@
+# Copyright (C) 2024 Robotec.AI
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import streamlit as st
+from rai import get_llm_model
+from rai.agents import create_conversational_agent
+from rai.frontend import run_streamlit_app
+from rai.tools.ros2 import ROS2CLIToolkit
+
+
+@st.cache_resource
+def initialize_agent():
+    llm = get_llm_model(model_type="complex_model", streaming=True)
+    agent = create_conversational_agent(
+        llm,
+        ROS2CLIToolkit().get_tools(),
+        system_prompt="""You are a ROS 2 expert helping a user with their ROS 2 questions. You have access to various tools that allow you to query the ROS 2 system.
+                Be proactive and use the tools to answer questions. Retrieve as much information from the ROS 2 system as possible.
+                """,
+    )
+    return agent
+
+
+st.set_page_config(
+    page_title="ROS 2 Debugging Assistant",
+    page_icon=":robot:",
+)
+
+
+def main():
+    run_streamlit_app(
+        initialize_agent(),
+        page_title="ROS 2 Debugging Assistant",
+        initial_message="Hi! I am a ROS 2 assistant. How can I help you?",
+    )
+
+
+if __name__ == "__main__":
+    main()

examples/manipulation-demo.py

@@ -16,11 +16,11 @@
 import rclpy
 import rclpy.qos
 from langchain_core.messages import HumanMessage
+from rai import get_llm_model
 from rai.agents.conversational_agent import create_conversational_agent
 from rai.communication.ros2.connectors import ROS2ARIConnector
 from rai.tools.ros2 import GetROS2ImageTool, GetROS2TopicsNamesAndTypesTool
 from rai.tools.ros2.manipulation import GetObjectPositionsTool, MoveToPointTool
-from rai.utils.model_initialization import get_llm_model
 from rai_open_set_vision.tools import GetGrabbingPointTool