Project import generated by Copybara.

PiperOrigin-RevId: 319124715

README.md

@@ -10,16 +10,33 @@ 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.
+academic-industrial collaboration. For a detailed description of the RecSim
+architecture please read [Ie et al](https://arxiv.org/abs/1909.04847). Please
+cite the paper if you use the code from this repository in your work.
+
+### Bibtex
+
+```
+@article{ie2019recsim,
+    title={RecSim: A Configurable Simulation Platform for Recommender Systems},
+    author={Eugene Ie and Chih-wei Hsu and Martin Mladenov and Vihan Jain and Sanmit Narvekar and Jing Wang and Rui Wu and Craig Boutilier},
+    year={2019},
+    eprint={1909.04847},
+    archivePrefix={arXiv},
+    primaryClass={cs.LG}
+}
+```
 
 <a id='Disclaimer'></a>
+
 ## Disclaimer
 
 This is not an officially supported Google product.
 
 ## What's new
-*  **12/13/2019:** Added (abstract) classes for both multi-user environments and
-  agents. Added bandit algorithms for generalized linear models.
+
+*   **12/13/2019:** Added (abstract) classes for both multi-user environments
+    and agents. Added bandit algorithms for generalized linear models.
 
 ## Installation and Sample Usage
 
@@ -64,10 +81,12 @@ 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**](recsim/colab/RecSim_Overview.ipynb), we give a brief overview about
-RecSim. We then talk about each configurable component:
-[**environment**](recsim/colab/RecSim_Developing_an_Environment.ipynb) and
+To get started, please check out our Colab tutorials. In
+[**RecSim: Overview**](recsim/colab/RecSim_Overview.ipynb),
+we give a brief overview about RecSim. We then talk about each configurable
+component:
+[**environment**](recsim/colab/RecSim_Developing_an_Environment.ipynb)
+and
 [**recommender agent**](recsim/colab/RecSim_Developing_an_Agent.ipynb).
 
 ## Documentation

docs/api_docs/python/_redirects.yaml

@@ -1,3 +1,9 @@
 redirects:
+- from: /recsim/api_docs/python/recsim/environments/interest_exploration/FLAGS
+  to: /recsim/api_docs/python/recsim/environments/interest_evolution/FLAGS
+- from: /recsim/api_docs/python/recsim/environments/long_term_satisfaction/FLAGS
+  to: /recsim/api_docs/python/recsim/environments/interest_evolution/FLAGS
 - from: /recsim/api_docs/python/recsim/simulator/environment/SingleUserEnvironment
   to: /recsim/api_docs/python/recsim/simulator/environment/Environment
+- from: /recsim/api_docs/python/recsim/simulator/runner_lib/FLAGS
+  to: /recsim/api_docs/python/recsim/environments/interest_evolution/FLAGS

docs/api_docs/python/_toc.yaml

@@ -201,6 +201,8 @@ toc:
       path: /recsim/api_docs/python/recsim/environments/interest_evolution/clicked_watchtime_reward
     - title: create_environment
       path: /recsim/api_docs/python/recsim/environments/interest_evolution/create_environment
+    - title: FLAGS
+      path: /recsim/api_docs/python/recsim/environments/interest_evolution/FLAGS
     - title: IEvResponse
       path: /recsim/api_docs/python/recsim/environments/interest_evolution/IEvResponse
     - title: IEvUserDistributionSampler

docs/api_docs/python/index.md

@@ -77,6 +77,7 @@
 *   <a href="./recsim/document/CandidateSet.md"><code>recsim.document.CandidateSet</code></a>
 *   <a href="./recsim/environments.md"><code>recsim.environments</code></a>
 *   <a href="./recsim/environments/interest_evolution.md"><code>recsim.environments.interest_evolution</code></a>
+*   <a href="./recsim/environments/interest_evolution/FLAGS.md"><code>recsim.environments.interest_evolution.FLAGS</code></a>
 *   <a href="./recsim/environments/interest_evolution/IEvResponse.md"><code>recsim.environments.interest_evolution.IEvResponse</code></a>
 *   <a href="./recsim/environments/interest_evolution/IEvUserDistributionSampler.md"><code>recsim.environments.interest_evolution.IEvUserDistributionSampler</code></a>
 *   <a href="./recsim/environments/interest_evolution/IEvUserModel.md"><code>recsim.environments.interest_evolution.IEvUserModel</code></a>
@@ -89,6 +90,7 @@
 *   <a href="./recsim/environments/interest_evolution/create_environment.md"><code>recsim.environments.interest_evolution.create_environment</code></a>
 *   <a href="./recsim/environments/interest_evolution/total_clicks_reward.md"><code>recsim.environments.interest_evolution.total_clicks_reward</code></a>
 *   <a href="./recsim/environments/interest_exploration.md"><code>recsim.environments.interest_exploration</code></a>
+*   <a href="./recsim/environments/interest_evolution/FLAGS.md"><code>recsim.environments.interest_exploration.FLAGS</code></a>
 *   <a href="./recsim/environments/interest_exploration/IEClusterUserSampler.md"><code>recsim.environments.interest_exploration.IEClusterUserSampler</code></a>
 *   <a href="./recsim/environments/interest_exploration/IEDocument.md"><code>recsim.environments.interest_exploration.IEDocument</code></a>
 *   <a href="./recsim/environments/interest_exploration/IEResponse.md"><code>recsim.environments.interest_exploration.IEResponse</code></a>
@@ -98,6 +100,7 @@
 *   <a href="./recsim/environments/interest_exploration/create_environment.md"><code>recsim.environments.interest_exploration.create_environment</code></a>
 *   <a href="./recsim/environments/interest_exploration/total_clicks_reward.md"><code>recsim.environments.interest_exploration.total_clicks_reward</code></a>
 *   <a href="./recsim/environments/long_term_satisfaction.md"><code>recsim.environments.long_term_satisfaction</code></a>
+*   <a href="./recsim/environments/interest_evolution/FLAGS.md"><code>recsim.environments.long_term_satisfaction.FLAGS</code></a>
 *   <a href="./recsim/environments/long_term_satisfaction/LTSDocument.md"><code>recsim.environments.long_term_satisfaction.LTSDocument</code></a>
 *   <a href="./recsim/environments/long_term_satisfaction/LTSDocumentSampler.md"><code>recsim.environments.long_term_satisfaction.LTSDocumentSampler</code></a>
 *   <a href="./recsim/environments/long_term_satisfaction/LTSResponse.md"><code>recsim.environments.long_term_satisfaction.LTSResponse</code></a>
@@ -116,6 +119,7 @@
 *   <a href="./recsim/simulator/recsim_gym/RecSimGymEnv.md"><code>recsim.simulator.recsim_gym.RecSimGymEnv</code></a>
 *   <a href="./recsim/simulator/runner_lib.md"><code>recsim.simulator.runner_lib</code></a>
 *   <a href="./recsim/simulator/runner_lib/EvalRunner.md"><code>recsim.simulator.runner_lib.EvalRunner</code></a>
+*   <a href="./recsim/environments/interest_evolution/FLAGS.md"><code>recsim.simulator.runner_lib.FLAGS</code></a>
 *   <a href="./recsim/simulator/runner_lib/Runner.md"><code>recsim.simulator.runner_lib.Runner</code></a>
 *   <a href="./recsim/simulator/runner_lib/TrainRunner.md"><code>recsim.simulator.runner_lib.TrainRunner</code></a>
 *   <a href="./recsim/simulator/runner_lib/load_gin_configs.md"><code>recsim.simulator.runner_lib.load_gin_configs</code></a>

docs/api_docs/python/recsim.md

@@ -5,7 +5,10 @@
 
 # Module: recsim
 
+<!-- Insert buttons and diff -->
+
 <table class="tfo-notebook-buttons tfo-api" align="left">
+
 </table>
 
 <a target="_blank" href="https://github.com/google-research/recsim/tree/master/recsim/__init__.py">View

docs/api_docs/python/recsim/agent.md

@@ -5,7 +5,10 @@
 
 # Module: recsim.agent
 
+<!-- Insert buttons and diff -->
+
 <table class="tfo-notebook-buttons tfo-api" align="left">
+
 </table>
 
 <a target="_blank" href="https://github.com/google-research/recsim/tree/master/recsim/agent.py">View