From abc1a0c4190ccc77116544b784f4ffcaff003b2a Mon Sep 17 00:00:00 2001 From: Chih-Yu Yeh Date: Wed, 22 May 2024 11:25:36 +0800 Subject: [PATCH] refine (#299) --- wren-ai-service/README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/wren-ai-service/README.md b/wren-ai-service/README.md index c44019d8b..19a145122 100644 --- a/wren-ai-service/README.md +++ b/wren-ai-service/README.md @@ -1,5 +1,9 @@ # AI Service of WrenAI +## Concepts + +Please read the [documentation](https://docs.getwren.ai/concept/wren_ai_service) here to understand the concepts of Wren AI Service. + ## Environment Setup - Python 3.12.0 @@ -25,8 +29,9 @@ - install `psql` - fill in environment variables: `.env.dev` in the src folder and `config.properties` in the src/eval/wren-engine/etc folder - start the docker service -- run qdrant and wren-engine docker containers: `make run-all` -- evaluation: `make eval-ask` and check out the outputs folder +- evaluation + - `make eval pipeline=ask args="--help"` + - `make eval pipeline=ask_details args="--help"` - `make streamlit` to compare between the evaluation results - to run individual pipeline: `poetry run python -m src.pipelines.ask.[pipeline_name]` (e.g. `poetry run python -m src.pipelines.ask.retrieval_pipeline`)