Skip to content

Commit

Permalink
removing image, adding markdown tree
Browse files Browse the repository at this point in the history
  • Loading branch information
beckynevin committed Oct 22, 2024
1 parent 49bd646 commit 32aa6a9
Showing 1 changed file with 37 additions and 4 deletions.
41 changes: 37 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,15 @@ DeepUQ is a package for injecting and measuring different types of uncertainty i
## Installation

### Install the deepuq package via venv and pypi
> python3.10 -m venv test_env
> python3.10 -m venv name_of_your_virtual_env
> source test_env/bin/activate
> source name_of_your_virtual_env/bin/activate
> pip install deepuq
Now you can run some of the scripts!
> UQensemble --generatedata
^`generatedata` is required if you don't have any saved data. You can set other keywords like so.

It's also possible to verify the install works by running:
Expand Down Expand Up @@ -55,14 +56,43 @@ Begin the environment
Now you have access to all the dependencies necessary to run the package.

## Package structure
DeepUQ/
├── CHANGELOG.md
├── LICENSE.txt
├── README.md
├── DeepUQResources/
├── data/
├── dist/
├── environment.yml
├── images/
├── models/
├── notebooks/
├── poetry.lock
├── pyproject.toml
├── src/
│ ├── __init__.py
│ ├── analyze/
│ ├── data/
│ ├── models/
│ ├── scripts/
│ ├── train/
│ └── utils/
├── test/
│ ├── DeepUQResources/
│ ├── data/
│ ├── test_DeepEnsemble.py
│ └── test_DeepEvidentialRegression.py

## How to run the workflow
![Folder structure overview](images/DeepUQWorkflow_Maggie.png)

## How to run the workflow
The scripts can be accessed via the ipython example notebooks or via the model modules (ie `DeepEnsemble.py`). For example, to ingest data and train a Deep Ensemble from the DeepUQ/ directory:

> python src/scripts/DeepEnsemble.py
The equivalent shortcut command:
> UQensemble
With no config file specified, this command will pull settings from the `default.py` file within `utils`. For the `DeepEnsemble.py` script, it will automatically select the `DefaultsDE` dictionary.

Another option is to specify your own config file:
Expand All @@ -83,5 +113,8 @@ For more information on the arguments:
The other available script is the `DeepEvidentialRegression.py` script:
> python src/scripts/DeepEvidentialRegression.py --help
The shortcut:
> UQder


0 comments on commit 32aa6a9

Please sign in to comment.