Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuaspear committed Sep 12, 2024
1 parent 1fe8136 commit 3ddd17d
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# offline_rl_ope: Realworld off-policy evaluation
# offline rl ope: A Python package for off-policy evaluation of offline RL models with realworld data

> [!WARNING]
> - All IS methods implemented incorrectly in versions < 6.x
Expand Down Expand Up @@ -65,6 +65,18 @@ Basic unit testing has been implemented for all the core functionality of the pa
* PyPi: https://pypi.org/project/offline-rl-ope/
* To install from sourse using pip, clone this repository and run ```pip install .``` in the top level of the repo.

### Citation
When using this package in your work, please cite the following:
```
@misc{Spear2024,
author = {Joshua Spear},
title = {offline_rl_ope: A Python package for off-policy evaluation of offline RL models with realworld data},
year = {2024},
month = {9},
url = {https://github.com/joshuaspear/offline_rl_ope},
}
```

### Future work
* Async/multithread support
* Additional estimators:
Expand Down

0 comments on commit 3ddd17d

Please sign in to comment.