From 78fa8385d79cd79d594e0550524f901c62bf6db6 Mon Sep 17 00:00:00 2001 From: Shuchang Zheng Date: Wed, 13 Sep 2023 10:28:10 -0700 Subject: [PATCH] explain the response and update more doc --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9a4d2e0..ffb5ba6 100644 --- a/README.md +++ b/README.md @@ -146,7 +146,7 @@ curl --location 'http://0.0.0.0:5001/api/v1/ranking' \ }' ``` -This request sends 24 products retrieved from search to Wyvern and ask Wyvern to return the 8 products (in descending order) to show on the first page (`"user_page": 0`). +This request sends 24 products to Wyvern. Wyvern ranks these products and return the 8 products (in descending order) to show on the first page (`"user_page": 0`). You should see a response with the products being ordered descendingly by their ranking score. @@ -196,7 +196,9 @@ You should see a response with the products being ordered descendingly by their :tada:Congratulations on making your first Wyvern request!!! -To learn more about Wyvern, please check out our [official documentations](https://docs.wyvern.ai/) +To learn more about how this ML pipeline is built, check out [Wyvern ML Pipeline](https://docs.wyvern.ai/ml_pipeline) + +To learn more about Wyvern in general, check out our [documentations](https://docs.wyvern.ai/) ## More Documentations