diff --git a/README.md b/README.md index d8a43a8df0744e7adcc4f09e4d8eabf793419aff..c9b7a940de3a638c22f32a993e716984b674f84a 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ brew install gcc | brew link gcc ## Getting started: your first Cornac experiment - + <p align="center"><i>Flow of an Experiment in Cornac</i></p> ```python @@ -125,6 +125,14 @@ $ curl -X GET "http://localhost:8080/recommend?uid=63&k=5&remove_seen=false" ``` If we want to remove seen items during training, we need to provide `TRAIN_SET` which has been saved with the model earlier, when starting the serving app. We can also leverage [WSGI](https://flask.palletsprojects.com/en/3.0.x/deploying/) server for model deployment in production. Please refer to [this](https://cornac.readthedocs.io/en/stable/user/iamadeveloper.html#running-an-api-service) guide for more details. +## Model A/B testing + +[Cornac-AB](https://github.com/preferredAI/cornac-ab) is an extension of Cornac using the Cornac Serving API. Easily create and manage A/B testing experiments to further understand your model performance with online users. + +| User Interaction Solution | Recommendations Dashboard | Feedback Dashboard | +|:------------------------:|:------------------------:|:------------------:| +| <img src="assets/demo.png" alt="demo" width="250"/> | <img src="assets/recommendation-dashboard.png" alt="recommendations" width="250"/> | <img src="assets/feedback-dashboard.png" alt="feedback" width="250"/> | + ## Efficient retrieval with ANN search One important aspect of deploying recommender model is efficient retrieval via Approximate Nearest Neighbor (ANN) search in vector space. Cornac integrates several vector similarity search frameworks for the ease of deployment. [This example](tutorials/ann_hnswlib.ipynb) demonstrates how ANN search will work seamlessly with any recommender models supporting it (e.g., matrix factorization). diff --git a/assets/demo.png b/assets/demo.png new file mode 100644 index 0000000000000000000000000000000000000000..924ce489516b6452a49b12dd1da6120b16373622 Binary files /dev/null and b/assets/demo.png differ diff --git a/assets/feedback-dashboard.png b/assets/feedback-dashboard.png new file mode 100644 index 0000000000000000000000000000000000000000..878e4a168d5c1a136d1b9f16e655af04dc060b91 Binary files /dev/null and b/assets/feedback-dashboard.png differ diff --git a/flow.jpg b/assets/flow.jpg similarity index 100% rename from flow.jpg rename to assets/flow.jpg diff --git a/assets/recommendation-dashboard.png b/assets/recommendation-dashboard.png new file mode 100644 index 0000000000000000000000000000000000000000..d4a4e66b716c29099b44bd0696f91edf53823231 Binary files /dev/null and b/assets/recommendation-dashboard.png differ