Initial file structure changes for Package (#16)

VowpalWabbit · Jun 8, 2021 · 144091b · 144091b
1 parent 993c080
commit 144091b
Show file tree

Hide file tree

Showing 15 changed files with 57 additions and 8 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,24 @@
+#Jupyter notebook checkpoints
+**/.ipynb_checkpoints/*
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info
+
+# Python build artifacts
+build/
+dist/
+
+#ignored examples files
+examples/*.log
+
+# Editors
+.vscode/
+.idea/
+
+# Type checking
+.mypy_cache
+
+.coverage
diff --git a/estimators/__init__.py b/estimators/__init__.py
diff --git a/basic-usage.py → estimators/basic-usage.py b/basic-usage.py → estimators/basic-usage.py
@@ -1,9 +1,9 @@
 import argparse, os, gzip
-import cressieread
-import ips_snips
-import mle
-import ds_parse
-import cats_utils
+from contextual_bandits import cressieread
+from contextual_bandits import ips_snips
+from contextual_bandits import mle
+from utils import ds_parse
+from contextual_bandits import cats_utils
 
 
 def compute_estimates(log_fp, cats_transformer=None):

diff --git a/estimators/contextual_bandits/__init__.py b/estimators/contextual_bandits/__init__.py
diff --git a/cats_utils.py → estimators/contextual_bandits/cats_utils.py b/cats_utils.py → estimators/contextual_bandits/cats_utils.py
diff --git a/cressieread.py → estimators/contextual_bandits/cressieread.py b/cressieread.py → estimators/contextual_bandits/cressieread.py
diff --git a/ips_snips.py → estimators/contextual_bandits/ips_snips.py b/ips_snips.py → estimators/contextual_bandits/ips_snips.py
diff --git a/mle.py → estimators/contextual_bandits/mle.py b/mle.py → estimators/contextual_bandits/mle.py
diff --git a/estimators/slates/__init__.py b/estimators/slates/__init__.py
diff --git a/pseudo_inverse.py → estimators/slates/pseudo_inverse.py b/pseudo_inverse.py → estimators/slates/pseudo_inverse.py
diff --git a/estimators/test/__init__.py b/estimators/test/__init__.py
diff --git a/test/test_pi.py → estimators/test/test_pi.py b/test/test_pi.py → estimators/test/test_pi.py
@@ -1,9 +1,9 @@
 import os, sys
 sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
 
-import pseudo_inverse
-import ips_snips
-import cats_utils
+from slates import pseudo_inverse
+from contextual_bandits import ips_snips
+from contextual_bandits import cats_utils
 
 def test_single_slot_pi_equivalent_to_ips():
     """PI should be equivalent to IPS when there is only a single slot"""

diff --git a/estimators/utils/__init__.py b/estimators/utils/__init__.py
diff --git a/ds_parse.py → estimators/utils/ds_parse.py b/ds_parse.py → estimators/utils/ds_parse.py
diff --git a/setup.py b/setup.py
@@ -0,0 +1,25 @@
+import setuptools
+
+with open("README.md", "r") as f:
+    long_description = f.read()
+
+setuptools.setup(
+    name="vw-estimators",
+    version="0.0.1",
+    description="Python package of estimators to perform off-policy evaluation",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/VowpalWabbit/estimators.git",
+    license="BSD 3-Clause License",
+    classifiers=[
+        "Intended Audience :: Science/Research",
+        "License :: OSI Approved :: BSD License",
+        "Programming Language :: Python :: 3.6",
+        "Operating System :: OS Independent",
+        "Topic :: Scientific/Engineering"
+    ],
+    packages=["estimators", "estimators.contextual_bandits", "estimators.slates", "estimators.utils"],
+    install_requires= ['scipy>=0.9'],
+    tests_require=['pytest'],
+    python_requires=">=3.6",
+)