Skip to content
Snippets Groups Projects
Commit e82d1e1f authored by pjm363 (Philip Monaco)'s avatar pjm363 (Philip Monaco)
Browse files

Merge branch '18-patch-module-issues' into 'main'

Resolve "Patch module issues"

Closes #18

See merge request pjm363/why-senior-project!7
parents 97c238da ef21755e
Branches
No related tags found
No related merge requests found
Pipeline #1627 passed
Showing
with 73 additions and 117 deletions
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
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
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
File deleted
File deleted
# 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
File moved
......@@ -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
......
No preview for this file type
No preview for this file type
No preview for this file type
File moved
File moved
File moved
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment