reclist 2.1.0
RecList
License: MIT license
Requires Python: >=3.6
Keywords: reclist

=======
RecList
=======

.. image:: images/reclist.png
        :width: 30%
        :alt: Rocket Emoji


.. image:: https://img.shields.io/pypi/v/reclist.svg
        :target: https://pypi.python.org/pypi/reclist

.. image:: https://readthedocs.org/projects/reclist/badge/?version=latest
        :target: https://reclist.readthedocs.io/en/latest/?version=latest
        :alt: Documentation Status

.. image:: https://github.com/jacopotagliabue/reclist/workflows/Python%20package/badge.svg
        :target: https://github.com/jacopotagliabue/reclist/actions

.. image:: https://img.shields.io/github/contributors/jacopotagliabue/reclist
        :target: https://github.com/jacopotagliabue/reclist/graphs/contributors/
        :alt: Contributors

.. image:: https://img.shields.io/badge/License-MIT-blue.svg
        :target: https://lbesson.mit-license.org/
        :alt: License

.. image:: https://pepy.tech/badge/reclist
        :target: https://pepy.tech/project/reclist
        :alt: Downloads

.. image:: https://img.shields.io/badge/youtube-video-red
        :target: https://www.youtube.com/watch?v=cAlJYxFYA04
        :alt: YouTube



Overview
--------

*RecList* is an open source library providing behavioral, "black-box" testing for recommender systems. Inspired by the pioneering work of
`Ribeiro et al. 2020 <https://aclanthology.org/2020.acl-main.442.pdf>`__ in NLP, we introduce a general plug-and-play procedure to scale up behavioral testing, with an easy-to-extend interface for custom use cases.

While quantitative metrics over held-out data points are important, a lot more tests are needed for recommenders
to properly function in the wild and not erode our confidence in them: for example, a model may boast an accuracy improvement over the entire dataset, but actually be significantly worse than another on rare items or new users; or again, a model that correctly recommends HDMI cables as add-on for shoppers buying a TV, may also wrongly  recommend TVs to shoppers just buying a cable.

*RecList* goal is to operationalize these important intuitions into a practical package for testing research and production models in a more nuanced way, without
requiring unnecessary custom code and ad hoc procedures.

If you are not familiar with the library, we suggest first taking our small tour to get acquainted with the main abstractions through ready-made models and tests.

Colab Tutorials
~~~~~~~~~~~~~~~


.. |colab1_tutorial| image:: https://colab.research.google.com/assets/colab-badge.svg
    :target: https://colab.research.google.com/drive/1GVsVB1a3H9qbRQvwtb0TBDxq8A5nXc5w?usp=sharing
    :alt: Open In Colab

.. |colab2_tutorial| image:: https://colab.research.google.com/assets/colab-badge.svg
    :target: https://colab.research.google.com/drive/1QeXglfCUEcscHB6L0Gch2qDKDDlfwLlq?usp=sharing
    :alt: Open In Colab

.. |colab3_tutorial| image:: https://colab.research.google.com/assets/colab-badge.svg
    :target: https://colab.research.google.com/drive/1ek-TIT1ZJta59-O73GaXsOINvt46dnkz?usp=sharing
    :alt: Open In Colab

+--------------------------------------------------------------------------------+------------------+
| Name                                                                           | Link             |
+================================================================================+==================+
| Tutorial 101 - Introduction to Reclist                                         | |colab1_tutorial||
+--------------------------------------------------------------------------------+------------------+
| Tutorial - RecList at EvalRS2023 (KDD)                                         | |colab2_tutorial||
+--------------------------------------------------------------------------------+------------------+
| Tutorial -  FashionCLIP Evaluation with RecList                                | |colab3_tutorial||
+--------------------------------------------------------------------------------+------------------+

Quick Links
~~~~~~~~~~~

* The original `paper <https://dl.acm.org/doi/abs/10.1145/3487553.3524215>`__ (`arxiv <https://arxiv.org/abs/2111.09963>`__) and initial `release post <https://towardsdatascience.com/ndcg-is-not-all-you-need-24eb6d2f1227>`__.
* `EvalRS22@CIKM <https://github.com/RecList/evalRS-CIKM-2022>`__ and `EvalRS23@KDD <https://reclist.io/kdd2023-cup/>`__ , for music recommendations with RecList.
* A `colab notebook <https://colab.research.google.com/drive/1GVsVB1a3H9qbRQvwtb0TBDxq8A5nXc5w>`__, for a quick interactive tour.
* Our `website <https://reclist.io/>`__ for past talks and presentations.


Status
~~~~~~~~~~~

* *RecList* is free software released under the MIT license, and it has been adopted by popular `open-source <https://github.com/RecList/evalRS-CIKM-2022>`__  `data challenges <https://reclist.io/kdd2023-cup/>`__.
* After a major API re-factoring, *RecList* is now in *beta*.

Summary
~~~~~~~

This doc is structured as follows:

* `Quick Start`_
* `A Guided Tour`_
* `Capabilities`_
* `License and Citation`_
* `Acknowledgments`_

Quick Start
-----------

You can take a quick tour online using our `colab notebook <https://colab.research.google.com/drive/1GVsVB1a3H9qbRQvwtb0TBDxq8A5nXc5w>`__.
If you want to use *RecList* locally, clone the repository, create and activate a virtual env, and install the required packages from pip (you can also install from root of course).

.. code-block:: bash

    git clone https://github.com/jacopotagliabue/reclist
    cd reclist
    python3 -m venv venv
    source venv/bin/activate
    pip install reclist
    cd examples
    python dummy.py

The sample script will run a suite of tests on a dummy dataset and model, showcasing a typical workflow with the library. Note the commented arguments in the script, which you can use to customize the behavior of the library
once you familiarize yourself with the basic patterns (e.g. using S3 to store the plots, leveraging a third-party tool to track experiments).

Once your development setup is working as expected, you can run

.. code-block:: bash

    python evalrs_2023.py

to explore tests on a real-world `dataset <https://github.com/RecList/evalRS-KDD-2023>`__ (make sure the `files <https://github.com/RecList/evalRS-KDD-2023/blob/c1b42ec8cb81562417bbb3c2713d301dc652141d/evaluation/utils.py#L18C11-L18C11>`__ are available in the `examples` folder before you run the script).
Finally, once you've run successfully the sample scripts, take the guided tour below to learn more about the abstractions and the full capabilities of *RecList*.

A Guided Tour
-------------

An instance of `RecList <https://github.com/jacopotagliabue/reclist/blob/main/reclist/reclist.py>`__ represents a suite of tests for recommender systems.

As *evalrs_2023.py* shows, we leave users quite a wide range of options: we provide out of the box standard metrics
in case your dataset is DataFrame-shaped (or you can / wish turn it into such a shape), but don't force you any pattern if you just want to use *RecList*
for the scaffolding it provides.

For example, the following code only assumes you have a dataset with golden labels, predictions, and metadata (e.g. item features) in the shape of a DataFrame:

.. code-block:: python

    cdf = DFSessionRecList(
        dataset=df_events,
        model_name="myDataFrameRandomModel",
        predictions=df_predictions,
        y_test=df_dataset,
        logger=LOGGER.LOCAL,
        metadata_store= METADATA_STORE.LOCAL,
        similarity_model=my_sim_model,
    )

    cdf(verbose=True)

Our library pre-packages standard recSys metrics and important behavioral tests, but it is built with extensibility in mind: you can re-use tests in new suites, or you can write new domain-specific suites and tests.
Any suite must inherit from the main interface, and then declare its tests as functions decorated with *@rec_test*.

In the example, an instance is created with one slice-based test: the decorator and return type are used to automatically generate a chart.

.. code-block:: python

    class MyRecList(RecList):

        @rec_test(test_type="AccuracyByCountry", display_type=CHART_TYPE.BARS)
        def accuracy_by_country(self):
            """
            Compute the accuracy by country

            NOTE: the accuracy here is just a random number.
            """
            from random import randint
            return {"US": randint(0, 100), "CA": randint(0, 100), "FR": randint(0, 100) }


Inheritance is powerful, as we can build new suites by re-using existing ones. Here, we inherit the tests from an existing "parent" list and just add one more to create a new suite:

.. code-block:: python

    class ChildRecList(MyParentRecList):

        @rec_test(test_type='custom_test', display_type=CHART_TYPE.SCALAR)
        def my_test(self):
            """
            Custom test, returning my lucky number as an example
            """
            from random import randint

            return { "luck_number": randint(0, 100) }


Any model can be tested, as no assumption is made on the model's structure, but only the availability of *predictions*
and *ground truth*. Once again, while our example leverages a DataFrame-shaped dataset for these entities, you are free to build your own
RecList instance with any shape you prefer, provided you implement the metrics accordingly (see *dummy.py* for an example with different input types).

Once you run a suite of tests, results are dumped automatically and versioned in a folder (local or on S3), structured as follows
(name of the suite, name of the model, run timestamp):

.. code-block::

    .reclist/
      myList/
        myModel/
          1637357392/
          1637357404/

If you use *RecList* as part of your standard testings - either for research or production purposes - you can use the JSON report
for machine-to-machine communication with downstream systems (e.g. you may want to automatically fail the `pipeline <https://github.com/jacopotagliabue/recs-at-resonable-scale>`__  if tests are not passed).

Capabilities
------------

*RecList* provides a dataset and model agnostic framework to scale up behavioral tests. We provide some suggested abstractions
based on DataFrames to make existing tests and metrics fully re-usable, but we don't force any pattern on the user. As out-of-the box functionality, the package provides:

* tests and metrics to be used on your own datasets and models;

* automated storage of results, with versioning, both in a local folder or on S3;

* flexible, Python interface to declare tests-as-functions, and annotate them with *display_type* for automated charts;

* pre-built connectors with popular experiment trackers (e.g. Neptune, Comet), and an extensible interface to add your own (see below);

* reference implementations based on popular data challenges that used RecList: for an example of the "less wrong" latent space metric you can check the song2vec implementation `here <https://github.com/RecList/evalRS-KDD-2023/blob/c1b42ec8cb81562417bbb3c2713d301dc652141d/evaluation/eval.py#L42>`__.

Using Third-Party Tracking Tools
--------------------------------

*RecList* supports streaming the results of your tests directly to your cloud platform of choice, both as metrics and charts.

If you have the `Python client installed <https://docs.neptune.ai/about/api/>`__, you can use the
Neptune logger by simply specifying it at init time, and either passing *NEPTUNE_KEY* and *NEPTUNE_PROJECT_NAME* as kwargs, or setting them as environment variables.

.. code-block:: python

    cdf = DFSessionRecList(
        dataset=df_events,
        model_name="myDataFrameRandomModel",
        predictions=df_predictions,
        y_test=df_dataset,
        logger=LOGGER.NEPTUNE,
        metadata_store= METADATA_STORE.LOCAL,
        similarity_model=my_sim_model
    )

    cdf(verbose=True)

If you have the `Python client installed <https://pypi.org/project/comet-ml/>`__, you can use the
Comet logger by simply specifying it at init time, and either passing *COMET_KEY*, *COMET_PROJECT_NAME*, *COMET_WORKSPACE* as kwargs, or setting them as environment variables.

.. code-block:: python

    cdf = DFSessionRecList(
        dataset=df_events,
        model_name="myDataFrameRandomModel",
        predictions=df_predictions,
        y_test=df_dataset,
        logger=LOGGER.COMET,
        metadata_store= METADATA_STORE.LOCAL,
        similarity_model=my_sim_model
    )

    cdf(verbose=True)


If you wish to add a new platform, you can do so by simply implementing a new class inheriting from RecLogger.

Acknowledgments
---------------

The original authors are:

* Patrick John Chia - `LinkedIn <https://www.linkedin.com/in/patrick-john-chia-b0a34019b/>`__, `GitHub <https://github.com/patrickjohncyh>`__
* Jacopo Tagliabue - `LinkedIn <https://www.linkedin.com/in/jacopotagliabue/>`__, `GitHub <https://github.com/jacopotagliabue>`__
* Federico Bianchi - `LinkedIn <https://www.linkedin.com/in/federico-bianchi-3b7998121/>`__, `GitHub <https://github.com/vinid>`__
* Chloe He - `LinkedIn <https://www.linkedin.com/in/chloe-he//>`__, `GitHub <https://github.com/chloeh13q>`__
* Brian Ko - `LinkedIn <https://www.linkedin.com/in/briankosw/>`__, `GitHub <https://github.com/briankosw>`__

*RecList* is a community project made possible by the generous support of awesome folks. Between June and December 2022, the development of our beta has been supported by `Comet <https://www.comet.com/>`__, `Neptune <https://neptune.ai/homepage>`__ , `Gantry <https://gantry.io/>`__.
Our beta has been developed with the help of:

* Unnati Patel - `LinkedIn <https://www.linkedin.com/in/unnati-p-16626610a/>`__
* Ciro Greco - `LinkedIn <https://www.linkedin.com/in/cirogreco/>`__

If you have questions or feedback, please reach out to: :code:`jacopo dot tagliabue at nyu dot edu`.

License and Citation
--------------------

All the code is released under an open MIT license. If you found *RecList* useful, please cite our WWW paper:

.. code-block:: bash

    @inproceedings{10.1145/3487553.3524215,
        author = {Chia, Patrick John and Tagliabue, Jacopo and Bianchi, Federico and He, Chloe and Ko, Brian},
        title = {Beyond NDCG: Behavioral Testing of Recommender Systems with RecList},
        year = {2022},
        isbn = {9781450391306},
        publisher = {Association for Computing Machinery},
        address = {New York, NY, USA},
        url = {https://doi.org/10.1145/3487553.3524215},
        doi = {10.1145/3487553.3524215},
        pages = {99–104},
        numpages = {6},
        keywords = {recommender systems, open source, behavioral testing},
        location = {Virtual Event, Lyon, France},
        series = {WWW '22 Companion}
    }

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
History
=======

0.1.0 (2021-11-16)
------------------

* First release on PyPI.