Skip to main content

Open-AI gym reinforcement learning environment for recommendation

Project description

RecoGym

Python code for the RecSys 2018 REVEAL workshop paper entitled 'RecoGym: A Reinforcement Learning Environment for the problem of Product Recommendation in Online Advertising'. A pre-print version of the paper can be found here - https://arxiv.org/abs/1808.00720

RecoGym is a Open-AI gym RL environment for recommendation, which is defined by a model of user traffic patterns on e-commerce and the users response to recommendations on the publisher websites. We hope that RecoGym will be an important step forward for the field of recommendation systems research, that could open up an avenue of collaboration between the recommender systems and reinforcement learning communities and lead to better alignment between offline and online performance metrics.

For getting starting with RecoGym please view the 'Getting Started' Jupyter Notebook which will explain the functionality of the environment and detail the creation of a simple agent. The 'Compare Agent' notebook compares the recommendation performance of a selection of our included agents. The agent we include with RecoGym can be found in the agents directory of this repository.

Dependencies and Requirements

The code has been designed to support python 3.7+ only. The project has the following dependencies and version requirements:

  • notebook=5.6.0+
  • matplotlib=2.2.3+
  • numpy=1.15.1+
  • python=3.7.1+
  • pandas=0.23.4+
  • scipy=1.1.0+
  • pytorch=1.0+
  • rpy2=2.9.1+
  • scikit-learn=0.20.1+

In this repository we provide a Anaconda environment setup file with all the required python packages and versions all ready configured. You can install it as follows:

# install conda env
conda install -c conda conda-env
conda install -c r r-essentials

# create environment based on environment.yml
conda-env create environment.yml

# conda support is missing, use pipinstead
pip install gym

Cite

Please cite the associated paper for this work if you use this code:

@article{rohde2018recogym,
  title={RecoGym: A Reinforcement Learning Environment for the problem of Product Recommendation in Online Advertising},
  author={Rohde, David and Bonner, Stephen and Dunlop, Travis and Vasile, Flavian and Karatzoglou, Alexandros},
  journal={arXiv preprint arXiv:1808.00720},
  year={2018}
}

License

Copyright CRITEO

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

recogym-0.1.0.0.tar.gz (24.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

recogym-0.1.0.0-py3-none-any.whl (38.2 kB view details)

Uploaded Python 3

File details

Details for the file recogym-0.1.0.0.tar.gz.

File metadata

  • Download URL: recogym-0.1.0.0.tar.gz
  • Upload date:
  • Size: 24.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.1

File hashes

Hashes for recogym-0.1.0.0.tar.gz
Algorithm Hash digest
SHA256 ea5a7e9da509aaaa18b42b3ea13c40d77e52f3f0252508f7d665371f98717ac0
MD5 2fa8c5c065578aa179a91a2a29071813
BLAKE2b-256 75a4dae9f28a6e53575510afdd87b0f8a2346e80e67b1e9b8d9fb3dc578eef43

See more details on using hashes here.

File details

Details for the file recogym-0.1.0.0-py3-none-any.whl.

File metadata

  • Download URL: recogym-0.1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 38.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.1

File hashes

Hashes for recogym-0.1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 294f277bbe9d810aaf6704a53c89606ee698a896a3486206b41d40600ba2b6f0
MD5 43b9d9f6465f2fd466f140f6168f4534
BLAKE2b-256 88ae739f6277dc23a9cc5fd8fa1074b7ee348aa9c167745c20433809bacda5b0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page