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 create -n reco-gym
conda activate reco-gym

# conda support is missing, use pipinstead
pip install gym
pip install recogym

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.1.2.tar.gz (38.6 kB view details)

Uploaded Source

Built Distribution

recogym-0.1.1.2-py3-none-any.whl (54.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: recogym-0.1.1.2.tar.gz
  • Upload date:
  • Size: 38.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.9

File hashes

Hashes for recogym-0.1.1.2.tar.gz
Algorithm Hash digest
SHA256 8b05ec33dbd0b163b5a590f1f1f6ae9e625af39349fbfe4a551ebde3e829a30a
MD5 abbe4ae807f14696b70ae8108d7a63da
BLAKE2b-256 b711ec33bec3412c67b7f0235377a36e7dbbacde8ca27fd1e86546370e5f4523

See more details on using hashes here.

File details

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

File metadata

  • Download URL: recogym-0.1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 54.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.9

File hashes

Hashes for recogym-0.1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 04fa8495c2fd7852deb881e9b086d269bcecc0c6b34f6df0b0ef5134d2f7bebe
MD5 5121c9a9c17d8771c3f16d182393bc3f
BLAKE2b-256 4051912a73e3a4aba636d216c493081daaa19c9c18a39b419d8a865784ae4a92

See more details on using hashes here.

Supported by

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