diff --git a/WHY/WHY.egg-info/PKG-INFO b/WHY/WHY.egg-info/PKG-INFO deleted file mode 100644 index adf55de5983c860a9a71b51abd2a3cb783d0edd5..0000000000000000000000000000000000000000 --- a/WHY/WHY.egg-info/PKG-INFO +++ /dev/null @@ -1,71 +0,0 @@ -Metadata-Version: 2.1 -Name: WHY -Version: 0.0.1.dev0+5059977 -Summary: Explainable AI system -Home-page: https://gitlab.cci.drexel.edu/pjm363/why-senior-project -Author: Philip Monaco, Abdullah Shah, Ibrahim Elsaid, Jashanpreet Singh, William Lu, Songheng Li -License: LICENSE.md -Description: # WHY Senior Project - - ## Installing WHY - - There are two way in which the `WHY` package can be installed. - First, follow the [prerequisite](#prerequisites) instructions. - IF you do not need to rebuild documentation or make modifications to the library, follow the instructions under [User Installation](#user-installation). - Otherwise, follow the instructions under [Developer Installation](#developer-installation). - - ### Prerequisites - - The `WHY` requires at least `python3.8` and makes use of a number of third-party libraries. The bare minimum packages are automatically installed when you install `WHY` using `pip`. Additional dependencies for developers are contained in `requirements.txt` file. See the - - It's recommended that you use `WHY` within a python virtual environment. - Virtual environments are now included natively with Python 3 using `venv`. Instructions to create a virtual environment can be found [here](https://docs.python.org/3/library/venv.html). - - API documentation requires the use of `sphinx` which will require installing `Cmake`. Installation instructions can be found [here](https://cmake.org/install/). - - ### User Installation - - First you must clone the repository using the following bash command. - ```bash - pip clone git@gitlab.cci.drexel.edu:pjm363/why-senior-project.git - ``` - - From the root path of the repository (the folder where `setup.py` is located) `WHY` can be installed using `pip` using the following command. - - ```bash - pip install . - ``` - - ### Developer Installation - Developers need an additional tool, `clang-format` in order to run the precommit script. - - Install via Ubuntu. - ```bash - apt-get install clang-format - ``` - Install via MacOSX with homebrew. - ```bash - brew install clang-format - ``` - Install via [installer](https://llvm.org/builds/) or using chocolatey via. - ```bash - choco install llvm - ``` - - ## Building API Documentation - - To build the API Documentation in HTML format for local browsing, execute the following from the root of the repository. - ``` - cd docs/ - make html - ``` - - This will also cause any examples contained in `examples` to be generated in the example gallery. - All documentation is also built automatically when the `./precommit.sh` script is run. - -Platform: UNKNOWN -Requires-Python: >=3.8 -Description-Content-Type: text/markdown -Provides-Extra: lint -Provides-Extra: docs -Provides-Extra: all diff --git a/WHY/WHY.egg-info/SOURCES.txt b/WHY/WHY.egg-info/SOURCES.txt deleted file mode 100644 index 59834884dd5805081d7d8e1f00f2df02d9f0d580..0000000000000000000000000000000000000000 --- a/WHY/WHY.egg-info/SOURCES.txt +++ /dev/null @@ -1,8 +0,0 @@ -README.md -setup.py -src/WHY.egg-info/PKG-INFO -src/WHY.egg-info/SOURCES.txt -src/WHY.egg-info/dependency_links.txt -src/WHY.egg-info/not-zip-safe -src/WHY.egg-info/requires.txt -src/WHY.egg-info/top_level.txt \ No newline at end of file diff --git a/WHY/WHY.egg-info/dependency_links.txt b/WHY/WHY.egg-info/dependency_links.txt deleted file mode 100644 index 8b137891791fe96927ad78e64b0aad7bded08bdc..0000000000000000000000000000000000000000 --- a/WHY/WHY.egg-info/dependency_links.txt +++ /dev/null @@ -1 +0,0 @@ - diff --git a/WHY/WHY.egg-info/not-zip-safe b/WHY/WHY.egg-info/not-zip-safe deleted file mode 100644 index 8b137891791fe96927ad78e64b0aad7bded08bdc..0000000000000000000000000000000000000000 --- a/WHY/WHY.egg-info/not-zip-safe +++ /dev/null @@ -1 +0,0 @@ - diff --git a/WHY/WHY.egg-info/requires.txt b/WHY/WHY.egg-info/requires.txt deleted file mode 100644 index e0c87a227f7df1ad1af7b1e909c526942b5ee70e..0000000000000000000000000000000000000000 --- a/WHY/WHY.egg-info/requires.txt +++ /dev/null @@ -1,32 +0,0 @@ -numpy>=1.21 -pandas>=1.3.5 -bokeh>=2.4.2 -matplotlib>=3.5.0 -scikit-learn>=1.0.2 - -[all] -numpy>=1.21 -pandas>=1.3.5 -bokeh>=2.4.2 -matplotlib>=3.5.0 -scikit-learn>=1.0.2 -black==21.12b0 -isort==5.10.1 -flake8==4.0.1 -mypy -Sphinx -sphinx-gallery -sphinx-rtd-theme -m2r2 - -[docs] -Sphinx -sphinx-gallery -sphinx-rtd-theme -m2r2 - -[lint] -black==21.12b0 -isort==5.10.1 -flake8==4.0.1 -mypy diff --git a/WHY/WHY.egg-info/top_level.txt b/WHY/WHY.egg-info/top_level.txt deleted file mode 100644 index 8b137891791fe96927ad78e64b0aad7bded08bdc..0000000000000000000000000000000000000000 --- a/WHY/WHY.egg-info/top_level.txt +++ /dev/null @@ -1 +0,0 @@ - diff --git a/WHY/__pycache__/__init__.cpython-39.pyc b/WHY/__pycache__/__init__.cpython-39.pyc deleted file mode 100644 index 15b11825b829fbc2888942ff921f35f27c518637..0000000000000000000000000000000000000000 Binary files a/WHY/__pycache__/__init__.cpython-39.pyc and /dev/null differ diff --git a/WHY/__pycache__/callbacks.cpython-39.pyc b/WHY/__pycache__/callbacks.cpython-39.pyc deleted file mode 100644 index e27ed75d6803ca326a093520fb929f89d78bd946..0000000000000000000000000000000000000000 Binary files a/WHY/__pycache__/callbacks.cpython-39.pyc and /dev/null differ diff --git a/WHY/__pycache__/config.cpython-39.pyc b/WHY/__pycache__/config.cpython-39.pyc deleted file mode 100644 index 12e7a4d1fcdf69454296ad09a52fbe2f581951a7..0000000000000000000000000000000000000000 Binary files a/WHY/__pycache__/config.cpython-39.pyc and /dev/null differ diff --git a/examples/README.rst b/examples/README.rst new file mode 100644 index 0000000000000000000000000000000000000000..6418f19ed762a9af341a7a1fada57b1368147fe8 --- /dev/null +++ b/examples/README.rst @@ -0,0 +1,70 @@ +# WHY Senior Project + +## Installing WHY + +There are two way in which the `WHY` package can be installed. +First, follow the [prerequisite](#prerequisites) instructions. +IF you do not need to rebuild documentation or make modifications to the library, follow the instructions under [User Installation](#user-installation). +Otherwise, follow the instructions under [Developer Installation](#developer-installation). + +### Prerequisites + +The `WHY` requires at least `python3.8` and makes use of a number of third-party libraries. The bare minimum packages are automatically installed when you install `WHY` using `pip`. Additional dependencies for developers are contained in `requirements.txt` file. See the + +It's recommended that you use `WHY` within a python virtual environment. +Virtual environments are now included natively with Python 3 using `venv`. Instructions to create a virtual environment can be found [here](https://docs.python.org/3/library/venv.html). + +API documentation requires the use of `sphinx` which will require installing `Cmake`. Installation instructions can be found [here](https://cmake.org/install/). + +### User Installation + +First you must clone the repository using the following bash command. +```bash +pip clone git@gitlab.cci.drexel.edu:pjm363/why-senior-project.git +``` + +From the root path of the repository (the folder where `setup.py` is located) `WHY` can be installed using `pip` using the following command. + +```bash +pip install . +``` + +### Developer Installation +Developers need an additional tool, `clang-format` in order to run the precommit script. + +Install via Ubuntu. +```bash +apt-get install clang-format +``` +Install via MacOSX with homebrew. +```bash +brew install clang-format +``` +Install via [installer](https://llvm.org/builds/) or using chocolatey via. +```bash +choco install llvm +``` +### Bokeh Server Developer Mode +To automatically update the server with the new scripts run the following in the command line: + +Linux/MacOs +```bash +bokeh serve --show app_name.py --dev +``` + +Windows +```bash +python -m bokeh serve --show app_name.py --dev +``` + + +## Building API Documentation + +To build the API Documentation in HTML format for local browsing, execute the following from the root of the repository. +``` +cd docs/ +make html +``` + +This will also cause any examples contained in `examples` to be generated in the example gallery. +All documentation is also built automatically when the `./precommit.sh` script is run. \ No newline at end of file diff --git a/WHY/__init__.py b/examples/__init__.py similarity index 100% rename from WHY/__init__.py rename to examples/__init__.py diff --git a/examples/decision_tree/main.py b/examples/decision_tree/main.py index 1047f2b6ae1bc03c7b78a0123638bb5c57ac1048..3ca1536be4eebada06be154132b6a7837f20e5e1 100644 --- a/examples/decision_tree/main.py +++ b/examples/decision_tree/main.py @@ -3,9 +3,9 @@ import numpy as np from sklearn.tree import export_graphviz from subprocess import call -from WHY.synthetic import SyntheticData, update_samples_or_dataset -from WHY.data_vis import vis_synthetic -import WHY.config as config +from synthetic import * +from data_vis import * +import config as config from bokeh.io import curdoc from bokeh.models import ColumnDataSource, Select, Slider, Plot, Scatter, Row, Column diff --git a/src/__init__.py b/src/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/src/__pycache__/config.cpython-39.pyc b/src/__pycache__/config.cpython-39.pyc new file mode 100644 index 0000000000000000000000000000000000000000..0650c2a0dbcb056cd227becbdf4da2adf5f0706d Binary files /dev/null and b/src/__pycache__/config.cpython-39.pyc differ diff --git a/WHY/__pycache__/data_vis.cpython-39.pyc b/src/__pycache__/data_vis.cpython-39.pyc similarity index 84% rename from WHY/__pycache__/data_vis.cpython-39.pyc rename to src/__pycache__/data_vis.cpython-39.pyc index dc3c987c3f10c75eddd994b7046cb9b17e8c9d74..8feeafb82a19ab1115a80b71c143fc42a91b4412 100644 Binary files a/WHY/__pycache__/data_vis.cpython-39.pyc and b/src/__pycache__/data_vis.cpython-39.pyc differ diff --git a/WHY/__pycache__/synthetic.cpython-39.pyc b/src/__pycache__/synthetic.cpython-39.pyc similarity index 70% rename from WHY/__pycache__/synthetic.cpython-39.pyc rename to src/__pycache__/synthetic.cpython-39.pyc index 5e3f6a298e564f8428ef74532d0f57c745274ead..7bbc8f7ea736dca24a07880b5f7664624267837e 100644 Binary files a/WHY/__pycache__/synthetic.cpython-39.pyc and b/src/__pycache__/synthetic.cpython-39.pyc differ diff --git a/WHY/config.py b/src/config.py similarity index 100% rename from WHY/config.py rename to src/config.py diff --git a/WHY/data_vis.py b/src/data_vis.py similarity index 100% rename from WHY/data_vis.py rename to src/data_vis.py diff --git a/WHY/synthetic.py b/src/synthetic.py similarity index 100% rename from WHY/synthetic.py rename to src/synthetic.py