doc

airboxlab · Apr 17, 2024 · 60607d9 · 60607d9
1 parent 9c0f496
commit 60607d9
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 11 deletions.
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -6,5 +6,6 @@
    Overview <overview/index>
    Estimators <ope/index>
    Policies <policy/index>
+   Selection <ops/index>
 
 Welcome to Hopes!
diff --git a/doc/source/ope/index.rst b/doc/source/ope/index.rst
@@ -1,5 +1,5 @@
 Hopes: Estimators
-=================================
+=================
 
 Roadmap
 -------

diff --git a/doc/source/ops/index.rst b/doc/source/ops/index.rst
@@ -0,0 +1,12 @@
+Hopes: Selection
+================
+
+Running an Off-Policy Evaluation (OPE) experiment with Hopes is simple.
+
+First, the :class:`hopes.ope.evaluation.OffPolicyEvaluation` can be used to run an OPE experiment.
+Class documentation provides an example, see below.
+
+.. autoclass:: hopes.ope.evaluation.OffPolicyEvaluation
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/hopes/ope/evaluation.py b/hopes/ope/evaluation.py
@@ -87,16 +87,12 @@ class OffPolicyEvaluation:
 
     Expected output:
 
-    .. code-block:: python
-
-        ╭───────┬─────────┬─────────┬───────────────┬───────────────╮
-        │       │    mean │     std │   lower_bound │   upper_bound │
-        ├───────┼─────────┼─────────┼───────────────┼───────────────┤
-        │ IPW   │ 499.513 │ 5.24146 │       490.678 │       508     │
-        ├───────┼─────────┼─────────┼───────────────┼───────────────┤
-        │ SNIPW │ 499.041 │ 5.14269 │       490.538 │       507.548 │
-        ╰───────┴─────────┴─────────┴───────────────┴───────────────╯
-        Significance level: 0.1
+    =====  =======  =======  =============  =============
+    ..        mean      std    lower_bound    upper_bound
+    =====  =======  =======  =============  =============
+    IPW    499.368  5.28645        491.011        507.669
+    SNIPW  499.538  5.21046        490.714        507.695
+    =====  =======  =======  =============  =============
     """
 
     def __init__(