swarmrl.tasks.multi_tasking Module API Reference

Class for multi-tasking.

MultiTasking

Bases: Task

Class for handling multiple tasks.

Source code in swarmrl/tasks/multi_tasking.py

class MultiTasking(Task):
    """
    Class for handling multiple tasks.
    """

    def __init__(self, particle_type: int = 0, tasks: List[Task] = []):
        """
        Constructor for multi-tasking.
        """
        super().__init__(particle_type)
        self.tasks = tasks

    def initialize(self, colloids: List[Colloid]):
        """
        Initialize the observables as needed.

        Parameters
        ----------
        colloids : List[Colloid]
                List of colloids with which to initialize the observable.

        Returns
        -------
        Some of the observables passed to the constructor might need to be
        initialized with the positions of the colloids. This method does
        that.
        """
        for item in self.tasks:
            item.initialize(colloids)

    def __call__(self, colloids: List[Colloid]) -> np.ndarray:
        """
        Computes all observables and returns them in a concatenated list.

        Parameters
        ----------
        colloids : list of all colloids.

        Returns
        -------
        rewards : np.ndarray of shape (num_colloids, )
                Array of rewards for each colloid.
        """
        species_indices = self.get_colloid_indices(colloids)
        rewards = np.zeros(len(species_indices))
        for task in self.tasks:
            ts = task(colloids)
            rewards += ts

        return rewards

__call__(colloids)

Computes all observables and returns them in a concatenated list.

Parameters

colloids : list of all colloids.

Returns

rewards : np.ndarray of shape (num_colloids, ) Array of rewards for each colloid.

Source code in swarmrl/tasks/multi_tasking.py

def __call__(self, colloids: List[Colloid]) -> np.ndarray:
    """
    Computes all observables and returns them in a concatenated list.

    Parameters
    ----------
    colloids : list of all colloids.

    Returns
    -------
    rewards : np.ndarray of shape (num_colloids, )
            Array of rewards for each colloid.
    """
    species_indices = self.get_colloid_indices(colloids)
    rewards = np.zeros(len(species_indices))
    for task in self.tasks:
        ts = task(colloids)
        rewards += ts

    return rewards

__init__(particle_type=0, tasks=[])

Constructor for multi-tasking.

Source code in swarmrl/tasks/multi_tasking.py

def __init__(self, particle_type: int = 0, tasks: List[Task] = []):
    """
    Constructor for multi-tasking.
    """
    super().__init__(particle_type)
    self.tasks = tasks

initialize(colloids)

Initialize the observables as needed.

Parameters

colloids : List[Colloid] List of colloids with which to initialize the observable.

Returns

Some of the observables passed to the constructor might need to be initialized with the positions of the colloids. This method does that.

Source code in swarmrl/tasks/multi_tasking.py

def initialize(self, colloids: List[Colloid]):
    """
    Initialize the observables as needed.

    Parameters
    ----------
    colloids : List[Colloid]
            List of colloids with which to initialize the observable.

    Returns
    -------
    Some of the observables passed to the constructor might need to be
    initialized with the positions of the colloids. This method does
    that.
    """
    for item in self.tasks:
        item.initialize(colloids)