sup3r.utilities.loss_metrics.GeothermalPhysicsLoss#

class GeothermalPhysicsLoss(input_features='all')[source]#

Bases: PhysicsBasedLoss

Physics based loss for Geothermal applications

TODO: Fill in call with appropriate physics equations. This is currently just a dummy equation for testing.

Initialize the loss with given input features

Parameters:

input_features (list | str) – List of input features that the loss metric will be calculated on. This is meant to be used for physics-based loss metrics that require specific input features. If ‘all’, the loss will be calculated on all features. Otherwise, the loss will be calculated on the features specified in the list. The order of features in the list will be checked to determine the order of features in the input tensors.

Methods

call(y_true, y_pred)

Invokes the Loss instance.

from_config(config)

Instantiates a Loss from its config (output of get_config()).

get_config()

Returns the config dictionary for a Loss instance.

Attributes

LOSS_METRIC

abstract call(y_true, y_pred)#

Invokes the Loss instance.

Args:
y_true: Ground truth values. shape = [batch_size, d0, .. dN],

except sparse loss functions such as sparse categorical crossentropy where shape = [batch_size, d0, .. dN-1]

y_pred: The predicted values. shape = [batch_size, d0, .. dN]

Returns:

Loss values with the shape [batch_size, d0, .. dN-1].

classmethod from_config(config)#

Instantiates a Loss from its config (output of get_config()).

Args:

config: Output of get_config().

Returns:

A Loss instance.

get_config()#

Returns the config dictionary for a Loss instance.

__call__(x1, x2)[source]#

Geothermal physics loss