Skip to content

Commit

Permalink
flag _cli_desc with comments pointing out that this describes the module
Browse files Browse the repository at this point in the history
  • Loading branch information
dorchard committed Dec 6, 2023
1 parent 5095ce7 commit 5a26e1b
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/gz21_ocean_momentum/cli/data.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import xarray as xr
import dask.multiprocessing

# Description of this module
_cli_desc = "GZ21 data step: download CM2.6 dataset, apply coarse graining \
and generate forcings. Saves result to disk in zarr format."

Expand Down
1 change: 1 addition & 0 deletions src/gz21_ocean_momentum/cli/infer.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import gz21_ocean_momentum.train.losses as loss_funcs
from gz21_ocean_momentum.inference.utils import predict_lazy_cm2_6

# Description of this module
_cli_desc = """
Use a trained GZ21 neural net to predict forcing for input ocean velocity data.
Expand Down
1 change: 1 addition & 0 deletions src/gz21_ocean_momentum/cli/train.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
# TODO ideally temporary but probably not
import copy

# Description of this module
_cli_desc = """
Train a Pytorch neural net to predict subgrid ocean momentum forcing from
ocean surface velocity.
Expand Down

0 comments on commit 5a26e1b

Please sign in to comment.