Add README.md

2026-05-28 11:28:25 +00:00
commit 840fb21754
1 changed files with 29 additions and 0 deletions
@@ -0,0 +1,29 @@
+# Shopping Planner Agent
+
+## Prerequisites
+- Python 3.10 or newer
+- A local LLM endpoint (e.g., LM Studio, Ollama) running at `http://localhost:1234/v1`.
+- The model name should be set in `agent.py` where `model="<название модели в LM Studio>"`.
+
+## Installation
+```bash
+python -m venv .venv
+source .venv/bin/activate  # On Windows use .venv\Scripts\activate
+pip install -r requirements.txt
+```
+
+## Running the Agent
+```bash
+python agent.py
+```
+You will be prompted to enter a query. The agent will stream tokens to the console incrementally, separating each step with `--- --- ---`.
+
+## Example
+```
+Введите запрос: Какой у меня бюджет на продукты в Казани?
+get_price({'product': 'молоко', 'city': 'Казань'})--- --- ---
+... (streamed tokens) ...
+--- --- ---
+```
+
+Ensure that the endpoint URL and model name match your local setup.