Skip to content

Commit

Permalink
Update Readme to include Cornac-AB section (#638)
Browse files Browse the repository at this point in the history
* Add Cornac-AB section to Readme.md

* Update README.md

* Update assets directory and downsized images

---------

Co-authored-by: Tuan Truong <[email protected]>
  • Loading branch information
darrylong and tqtg authored Sep 4, 2024
1 parent 163c315 commit 73123c9
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ brew install gcc | brew link gcc

## Getting started: your first Cornac experiment

![](flow.jpg)
![](assets/flow.jpg)
<p align="center"><i>Flow of an Experiment in Cornac</i></p>

```python
Expand Down Expand Up @@ -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).
Expand Down
Binary file added assets/demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/feedback-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file added assets/recommendation-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 73123c9

Please sign in to comment.