Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
GiorgioMorales committed Mar 22, 2024
1 parent 0504e8a commit 5fa0b9c
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,16 +60,6 @@ To train the model, we'll call the `train` method.
* `printProcess`: If True, print the training process (loss and validation metrics after each epoch). *default: False*
* `plotCurves`: If True, plot the training and validation curves at the end of the training process

## Repository Structure

This repository contains the following scripts:

* `PIGenerator.py`: Contains the PIGenerator class that is used to perform cross-validation using different NN-based PI-generation methods.
* `utils.py`: Additional methods used to transform the data and calculate the metrics.
* `models/NNmodel.py`: Implements the PI-generation methods tested in this work: DualAQD, QD+, QD, MC-Dropout.
* `models/network.py`: Defines the network architecture.
* `Demo.ipynb`: Jupyter notebook demo using a synthetic dataset.

```python
trainer.train(printProcess=False, epochs=2000, batch_size=16, plotCurves=True)
```
Expand All @@ -96,6 +86,18 @@ print('Test Performance:')
print("Test MSE: " + str(val_mse) + " Test PICP: " + str(PICP) + " Test MPIW: " + str(MPIW))
```

## Repository Structure

This repository contains the following scripts in `src/PredictionIntervals/`:

* `TrainNN.py`: Main method, used to train a PI-generation NN using DualAQD or MCDropout-PI.
* `PIGenerator.py`: Performs cross-validation using different NN-based PI-generation methods. Used for replication of the paper results.
* `utils.py`: Additional methods used to transform the data and calculate the metrics.
* `utils.py`: Additional methods used to transform the data and calculate the metrics.
* `models/NNmodel.py`: Implements the PI-generation methods tested in this work: DualAQD, QD+, QD, MC-Dropout.
* `models/network.py`: Defines the network architecture.
* `Demo.ipynb`: Jupyter notebook demo using a synthetic dataset.

# Citation
Use this Bibtex to cite this repository

Expand Down

0 comments on commit 5fa0b9c

Please sign in to comment.