Skip to content

Commit ae09abd

Browse files
committed
cods build docstring complaints
1 parent 41007bd commit ae09abd

File tree

3 files changed

+11
-9
lines changed

3 files changed

+11
-9
lines changed

src/mpol/crossval.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ class CrossValidate:
4646
strength ('lambda', float), whether to guess an initial value for lambda
4747
('guess', bool), and other quantities needed to compute their loss term.
4848
Example:
49-
{"sparsity":{"lambda":1e-3, "guess":False},
50-
"entropy": {"lambda":1e-3, "guess":True, "prior_intensity":1e-10}
51-
}
49+
{"sparsity":{"lambda":1e-3, "guess":False},
50+
"entropy": {"lambda":1e-3, "guess":True, "prior_intensity":1e-10}
51+
}
5252
train_diag_step : int, default=None
5353
Interval at which training diagnostics are output. If None, no
5454
diagnostics will be generated.

src/mpol/fourier.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,9 @@ def __init__(self, coords: GridCoords, persistent_vis: bool = False):
4848
def from_image_properties(
4949
cls, cell_size: float, npix: int, persistent_vis: bool = False
5050
) -> FourierCube:
51-
r"""Alternative method for instantiating a FourierCube from ``cell_size``
52-
and ``npix``
51+
r"""
52+
Alternative method for instantiating a FourierCube from ``cell_size`` and ``npix``
53+
5354
Args:
5455
cell_size (float): the width of an image-plane pixel [arcseconds]
5556
npix (int): the number of pixels per image side
@@ -298,6 +299,7 @@ def from_image_properties(
298299
nchan: int = 1,
299300
sparse_matrices: bool = True,
300301
) -> NuFFT:
302+
301303
coords = GridCoords(cell_size, npix)
302304
return cls(coords, uu, vv, nchan, sparse_matrices)
303305

src/mpol/plot.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ def split_diagnostics_fig(splitter, channel=0, save_prefix=None):
272272
Parameters
273273
----------
274274
splitter : `mpol.crossval.RandomCellSplitGridded` object
275-
Iterator that returns a `(train, test)` pair of `GriddedDataset`s
275+
Iterator that returns a `(train, test)` pair of `GriddedDataset`
276276
for each iteration.
277277
channel : int, default=0
278278
Channel (of the datasets in `splitter`) to use to generate figure
@@ -339,9 +339,9 @@ def train_diagnostics_fig(model, losses=[], train_state=None, channel=0,
339339
"""
340340
Figure for model diagnostics during an optimization loop. For a `model` in
341341
a given state, plots the current:
342-
- model image (both linear and arcsinh colormap normalization)
343-
- gradient image
344-
- loss function
342+
- model image (both linear and arcsinh colormap normalization)
343+
- gradient image
344+
- loss function
345345
346346
Parameters
347347
----------

0 commit comments

Comments
 (0)