Skip to content

Commit

Permalink
Add repo structure to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dead-water committed Apr 9, 2024
1 parent ee65882 commit 6d2b5fc
Showing 1 changed file with 19 additions and 10 deletions.
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,27 +44,36 @@ In version 2.0, we present an update to the work outlined in [Galvez et al. 2019
FITS header/keyword information (such as observation time, and exposure time).
Processes for continually updating the data until the present day.

## Repo structure
```bash
├── assets # images for this readme
├── experiments # configuration files for different trails
├── notebooks # visualisation/testing ipynb
├── scripts # entrypoint and highest level executors
├── sdofm # python package
│ ├── datasets # dataloaders/modules
│ ├── finetuning # modules for finetuning
│ ├── models # model components
└── └── pretraining # modules for pretraining
```

## Pre-training
```bash
python scripts/main.py --config-name=pretrain
python scripts/main.py --config-name=pretrain_tiny
```


## Fine-tuning
### Science objective 1
### Science objective 2
### Science objective 3
### Science objective 1: Dimming
```bash
python scripts/main.py --config-name=so1
python scripts/main.py --config-name=dimming_tiny
```
### Science objective 2: TBD
### Science objective 3: TBD

## Inference
```bash
python scripts/main.py --config-name=deploy
```

## Additional Documentation

TODO

## Citation
```bib
Expand Down

0 comments on commit 6d2b5fc

Please sign in to comment.