Skip to content

Commit

Permalink
add instructions to README for managing conda env
Browse files Browse the repository at this point in the history
  • Loading branch information
henryaddison committed Oct 22, 2024
1 parent 95d1ac2 commit 322a0c1
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,21 @@ Diffusion model implementation forked from PyTorch implementation for the paper

Any datasets are assumed to be found in `${DERIVED_DATA}/moose/nc-datasets/{dataset_name}/`. In particular, the config key config.data.dataset_name is the name of the dataset to use to train the model.

### Updating conda environment

To add new packages or update their version, it is recommended to use the `environment.txt` file (for conda packages) and `requirements.txt` file (for pip packages) then run:
```sh
conda env install -f environment.txt
pip install -e . # this will implicitly use requirement.txt
conda env export -f environment.lock.yml
```
then commit any changes (though make sure not to include mlde-notebooks package in the lock file since that is not distributed via PyPI).

To sync environment with the lock file use:
```sh
conda env update -f environment.lock.yml --prune
```

## Diffusion Model Usage

### Data
Expand Down

0 comments on commit 322a0c1

Please sign in to comment.