Sensory Agent

SensoryAgent

Bases: Agent

Abstract base class for sensory agents.

This class provides a template for creating agents that can sense the environment.

Attributes:

Name	Type	Description
kwargs	dict	Additional arguments to pass to the recorder.

Source code in mbodied/agents/sense/sensory_agent.py

class SensoryAgent(Agent):
    """Abstract base class for sensory agents.

    This class provides a template for creating agents that can sense the environment.

    Attributes:
        kwargs (dict): Additional arguments to pass to the recorder.
    """

    def __init__(self, **kwargs):
        """Initialize the agent.

        Args:
            **kwargs: Additional arguments to pass to the recorder.
        """
        super().__init__(**kwargs)

    def act(self, **kwargs) -> SensorReading:
        """Abstract method to define the sensing mechanism of the agent.

        Args:
            **kwargs: Additional arguments to pass to the `sense` method.

        Returns:
            Sample: The sensory sample created by the agent.
        """
        raise NotImplementedError

    def sense(self, **kwargs) -> SensorReading:
        """Generate a SensorReading based on given parameters.

        Args:
            **kwargs: Arbitrary keyword arguments for sensory agent to sense on.

        Returns:
            SensorReading: A SensorReading object based on the provided arguments.
        """
        return self.act(**kwargs)

__init__(**kwargs)

Initialize the agent.

Parameters:

Name	Type	Description	Default
**kwargs		Additional arguments to pass to the recorder.	{}

Source code in mbodied/agents/sense/sensory_agent.py

def __init__(self, **kwargs):
    """Initialize the agent.

    Args:
        **kwargs: Additional arguments to pass to the recorder.
    """
    super().__init__(**kwargs)

act(**kwargs)

Abstract method to define the sensing mechanism of the agent.

Parameters:

Name	Type	Description	Default
**kwargs		Additional arguments to pass to the sense method.	{}

Returns:

Name	Type	Description
Sample	SensorReading	The sensory sample created by the agent.

Source code in mbodied/agents/sense/sensory_agent.py

def act(self, **kwargs) -> SensorReading:
    """Abstract method to define the sensing mechanism of the agent.

    Args:
        **kwargs: Additional arguments to pass to the `sense` method.

    Returns:
        Sample: The sensory sample created by the agent.
    """
    raise NotImplementedError

sense(**kwargs)

Generate a SensorReading based on given parameters.

Parameters:

Name	Type	Description	Default
**kwargs		Arbitrary keyword arguments for sensory agent to sense on.	{}

Returns:

Name	Type	Description
SensorReading	SensorReading	A SensorReading object based on the provided arguments.

Source code in mbodied/agents/sense/sensory_agent.py

def sense(self, **kwargs) -> SensorReading:
    """Generate a SensorReading based on given parameters.

    Args:
        **kwargs: Arbitrary keyword arguments for sensory agent to sense on.

    Returns:
        SensorReading: A SensorReading object based on the provided arguments.
    """
    return self.act(**kwargs)