Skip to content

Commit

Permalink
updated docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
grantbuster committed Feb 12, 2024
1 parent 4996053 commit ac0443d
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions sup3r/models/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,12 @@ def __init__(self,
discriminative model (spatial or spatiotemporal discriminator). Can
also be a str filepath to a .json config file containing the input
layers argument or a .pkl for a saved pre-trained model.
loss : str
loss : str | dict
Loss function class name from sup3r.utilities.loss_metrics
(prioritized) or tensorflow.keras.losses. Defaults to
tf.keras.losses.MeanSquaredError.
tf.keras.losses.MeanSquaredError. This can be provided as a dict
with kwargs for loss functions with extra parameters.
e.g. {'SpatialExtremesLoss': {'weight': 0.5}}
optimizer : tf.keras.optimizers.Optimizer | dict | None | str
Instantiated tf.keras.optimizers object or a dict optimizer config
from tf.keras.optimizers.get_config(). None defaults to Adam.
Expand Down

0 comments on commit ac0443d

Please sign in to comment.