add basic setup.py

csinva · Jul 18, 2019 · 1ac2cd3 · 1ac2cd3
1 parent df31faa
commit 1ac2cd3
Show file tree

Hide file tree

Showing 32 changed files with 19 additions and 7 deletions.
diff --git a/.gitignore b/.gitignore
@@ -14,3 +14,13 @@ env
 **.idea
 *.pth
 **Icon*
+# Compiled python modules.
+*.pyc
+
+# Setuptools distribution folder.
+/dist/
+
+# Python egg metadata, regenerated from source files by setuptools.
+/*.egg-info
+
+build
diff --git a/imodels/__init__.py b/imodels/__init__.py
@@ -0,0 +1,3 @@
+from . import bayesian_rule_lists
+from . import slim
+from . import optimal_classification_tree
diff --git a/models/bayesian_rule_lists/.gitignore → imodels/bayesian_rule_lists/.gitignore b/models/bayesian_rule_lists/.gitignore → imodels/bayesian_rule_lists/.gitignore
diff --git a/...n_rule_lists/BigDataRuleListClassifier.py → ...n_rule_lists/BigDataRuleListClassifier.py b/...n_rule_lists/BigDataRuleListClassifier.py → ...n_rule_lists/BigDataRuleListClassifier.py
diff --git a/...bayesian_rule_lists/RuleListClassifier.py → ...bayesian_rule_lists/RuleListClassifier.py b/...bayesian_rule_lists/RuleListClassifier.py → ...bayesian_rule_lists/RuleListClassifier.py
diff --git a/...ule_lists/SVMBigDataRuleListClassifier.py → ...ule_lists/SVMBigDataRuleListClassifier.py b/...ule_lists/SVMBigDataRuleListClassifier.py → ...ule_lists/SVMBigDataRuleListClassifier.py
diff --git a/models/__init__.py → imodels/bayesian_rule_lists/__init__.py b/models/__init__.py → imodels/bayesian_rule_lists/__init__.py
diff --git a/models/bayesian_rule_lists/brl.py → imodels/bayesian_rule_lists/brl.py b/models/bayesian_rule_lists/brl.py → imodels/bayesian_rule_lists/brl.py
diff --git a/models/bayesian_rule_lists/demo.ipynb → imodels/bayesian_rule_lists/demo.ipynb b/models/bayesian_rule_lists/demo.ipynb → imodels/bayesian_rule_lists/demo.ipynb
diff --git a/...ayesian_rule_lists/discretization/MDLP.py → ...ayesian_rule_lists/discretization/MDLP.py b/...ayesian_rule_lists/discretization/MDLP.py → ...ayesian_rule_lists/discretization/MDLP.py
diff --git a/...sian_rule_lists/discretization/entropy.py → ...sian_rule_lists/discretization/entropy.py b/...sian_rule_lists/discretization/entropy.py → ...sian_rule_lists/discretization/entropy.py
diff --git a/...esian_rule_lists/discretization/readme.md → ...esian_rule_lists/discretization/readme.md b/...esian_rule_lists/discretization/readme.md → ...esian_rule_lists/discretization/readme.md
diff --git a/...e_lists/examples/diabetes_bigdata_demo.py → ...e_lists/examples/diabetes_bigdata_demo.py b/...e_lists/examples/diabetes_bigdata_demo.py → ...e_lists/examples/diabetes_bigdata_demo.py
diff --git a/...ists/examples/hepatitis_mixeddata_demo.py → ...ists/examples/hepatitis_mixeddata_demo.py b/...ists/examples/hepatitis_mixeddata_demo.py → ...ists/examples/hepatitis_mixeddata_demo.py
diff --git a/models/bayesian_rule_lists/readme.md → imodels/bayesian_rule_lists/readme.md b/models/bayesian_rule_lists/readme.md → imodels/bayesian_rule_lists/readme.md
diff --git a/models/optimal_classification_tree/baron → imodels/optimal_classification_tree/baron b/models/optimal_classification_tree/baron → imodels/optimal_classification_tree/baron
diff --git a/...ls/optimal_classification_tree/demo.ipynb → ...ls/optimal_classification_tree/demo.ipynb b/...ls/optimal_classification_tree/demo.ipynb → ...ls/optimal_classification_tree/demo.ipynb
diff --git a/..._classification_tree/pyoptree/__init__.py → ..._classification_tree/pyoptree/__init__.py b/..._classification_tree/pyoptree/__init__.py → ..._classification_tree/pyoptree/__init__.py
diff --git a/...l_classification_tree/pyoptree/example.py → ...l_classification_tree/pyoptree/example.py b/...l_classification_tree/pyoptree/example.py → ...l_classification_tree/pyoptree/example.py
diff --git a/...assification_tree/pyoptree/localsearch.py → ...assification_tree/pyoptree/localsearch.py b/...assification_tree/pyoptree/localsearch.py → ...assification_tree/pyoptree/localsearch.py
diff --git a/...al_classification_tree/pyoptree/optree.py → ...al_classification_tree/pyoptree/optree.py b/...al_classification_tree/pyoptree/optree.py → ...al_classification_tree/pyoptree/optree.py
diff --git a/...imal_classification_tree/pyoptree/tree.py → ...imal_classification_tree/pyoptree/tree.py b/...imal_classification_tree/pyoptree/tree.py → ...imal_classification_tree/pyoptree/tree.py
diff --git a/models/optimal_classification_tree/readme.md → ...els/optimal_classification_tree/readme.md b/models/optimal_classification_tree/readme.md → ...els/optimal_classification_tree/readme.md
diff --git a/models/optimal_classification_tree/setup.py → imodels/optimal_classification_tree/setup.py b/models/optimal_classification_tree/setup.py → imodels/optimal_classification_tree/setup.py
diff --git a/models/slim/SLIM.py → imodels/slim/SLIM.py b/models/slim/SLIM.py → imodels/slim/SLIM.py
diff --git a/models/slim/readme.md → imodels/slim/readme.md b/models/slim/readme.md → imodels/slim/readme.md
diff --git a/models/rulefit b/models/rulefit
diff --git a/1_model_based.ipynb → notebooks/1_model_based.ipynb b/1_model_based.ipynb → notebooks/1_model_based.ipynb
diff --git a/2_posthoc.ipynb → notebooks/2_posthoc.ipynb b/2_posthoc.ipynb → notebooks/2_posthoc.ipynb
diff --git a/3_uncertainty.ipynb → notebooks/3_uncertainty.ipynb b/3_uncertainty.ipynb → notebooks/3_uncertainty.ipynb
diff --git a/readme.md b/readme.md
@@ -4,18 +4,18 @@ Code for implementations of interpretable machine learning models and demos of h
 
 
 ### Code implementations
-Provides scikit-learn style implementations of different interpretable models (see readmes in individual folders within [models](models) for details)
+Provides scikit-learn style wrappers/implementations of different interpretable models (see readmes in individual folders within [models](models) for details)
 
 - [bayesian rule lists](https://arxiv.org/abs/1602.08610)
 - [optimal classification tree](https://link.springer.com/article/10.1007/s10994-017-5633-9)
 - sparse integer linear models (simple, unstable implementation)
 
 ### Demo notebooks
-The demos are contained in 3 main notebooks, summarized in [cheat_sheet.pdf](cheat_sheet.pdf)
+The demos are contained in 3 main [notebooks](notebooks), summarized in [cheat_sheet.pdf](cheat_sheet.pdf)
 
-1. [model_based.ipynb](model_based.ipynb) - how to use different interpretable models
-2. [posthoc.ipynb](posthoc.ipynb) - different simple analyses to interpret a trained model
-3. [uncertainty.ipynb](uncertainty.ipynb) - code to get uncertainty estimates for a model
+1. [model_based.ipynb](notebooks/model_based.ipynb) - how to use different interpretable models
+2. [posthoc.ipynb](notebooks/posthoc.ipynb) - different simple analyses to interpret a trained model
+3. [uncertainty.ipynb](notebooks/uncertainty.ipynb) - code to get uncertainty estimates for a model
 
 
 ### References / further reading

diff --git a/setup.py b/setup.py
@@ -4,7 +4,7 @@
     long_description = fh.read()
 
 setuptools.setup(
-    name="interpretable_models",
+    name="imodels",
     version="0.0.1",
     author="Chandan Singh",
     author_email="[email protected]",