Skip to main content

RecSim: A Configurable Recommender Systems Simulation Platform

Project description

RecSim: A Configurable Recommender Systems Simulation Platform

RecSim is a configurable platform for authoring simulation environments for recommender systems (RSs) that naturally supports sequential interaction with users. RecSim allows the creation of new environments that reflect particular aspects of user behavior and item structure at a level of abstraction well-suited to pushing the limits of current reinforcement learning (RL) and RS techniques in sequential interactive recommendation problems. Environments can be easily configured that vary assumptions about: user preferences and item familiarity; user latent state and its dynamics; and choice models and other user response behavior. We outline how RecSim offers value to RL and RS researchers and practitioners, and how it can serve as a vehicle for academic-industrial collaboration.

Disclaimer

This is not an officially supported Google product.

Installation and Sample Usage

It is recommended to install RecSim using (https://pypi.org/project/recsim/):

pip install recsim

Here are some sample commands you could use for testing the installation:

git clone https://github.com/google-research/recsim
cd recsim
pythob main.py -- --logtostderr \
  --base_dir="/tmp/recsim/interest_exploration_full_slate_q" \
  --agent_name=full_slate_q \
  --environment_name=interest_exploration \
  --episode_log_file='episode_logs.tfrecord' \
  --gin_bindings=simulator.runner_lib.Runner.max_steps_per_episode=100 \
  --gin_bindings=simulator.runner_lib.TrainRunner.num_iterations=10 \
  --gin_bindings=simulator.runner_lib.TrainRunner.max_training_steps=100 \
  --gin_bindings=simulator.runner_lib.EvalRunner.max_eval_episodes=5 \
  --gin_bindings=create_experiment.slate_size=3

You could then start a tensorboard and view the output

tensorboard --logdir=/tmp/recsim/interest_exploration_full_slate_q/ --port=2222

You could also find the simulated logs in /tmp/recsim/episode_logs.tfrecord

Tutorials

To get started, please check out our Colab tutorials. In RecSim: Overview, we give a brief overview about RecSim. We then talk about each configurable component: environment and recommender agent.

Documentation

API documentation can be found in SITEMAP.

Please refer to the white paper for the high-level design.

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

recsim-0.1.2.tar.gz (59.8 kB view details)

Uploaded Source

Built Distribution

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

recsim-0.1.2-py3-none-any.whl (101.5 kB view details)

Uploaded Python 3

File details

Details for the file recsim-0.1.2.tar.gz.

File metadata

  • Download URL: recsim-0.1.2.tar.gz
  • Upload date:
  • Size: 59.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.8

File hashes

Hashes for recsim-0.1.2.tar.gz
Algorithm Hash digest
SHA256 b949df6d3225e715e175eb699d78c91774f48027ceefa6e8ce0b53e639505784
MD5 88f7c8e6c88ab83441cffccce63fd466
BLAKE2b-256 a21f26f1ef8e6be5381ccbdb3df5714f944b4e7df88799027c3eaf3ce82eb100

See more details on using hashes here.

File details

Details for the file recsim-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: recsim-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 101.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.8

File hashes

Hashes for recsim-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2d4281ca3d63233daa395817539fec5f14d3d3cd8d18b55c9c6e0436ed8af119
MD5 6a4078a2236a78bcdcb951172ffbded7
BLAKE2b-256 aa5027d680631c7567e5639b4164f22869226da0df742c4a2514480475164332

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