swarmrl.losses.loss Module API Reference

Module for the loss parent class.

Loss

Parent class for a SwarmRL loss model.

Source code in swarmrl/losses/loss.py

class Loss:
    """
    Parent class for a SwarmRL loss model.
    """

    def compute_loss(
        self,
        network: Network,
        episode_data: np.ndarray,
    ):
        """
        Compute loss on models.

        Parameters
        ----------
        network : Network
                Actor-critic network.
        episode_data : dict
                A dictionary of episode data.
        """
        raise NotImplementedError("Implemented in child class.")

compute_loss(network, episode_data)

Compute loss on models.

Parameters

network : Network Actor-critic network. episode_data : dict A dictionary of episode data.

Source code in swarmrl/losses/loss.py

def compute_loss(
    self,
    network: Network,
    episode_data: np.ndarray,
):
    """
    Compute loss on models.

    Parameters
    ----------
    network : Network
            Actor-critic network.
    episode_data : dict
            A dictionary of episode data.
    """
    raise NotImplementedError("Implemented in child class.")