"""This module defines the base classes for worlds within which multiple agents engage in situated negotiations
The `Agent` class encapsulates the managing entity that creates negotiators to engage in negotiations within a world
`Simulation` in order to maximize its own total utility.
Remarks:
--------
- When immediate_negotiations is true, negotiations start in the same step they are registered in (they may also end
in that step) and `negotiation_speed_multiple` steps of it are conducted. That entails that requesting a
negotiation may result in new contracts in the same time-step only of `immediate_negotiations` is true.
Simulation steps:
-----------------
It is possible to control the order of the simulation steps differently using the operations paramter to the world
constructor. this is the default order
#. prepare custom stats (call `_pre_step_stats`)
#. step all existing negotiations `negotiation_speed_multiple` times handling any failed negotiations and creating
contracts for any resulting agreements
#. Allow custom simulation (call `simulation_step` ) with stage 0
#. run all `Entity` objects registered (i.e. all agents) in the predefined `simulation_order`.
#. sign contracts that are to be signed at this step calling `on_contracts_finalized` / `on_contract_signed` as
needed
#. execute contracts that are executable at this time-step handling any breaches
#. allow custom simulation steps to run (call `simulation_step` ) with stage 1
#. remove any negotiations that are completed!
#. update basic stats
#. update custom stats (call `_post_step_stats`)
Monitoring a simulation:
-----------------------
You can monitor a running simulation using a `WorldMonitor` or `StatsMonitor` object. The former monitors events in the
world while the later monitors the statistics of the simulation.
This is a list of some of the events that can be monitored by `WorldMonitor` . World designers can add new events
either by announcing them using `announce` or as a side-effect of logging them using any of the log functions.
================================= ===============================================================================
Event Data
================================= ===============================================================================
extra-step none
entity-exception exception: `Exception`
contract-exception exception: `Exception`
agent-joined agent: `Agent`
negotiation-request caller: `Agent` , partners: `List` [ `Agent` ], issues: `List` [ `Issue` ]
, mechanism_name: `str` , annotation: `Dict` [ `str`, `Any` ], req_id: `str`
negotiation-request-immediate caller: `Agent` , partners: `List` [ `Agent` ], issues: `List` [ `Issue` ]
, mechanism_name: `str` , annotation: `Dict` [ `str`, `Any` ]
negotiations-request-immediate caller: `Agent` , partners: `List` [ `Agent` ], issues: `List` [ `Issue` ]
, mechanism_name: `str` , annotation: `Dict` [ `str`, `Any` ]
, all_or_none: bool
negotiation-success mechanism: `Mechanism` , contract: `Contract` , partners: `List` [ `Agent` ]
negotiation-failure mechanism: `Mechanism` , partners: `List` [ `Agent` ]
agent-exception method: `str` , exception: `Exception`
executing-contract contract: `Contract`
mechanism-not-created exception: `Exception`
negotiation-request-rejected caller: `Agent` , partners: `List` [ `Agent` ] , req_id: `str`
, rejectors: `List` [ `Agent` ] , annotation: `Dict` [ `str`, `Any` ]
negotiation-request-accepted caller: `Agent` , partners: `List` [ `Agent` ] , req_id: `str`
, mechanism: `Mechanism` , annotation: `Dict` [ `str`, `Any` ]
================================= ===============================================================================
"""
import copy
import json
import logging
import math
import os
import random
import re
import sys
import time
import traceback
import uuid
from abc import ABC, abstractmethod
from collections import defaultdict, namedtuple
from dataclasses import dataclass, field
from enum import Enum
from pathlib import Path
from typing import Dict
from typing import (
Optional,
List,
Any,
Tuple,
Callable,
Union,
Iterable,
Set,
Iterator,
Collection,
)
import matplotlib.pyplot as plt
import networkx as nx
import numpy as np
import pandas as pd
import yaml
from matplotlib.axis import Axis
from negmas import UtilityFunction, Outcome
from negmas.checkpoints import CheckpointMixin
from negmas.common import AgentMechanismInterface, MechanismState
from negmas.common import NamedObject
from negmas.events import Event, EventSource, EventSink, Notifier
from negmas.helpers import (
ConfigReader,
instantiate,
get_class,
unique_name,
snake_case,
dump,
create_loggers,
add_records,
humanize_time,
)
from negmas.java import to_flat_dict, to_dict
from negmas.mechanisms import Mechanism
from negmas.negotiators import Negotiator
from negmas.outcomes import OutcomeType, Issue, outcome_as_dict
__all__ = [
"Operations",
"Action", # An action that an `Agent` can execute in the `World`.
"Contract", # A agreement definition which encapsulates an agreement with partners and extra information
"Breach", # A breach in executing a contract
"BreachProcessing",
"Agent", # Negotiator capable of engaging in multiple negotiations
"BulletinBoard",
"World",
"Entity",
"AgentWorldInterface", # the interface though which an agent can interact with the world
"NegotiationInfo",
"RenegotiationRequest",
"StatsMonitor",
"WorldMonitor",
"save_stats",
"SimpleWorld",
"NoContractExecutionMixin",
"TimeInAgreementMixin",
"NoResponsesMixin",
"EDGE_TYPES",
"EDGE_COLORS",
"DEFAULT_EDGE_TYPES",
"show_edge_colors",
]
PROTOCOL_CLASS_NAME_FIELD = "__mechanism_class_name"
EDGE_TYPES = [
"negotiation-requests-rejected",
"negotiation-requests-accepted",
"negotiations-rejected",
"negotiations-started",
"negotiations-failed",
"negotiations-succeeded",
"contracts-concluded",
"contracts-cancelled",
"contracts-signed",
"contracts-nullified",
"contracts-erred",
"contracts-breached",
"contracts-executed",
]
"""All types of graphs that can be drawn for a world"""
DEFAULT_EDGE_TYPES = [
"negotiation-requests-rejected",
"negotiation-requests-accepted",
"negotiations-rejected",
"negotiations-started",
"negotiations-failed",
"contracts-concluded",
"contracts-cancelled",
"contracts-signed",
"contracts-breached",
"contracts-executed",
]
"""Default set of edge types to show by defaults in draw"""
EDGE_COLORS = {
"negotiation-requests-rejected": "silver",
"negotiation-requests-accepted": "gray",
"negotiations-rejected": "tab:pink",
"negotiations-started": "tab:blue",
"negotiations-failed": "tab:red",
"negotiations-succeeded": "tab:green",
"contracts-concluded": "tab:green",
"contracts-cancelled": "fuchsia",
"contracts-nullified": "yellow",
"contracts-erred": "darksalmon",
"contracts-signed": "blue",
"contracts-breached": "indigo",
"contracts-executed": "black",
}
def show_edge_colors():
"""Plots the edge colors used with their meaning"""
colors = {}
for t in EDGE_TYPES:
colors[t] = EDGE_COLORS[t]
# Sort colors by hue, saturation, value and name.
sorted_colors = colors.values()
sorted_names = colors.keys()
n = len(sorted_names)
ncols = 2
nrows = n // ncols + 1
fig, ax = plt.subplots(figsize=(8, 5))
# Get height and width
X, Y = fig.get_dpi() * fig.get_size_inches()
h = Y / (nrows + 1)
w = X / ncols
for i, name in enumerate(sorted_names):
col = i % ncols
row = i // ncols
y = Y - (row * h) - h
xi_line = w * (col + 0.05)
xf_line = w * (col + 0.25)
xi_text = w * (col + 0.3)
ax.text(
xi_text,
y,
name,
fontsize=(h * 0.3),
horizontalalignment="left",
verticalalignment="center",
)
ax.hlines(
y + h * 0.1, xi_line, xf_line, color=colors[name], linewidth=(h * 0.6)
)
ax.set_xlim(0, X)
ax.set_ylim(0, Y)
ax.set_axis_off()
fig.subplots_adjust(left=0, right=1, top=1, bottom=0, hspace=0, wspace=0)
plt.show()
try:
# disable a warning in yaml 1b1 version
yaml.warnings({"YAMLLoadWarning": False})
except:
pass
@dataclass
class Action:
"""An action that an `Agent` can execute in a `World` through the `Simulator`."""
type: str
"""Action name."""
params: dict
"""Any extra parameters to be passed for the action."""
def __str__(self):
return f"{self.type}: {self.params}"
@dataclass
class Contract(OutcomeType):
"""A agreement definition which encapsulates an agreement with partners and extra information"""
partners: List[str] = field(default_factory=list)
"""The partners"""
agreement: OutcomeType = None
"""The actual agreement of the negotiation in the form of an `Outcome` in the `Issue` space defined by `issues`"""
annotation: Dict[str, Any] = field(default_factory=dict)
"""Misc. information to be kept with the agreement."""
issues: List[Issue] = field(default_factory=list)
"""Issues of the negotiations from which this agreement was concluded. It may be empty"""
signed_at: int = -1
"""The time-step at which the contract was signed"""
executed_at: int = -1
"""The time-step at which the contract was executed/breached"""
concluded_at: int = -1
"""The time-step at which the contract was concluded (but it is still not binding until signed)"""
nullified_at: int = -1
"""The time-step at which the contract was nullified after being signed. That can happen if a partner declares
bankruptcy"""
to_be_signed_at: int = -1
"""The time-step at which the contract should be signed"""
signatures: Dict[str, Optional[str]] = field(default_factory=dict)
"""A mapping from each agent to its signature"""
mechanism_state: Optional[MechanismState] = None
"""The mechanism state at the contract conclusion"""
id: str = field(default_factory=lambda: str(uuid.uuid4()), init=True)
"""Object name"""
def __str__(self):
return (
f'{", ".join(self.partners)} agreed on {str(self.agreement)} [id {self.id}]'
)
def __hash__(self):
"""The hash depends only on the name"""
return self.id.__hash__()
class Java:
implements = ["jnegmas.situated.Contract"]
@dataclass
class Breach:
contract: Contract
"""The agreement being breached"""
perpetrator: str
"""ID of the agent committing the breach"""
type: str
"""The type of the breach. Can be one of: `refusal`, `product`, `money`, `penalty`."""
victims: List[str] = field(default_factory=list)
"""Specific victims of the breach. If not given all partners in the agreement (except perpetrator) are considered
victims"""
level: float = 1.0
"""Breach level defaulting to full breach (a number between 0 and 1)"""
step: int = -1
"""The simulation step at which the breach occurred"""
id: str = field(default_factory=lambda: str(uuid.uuid4()), init=True)
"""Object name"""
def __hash__(self):
"""The hash depends only on the name"""
return self.id.__hash__()
def __str__(self):
return f"Breach ({self.level} {self.type}) by {self.perpetrator} on {self.contract.id} at {self.step}"
def as_dict(self):
return {
"contract": str(self.contract),
"contract_id": self.contract.id,
"type": self.type,
"level": self.level,
"id": self.id,
"perpetrator": self.perpetrator,
"perpetrator_type": self.perpetrator.__class__.__name__,
"victims": [_ for _ in self.victims],
"step": self.step,
"resolved": None,
}
class Java:
implements = ["jnegmas.situated.Breach"]
class BreachProcessing(Enum):
"""The way breaches are to be handled"""
NONE = 0
"""The breach should always be reported in the breach list and no re-negotiation is allowed."""
VICTIM_THEN_PERPETRATOR = 1
"""The victim is asked to set the re-negotiation agenda then the perpetrator."""
META_NEGOTIATION = 2
"""A meta negotiation is instantiated between victim and perpetrator to set re-negotiation issues."""
@dataclass
class RenegotiationRequest:
"""A request for renegotiation.
The issues can be any or all of the following:
immediate_delivery: int
immediate_unit_price: float
later_quantity: int
later_unit_price: int
later_penalty: float
later_time: int
"""
publisher: "Agent"
issues: List[Issue]
annotation: Dict[str, Any] = field(default_factory=dict)
class Java:
implements = ["jnegmas.situated.RenegotiationRequest"]
class Entity(NamedObject):
"""Defines an entity that is a part of the world but does not participate in the simulation"""
def __init__(self, name: str = None, type_postfix: str = ""):
super().__init__(name=name)
self._initialized = False
self.__type_postfix = type_postfix
self.__current_step = 0
@classmethod
def _type_name(cls):
return snake_case(cls.__name__)
@property
def type_name(self):
"""Returns the name of the type of this entity"""
return self.__class__._type_name() + self.__type_postfix
@property
def short_type_name(self):
"""Returns a short name of the type of this entity"""
long_name = self.type_name
name = (
long_name.split(".")[-1]
.lower()
.replace("factory_manager", "")
.replace("manager", "")
)
name = (
name.replace("factory", "")
.replace("agent", "")
.replace("miner", "")
.replace("consumer", "")
)
if long_name.startswith("jnegmas"):
name = f"j-{name}"
name = name.strip("_")
return name
def init_(self):
"""Called to initialize the agent **after** the world is initialized. the AWI is accessible at this point."""
self._initialized = True
self.__current_step = 0
self.init()
def step_(self):
"""Called at every time-step. This function is called directly by the world."""
if not self._initialized:
self.init_()
self.step()
self.__current_step += 1
def init(self):
"""Override this method to modify initialization logic"""
def step(self):
"""Override this method to modify stepping logic"""
class BulletinBoard(Entity, EventSource, ConfigReader):
"""The bulletin-board which carries all public information. It consists of sections each with a dictionary of records.
"""
# def __getstate__(self):
# return self.name, self._data
#
# def __setstate__(self, state):
# name, self._data = state
# super().__init__(name=name)
def __init__(self, name: str = None):
"""
Constructor
Args:
name: BulletinBoard name
"""
super().__init__(name=name)
self._data: Dict[str, Dict[str, Any]] = {}
def add_section(self, name: str) -> None:
"""
Adds a section to the bulletin Board
Args:
name: Section name
Returns:
"""
self._data[name] = {}
def query(
self, section: Optional[Union[str, List[str]]], query: Any, query_keys=False
) -> Optional[Dict[str, Any]]:
"""
Returns all records in the given section/sections of the bulletin-board that satisfy the query
Args:
section: Either a section name, a list of sections or None specifying ALL public sections (see remarks)
query: The query which is USUALLY a dict with conditions on it when querying values and a RegExp when
querying keys
query_keys: Whether the query is to be applied to the keys or values.
Returns:
- A dictionary with key:value pairs giving all records that satisfied the given requirements.
Remarks:
- A public section is a section with a name that does not start with an underscore
- If a set of sections is given, and two records in different sections had the same key, only one of them
will be returned
- Key queries use regular expressions and match from the beginning using the standard re.match function
"""
if section is None:
return self.query(
section=[_ for _ in self._data.keys() if not _.startswith("_")],
query=query,
query_keys=query_keys,
)
if isinstance(section, Iterable) and not isinstance(section, str):
results = [
self.query(section=_, query=query, query_keys=query_keys)
for _ in section
]
if len(results) == 0:
return dict()
final: Dict[str, Any] = {}
for _ in results:
final.update(_)
return final
sec = self._data.get(section, None)
if sec is None:
return {}
if query is None:
return copy.deepcopy(sec)
if query_keys:
return {k: v for k, v in sec.items() if re.match(str(query), k) is not None}
return {k: v for k, v in sec.items() if BulletinBoard.satisfies(v, query)}
@classmethod
def satisfies(cls, value: Any, query: Any) -> bool:
method = getattr(value, "satisfies", None)
if method is not None and isinstance(method, Callable):
return method(query)
if isinstance(value, dict) and isinstance(query, dict):
for k, v in query.items():
if value.get(k, None) != v:
return False
else:
raise ValueError(
f"Cannot check satisfaction of {type(query)} against value {type(value)}"
)
return True
def read(self, section: str, key: str) -> Any:
"""
Reads the value associated with given key
Args:
section: section name
key: key
Returns:
Content of that key in the bulletin-board
"""
sec = self._data.get(section, None)
if sec is None:
return None
return sec.get(key, None)
def record(self, section: str, value: Any, key: Optional[str] = None) -> None:
"""
Records data in the given section of the bulletin-board
Args:
section: section name (can contain subsections separated by '/')
key: The key
value: The value
"""
if key is None:
try:
skey = str(hash(value))
except:
skey = str(uuid.uuid4())
else:
skey = key
self._data[section][skey] = value
self.announce(
Event("new_record", data={"section": section, "key": skey, "value": value})
)
def remove(
self,
section: Optional[Union[List[str], str]],
*,
query: Optional[Any] = None,
key: str = None,
query_keys: bool = False,
value: Any = None,
) -> bool:
"""
Removes a value or a set of values from the bulletin Board
Args:
section: The section
query: the query to use to select what to remove
key: the key to remove (no need to give a full query)
query_keys: Whether to apply the query (if given) to keys or values
value: Value to be removed
Returns:
bool: Success of failure
"""
if section is None:
return self.remove(
section=[_ for _ in self._data.keys() if not _.startswith("_")],
query=query,
key=key,
query_keys=query_keys,
)
if isinstance(section, Iterable) and not isinstance(section, str):
return all(
self.remove(section=_, query=query, key=key, query_keys=query_keys)
for _ in section
)
sec = self._data.get(section, None)
if sec is None:
return False
if value is not None:
for k, v in sec.items():
if v == value:
key = k
break
if key is not None:
try:
self.announce(
Event(
"will_remove_record",
data={"section": sec, "key": key, "value": sec[key]},
)
)
sec.pop(key, None)
return True
except KeyError:
return False
if query is None:
return False
if query_keys:
keys = [k for k, v in sec.items() if re.match(str(query), k) is not None]
else:
keys = [k for k, v in sec.items() if v.satisfies(query)]
if len(keys) == 0:
return False
for k in keys:
self.announce(
Event(
"will_remove_record",
data={"section": sec, "key": k, "value": sec[k]},
)
)
sec.pop(k, None)
return True
@property
def data(self):
"""This property is intended for use only by the world manager. No other agent is allowed to use it"""
return self._data
def safe_min(a, b):
"""Returns min(a, b) assuming None is less than anything."""
if a is None:
return b
if b is None:
return a
return min(a, b)
@dataclass
class NegotiationInfo:
"""Saves information about a negotiation"""
mechanism: Optional[Mechanism]
partners: List["Agent"]
annotation: Dict[str, Any]
issues: List["Issue"]
requested_at: int
rejectors: Optional[List["Agent"]] = None
class MechanismFactory:
"""A mechanism creation class. It can invite agents to join a mechanism and then run it."""
def __init__(
self,
world: "World",
mechanism_name: str,
mechanism_params: Dict[str, Any],
issues: List["Issue"],
req_id: str,
caller: "Agent",
partners: List["Agent"],
roles: Optional[List[str]] = None,
annotation: Dict[str, Any] = None,
neg_n_steps: int = None,
neg_time_limit: int = None,
neg_step_time_limit=None,
allow_self_negotiation=False,
log_ufuns_file=None,
):
self.mechanism_name, self.mechanism_params = mechanism_name, mechanism_params
self.caller = caller
self.partners = partners
self.roles = roles
self.annotation = annotation
self.neg_n_steps = neg_n_steps
self.neg_time_limit = neg_time_limit
self.neg_step_time_limit = neg_step_time_limit
self.world = world
self.req_id = req_id
self.issues = issues
self.mechanism = None
self.allow_self_negotiation = allow_self_negotiation
self.log_ufuns_file = log_ufuns_file
def _create_negotiation_session(
self,
mechanism: Mechanism,
responses: Iterator[Tuple[Negotiator, str]],
partners: List["Agent"],
) -> Mechanism:
if self.neg_n_steps is not None:
mechanism.ami.n_steps = self.neg_n_steps
if self.neg_time_limit is not None:
mechanism.ami.time_limit = self.neg_time_limit
if self.neg_step_time_limit is not None:
mechanism.ami.step_time_limit = self.neg_step_time_limit
for partner in partners:
mechanism.register_listener(event_type="negotiation_end", listener=partner)
ufun = []
if self.log_ufuns_file is not None:
for outcome in mechanism.discrete_outcomes(astype=dict):
record = {"mechanism_id": mechanism.id, "outcome": outcome}
ufun.append(record)
for i, (partner_, (_negotiator, _role)) in enumerate(zip(partners, responses)):
if self.log_ufuns_file is not None:
for record in ufun:
record[f"agent{i}"] = partner_.name
# record[f"agent_type{i}"] = partner_.type_name
# record[f"negotiator{i}"] = _negotiator.name
record[f"reserved{i}"] = _negotiator.reserved_value
if hasattr(_negotiator, "utility_function"):
record[f"u{i}"] = _negotiator.utility_function(
record["outcome"]
)
else:
record[f"u{i}"] = None
_negotiator.owner = partner_
mechanism.add(negotiator=_negotiator, role=_role)
if self.log_ufuns_file is not None:
for record in ufun:
outcome = record.pop("outcome", {})
record.update(outcome)
add_records(self.log_ufuns_file, ufun)
return mechanism
def _start_negotiation(
self,
mechanism_name,
mechanism_params,
roles,
caller,
partners,
annotation,
issues,
req_id,
) -> Optional[NegotiationInfo]:
"""Tries to prepare the negotiation to start by asking everyone to join"""
mechanisms = self.world.mechanisms
if (
(not self.allow_self_negotiation)
and (len(set(_.id if _ is not None else "" for _ in partners)) < 2)
and len(partners) > 1
):
return None
if issues is None:
caller.on_neg_request_rejected_(req_id=req_id, by=None)
return None
if (
mechanisms is not None
and mechanism_name is not None
and mechanism_name not in mechanisms.keys()
):
caller.on_neg_request_rejected_(req_id=req_id, by=None)
return None
if mechanisms is not None and mechanism_name is not None:
mechanism_name = mechanisms[mechanism_name].pop(
PROTOCOL_CLASS_NAME_FIELD, mechanism_name
)
if mechanism_params is None:
mechanism_params = {}
if mechanisms and mechanisms.get(mechanism_name, None) is not None:
mechanism_params.update(mechanisms[mechanism_name])
# mechanism_params = {k: v for k, v in mechanism_params.items() if k != PROTOCOL_CLASS_NAME_FIELD}
mechanism_params["n_steps"] = self.neg_n_steps
mechanism_params["time_limit"] = self.neg_time_limit
mechanism_params["step_time_limit"] = self.neg_step_time_limit
mechanism_params["issues"] = issues
mechanism_params["annotation"] = annotation
mechanism_params["name"] = "-".join(_.id for _ in partners)
if mechanism_name is None:
if mechanisms is not None and len(mechanisms) == 1:
mechanism_name = list(mechanisms.keys())[0]
else:
mechanism_name = "negmas.sao.SAOMechanism"
if mechanisms and mechanisms.get(mechanism_name, None) is not None:
mechanism_params.update(mechanisms[mechanism_name])
try:
mechanism = instantiate(class_name=mechanism_name, **mechanism_params)
except Exception as e:
mechanism = None
self.world.logerror(
f"Failed to create {mechanism_name} with params {mechanism_params}",
Event("mechanism-not-created", dict(exception=e)),
)
self.mechanism = mechanism
if mechanism is None:
return None
if roles is None:
roles = [None] * len(partners)
partner_names = [p.id for p in partners]
responses = [
partner.respond_to_negotiation_request_(
initiator=caller.id,
partners=partner_names,
issues=issues,
annotation=annotation,
role=role,
mechanism=mechanism.ami,
req_id=req_id if partner == caller else None,
)
for role, partner in zip(roles, partners)
]
if not all(responses):
rejectors = [p for p, response in zip(partners, responses) if not response]
rej = [_.id for _ in rejectors]
caller.on_neg_request_rejected_(req_id=req_id, by=rej)
for partner, response in zip(partners, responses):
if partner.id != caller.id and response:
partner.on_neg_request_rejected_(req_id=None, by=rej)
self.world.loginfo(
f"{caller.name} request was rejected by {[_.name for _ in rejectors]}",
Event(
"negotiation-request-rejected",
dict(
req_id=req_id,
caller=caller,
partners=partners,
rejectors=rejectors,
annotation=annotation,
),
),
)
return NegotiationInfo(
mechanism=None,
partners=partners,
annotation=annotation,
issues=issues,
rejectors=rejectors,
requested_at=self.world.current_step,
)
mechanism = self._create_negotiation_session(
mechanism=mechanism, responses=zip(responses, roles), partners=partners
)
neg_info = NegotiationInfo(
mechanism=mechanism,
partners=partners,
annotation=annotation,
issues=issues,
requested_at=self.world.current_step,
)
caller.on_neg_request_accepted_(req_id=req_id, mechanism=mechanism.ami)
for partner, response in zip(partners, responses):
if partner.id != caller.id:
partner.on_neg_request_accepted_(req_id=None, mechanism=mechanism)
self.world.loginfo(
f"{caller.name} request was accepted",
Event(
"negotiation-request-accepted",
dict(
req_id=req_id,
caller=caller,
partners=partners,
mechanism=mechanism,
annotation=annotation,
),
),
)
return neg_info
def init(self) -> Optional[NegotiationInfo]:
return self._start_negotiation(
mechanism_name=self.mechanism_name,
mechanism_params=self.mechanism_params,
roles=self.roles,
caller=self.caller,
partners=self.partners,
annotation=self.annotation,
issues=self.issues,
req_id=self.req_id,
)
class AgentWorldInterface:
"""Agent World Interface class"""
# def __getstate__(self):
# return self._world, self.agent.id
#
# def __setstate__(self, state):
# self._world, agent_id = state
# self.agent = self._world.agents[agent_id]
def __init__(self, world: "World", agent: "Agent"):
self._world, self.agent = world, agent
def execute(
self, action: Action, callback: Callable[[Action, bool], Any] = None
) -> bool:
"""Executes an action in the world simulation"""
return self._world.execute_action(
action=action, agent=self.agent, callback=callback
)
@property
def state(self) -> Any:
"""Returns the private state of the agent in that world"""
return self._world.get_private_state(self.agent)
@property
def relative_time(self) -> float:
"""Relative time of the simulation going from 0 to 1"""
return self._world.relative_time
@property
def current_step(self) -> int:
"""Current simulation step"""
return self._world.current_step
@property
def n_steps(self) -> int:
"""Number of steps in a simulation"""
return self._world.n_steps
@property
def default_signing_delay(self) -> int:
return self._world.default_signing_delay if not self._world.force_signing else 0
def run_negotiation(
self,
issues: Collection[Issue],
partners: Collection["Agent"],
negotiator: Negotiator,
ufun: UtilityFunction = None,
caller_role: str = None,
roles: Collection[str] = None,
annotation: Optional[Dict[str, Any]] = None,
mechanism_name: str = None,
mechanism_params: Dict[str, Any] = None,
) -> Optional[Tuple[Contract, AgentMechanismInterface]]:
"""
Runs a negotiation until completion
Args:
partners: The list of partners that the agent wants to negotiate with. Roles will be determined by these agents.
negotiator: The negotiator to be used in the negotiation
ufun: The utility function. Only needed if the negotiator does not already know it
caller_role: The role of the caller in the negotiation
issues: Negotiation issues
annotation: Extra information to be passed to the `partners` when asking them to join the negotiation
partners: A list of partners to participate in the negotiation
roles: The roles of different partners. If None then each role for each partner will be None
mechanism_name: Name of the mechanism to use. It must be one of the mechanism_names that are supported by the
`World` or None which means that the `World` should select the mechanism. If None, then `roles` and `my_role`
must also be None
mechanism_params: A dict of parameters used to initialize the mechanism object
Returns:
A Tuple of a contract and the ami of the mechanism used to get it in case of success. None otherwise
"""
return self._world.run_negotiation(
caller=self.agent,
issues=issues,
partners=partners,
annotation=annotation,
roles=roles,
mechanism_name=mechanism_name,
mechanism_params=mechanism_params,
negotiator=negotiator,
ufun=ufun,
caller_role=caller_role,
)
def run_negotiations(
self,
issues: Union[List[Issue], List[List[Issue]]],
partners: List[List["Agent"]],
negotiators: List[Negotiator],
ufuns: List[UtilityFunction] = None,
caller_roles: List[str] = None,
roles: Optional[List[Optional[List[str]]]] = None,
annotations: Optional[List[Optional[Dict[str, Any]]]] = None,
mechanism_names: Optional[Union[str, List[str]]] = None,
mechanism_params: Optional[Union[Dict[str, Any], List[Dict[str, Any]]]] = None,
all_or_none: bool = False,
) -> List[Tuple[Contract, AgentMechanismInterface]]:
"""
Requests to run a set of negotiations simultaneously. Returns after all negotiations are run to completion
Args:
partners: The list of partners that the agent wants to negotiate with. Roles will be determined by these agents.
issues: Negotiation issues
negotiators: The negotiator to be used in the negotiation
ufuns: The utility function. Only needed if the negotiator does not already know it
caller_roles: The role of the caller in the negotiation
annotations: Extra information to be passed to the `partners` when asking them to join the negotiation
partners: A list of partners to participate in the negotiation
roles: The roles of different partners. If None then each role for each partner will be None
mechanism_names: Name of the mechanism to use. It must be one of the mechanism_names that are supported by the
`World` or None which means that the `World` should select the mechanism. If None, then `roles` and `my_role`
must also be None
mechanism_params: A dict of parameters used to initialize the mechanism object
all_or_none: If true, either no negotiations will be started execpt if all partners accepted
Returns:
A list of tuples each with two values: contract (None for failure) and ami (The mechanism info [None if the
corresponding partner refused to negotiation])
"""
return self._world.run_negotiations(
caller=self.agent,
issues=issues,
roles=roles,
annotations=annotations,
mechanism_names=mechanism_names,
mechanism_params=mechanism_params,
partners=partners,
negotiators=negotiators,
caller_roles=caller_roles,
ufuns=ufuns,
all_or_none=all_or_none,
)
def request_negotiation_about(
self,
issues: List[Issue],
partners: List[str],
req_id: str,
roles: List[str] = None,
annotation: Optional[Dict[str, Any]] = None,
mechanism_name: str = None,
mechanism_params: Dict[str, Any] = None,
) -> bool:
"""
Requests to start a negotiation with some other agents
Args:
req_id:
issues: Negotiation issues
annotation: Extra information to be passed to the `partners` when asking them to join the negotiation
partners: A list of partners to participate in the negotiation
roles: The roles of different partners. If None then each role for each partner will be None
mechanism_name: Name of the mechanism to use. It must be one of the mechanism_names that are supported by the
`World` or None which means that the `World` should select the mechanism. If None, then `roles` and `my_role`
must also be None
mechanism_params: A dict of parameters used to initialize the mechanism object
Returns:
List["Agent"] the list of partners who rejected the negotiation if any. If None then the negotiation was
accepted. If empty then the negotiation was not started from the world manager
Remarks:
- The function will create a request ID that will be used in callbacks `on_neg_request_accepted` and
`on_neg_request_rejected`
"""
partner_agents = [self._world.agents[_] for _ in partners]
return self._world.request_negotiation_about(
req_id=req_id,
caller=self.agent,
partners=partner_agents,
roles=roles,
issues=issues,
annotation=annotation,
mechanism_name=mechanism_name,
mechanism_params=mechanism_params,
)
def loginfo(self, msg: str) -> None:
"""
Logs an INFO message
Args:
msg: The message to log
Returns:
"""
self._world.loginfo(msg)
def logwarning(self, msg: str) -> None:
"""
Logs a WARNING message
Args:
msg: The message to log
Returns:
"""
self._world.logwarning(msg)
def logdebug(self, msg: str) -> None:
"""
Logs a WARNING message
Args:
msg: The message to log
Returns:
"""
self._world.logdebug(msg)
def logerror(self, msg: str) -> None:
"""
Logs a WARNING message
Args:
msg: The message to log
Returns:
"""
self._world.logerror(msg)
def loginfo_agent(self, msg: str) -> None:
"""
Logs an INFO message to the agent's log
Args:
msg: The message to log
Returns:
"""
self._world.loginfo_agent(self.agent.id, msg)
def logwarning_agent(self, msg: str) -> None:
"""
Logs a WARNING message to the agent's log
Args:
msg: The message to log
Returns:
"""
self._world.logwarning_agent(self.agent.id, msg)
def logdebug_agent(self, msg: str) -> None:
"""
Logs a WARNING message to the agent's log
Args:
msg: The message to log
Returns:
"""
self._world.logdebug_agent(self.agent.id, msg)
def logerror_agent(self, msg: str) -> None:
"""
Logs a WARNING message to the agent's log
Args:
msg: The message to log
Returns:
"""
self._world.logerror_agent(self.agent.id, msg)
def bb_query(
self, section: Optional[Union[str, List[str]]], query: Any, query_keys=False
) -> Optional[Dict[str, Any]]:
"""
Returns all records in the given section/sections of the bulletin-board that satisfy the query
Args:
section: Either a section name, a list of sections or None specifying ALL public sections (see remarks)
query: The query which is USUALLY a dict with conditions on it when querying values and a RegExp when
querying keys
query_keys: Whether the query is to be applied to the keys or values.
Returns:
- A dictionary with key:value pairs giving all records that satisfied the given requirements.
Remarks:
- A public section is a section with a name that does not start with an underscore
- If a set of sections is given, and two records in different sections had the same key, only one of them
will be returned
- Key queries use regular expressions and match from the beginning using the standard re.match function
"""
return self._world.bulletin_board.query(
section=section, query=query, query_keys=query_keys
)
def bb_read(self, section: str, key: str) -> Optional[Any]:
"""
Reads the value associated with given key from the bulletin board
Args:
section: section name
key: key
Returns:
Content of that key in the bulletin-board
"""
return self._world.bulletin_board.read(section=section, key=key)
def bb_record(self, section: str, value: Any, key: Optional[str] = None) -> None:
"""
Records data in the given section of the bulletin board
Args:
section: section name (can contain subsections separated by '/')
key: The key
value: The value
"""
return self._world.bulletin_board.record(section=section, value=value, key=key)
def bb_remove(
self,
section: Optional[Union[List[str], str]],
*,
query: Optional[Any] = None,
key: str = None,
query_keys: bool = False,
value: Any = None,
) -> bool:
"""
Removes a value or a set of values from the bulletin Board
Args:
section: The section
query: the query to use to select what to remove
key: the key to remove (no need to give a full query)
query_keys: Whether to apply the query (if given) to keys or values
value: Value to be removed
Returns:
bool: Success of failure
"""
return self._world.bulletin_board.remove(
section=section, query=query, key=key, query_keys=query_keys, value=value
)
@property
def settings(self):
return self._world.bulletin_board.data.get("settings", dict())
class Java:
implements = ["jnegmas.situated.AgentWorldInterface"]
def _path(path) -> Path:
"""Creates an absolute path from given path which can be a string"""
if isinstance(path, str):
if path.startswith("~"):
path = Path.home() / ("/".join(path.split("/")[1:]))
return Path(path).absolute()
class StatsMonitor(Entity):
"""A monitor object capable of receiving stats of a world"""
def init(self, stats: Dict[str, Any], world_name: str):
"""Called to initialize the monitor before running first step"""
def step(self, stats: Dict[str, Any], world_name: str):
"""Called at the END of every simulation step"""
class WorldMonitor(Entity):
"""A monitor object capable of monitoring a world. It has read/write access to the world"""
def init(self, world: "World"):
"""Called to initialize the monitor before running first step"""
def step(self, world: "World"):
"""Called at the END of every simulation step"""
RunningNegotiationInfo = namedtuple(
"RunningNegotiationInfo",
["negotiator", "annotation", "uuid", "extra", "my_request"],
)
"""Keeps track of running negotiations for an agent"""
NegotiationRequestInfo = namedtuple(
"NegotiationRequestInfo",
["partners", "issues", "annotation", "uuid", "negotiator", "requested", "extra"],
)
"""Keeps track to negotiation requests that an agent sent"""
class Agent(Entity, EventSink, ConfigReader, Notifier, ABC):
"""Base class for all agents that can run within a `World` and engage in situated negotiations"""
# def __getstate__(self):
# return self.name, self.awi
#
# def __setstate__(self, state):
# name, awi = state
# super().__init__(name=name)
# self._awi = awi
def __init__(self, name: str = None, type_postfix: str = ""):
super().__init__(name=name, type_postfix=type_postfix)
self._running_negotiations: Dict[str, RunningNegotiationInfo] = {}
self._requested_negotiations: Dict[str, NegotiationRequestInfo] = {}
self._accepted_requests: Dict[str, NegotiationRequestInfo] = {}
self.contracts: List[Contract] = []
self._unsigned_contracts: Set[Contract] = set()
self._awi: AgentWorldInterface = None
@property
def initialized(self) -> bool:
"""Was the agent initialized (i.e. was init_() called)"""
return self._initialized
@property
def unsigned_contracts(self) -> List[Contract]:
"""
All contracts that are not yet signed.
"""
return list(self._unsigned_contracts)
@property
def requested_negotiations(self) -> List[NegotiationRequestInfo]:
"""The negotiations currently requested by the agent.
Returns:
A list of negotiation request information objects (`NegotiationRequestInfo`)
"""
return list(self._requested_negotiations.values())
@property
def accepted_negotiation_requests(self) -> List[NegotiationInfo]:
"""A list of negotiation requests sent to this agent that are already accepted by it.
Remarks:
- These negotiations did not start yet as they are still not accepted by all partners.
Once that happens, they will be moved to `running_negotiations`
"""
return list(self._accepted_requests.values())
@property
def negotiation_requests(self) -> List[NegotiationInfo]:
"""A list of the negotiation requests sent by this agent that are not yet accepted or rejected.
Remarks:
- These negotiations did not start yet as they are still not accepted by all partners.
Once that happens, they will be moved to `running_negotiations`
"""
return list(self._requested_negotiations.values())
@property
def running_negotiations(self) -> List[RunningNegotiationInfo]:
"""The negotiations currently requested by the agent.
Returns:
A list of negotiation information objects (`RunningNegotiationInfo`)
"""
return list(self._running_negotiations.values())
@property
def awi(self) -> AgentWorldInterface:
"""Gets the Agent-world interface."""
return self._awi
@awi.setter
def awi(self, awi: AgentWorldInterface):
"""Sets the Agent-world interface. Should only be called by the world."""
self._awi = awi
def create_negotiation_request(
self,
issues: List[Issue],
partners: List[str],
annotation: Optional[Dict[str, Any]],
negotiator: Optional[Negotiator],
extra: Optional[Dict[str, Any]],
) -> str:
"""
Creates a new `NegotiationRequestInfo` record and returns its ID
Args:
issues: negotiation issues
partners: partners
annotation: annotation
negotiator: the negotiator to use
extra: any extra information
Returns:
A unique identifier for this negotiation info structure
"""
req_id = str(uuid.uuid4())
self._requested_negotiations[req_id] = NegotiationRequestInfo(
issues=issues,
partners=partners,
annotation=annotation,
negotiator=negotiator,
extra=extra,
requested=True,
uuid=req_id,
)
return req_id
def _request_negotiation(
self,
issues: List[Issue],
partners: List[str],
roles: List[str] = None,
annotation: Optional[Dict[str, Any]] = None,
mechanism_name: str = None,
mechanism_params: Dict[str, Any] = None,
negotiator: Negotiator = None,
extra: Optional[Dict[str, Any]] = None,
) -> bool:
"""
Requests to start a negotiation with some other agents
Args:
issues: Negotiation issues
annotation: Extra information to be passed to the `partners` when asking them to join the negotiation
partners: A list of partners to participate in the negotiation
roles: The roles of different partners. If None then each role for each partner will be None
mechanism_name: Name of the mechanism to use. It must be one of the mechanism_names that are supported by the
`World` or None which means that the `World` should select the mechanism. If None, then `roles` and `my_role`
must also be None
mechanism_params: A dict of parameters used to initialize the mechanism object
negotiator: My negotiator to use in this negotiation. Can be none
extra: Any extra information I would like to keep to myself for this negotiation
Returns:
List["Agent"] the list of partners who rejected the negotiation if any. If None then the negotiation was
accepted. If empty then the negotiation was not started from the world manager
Remarks:
- The function will create a request ID that will be used in callbacks `on_neg_request_accepted` and
`on_neg_request_rejected`.
- This function is a private function as the name implies and should not be called directly in any world.
- World designers extending this class for their worlds, should define a way to start negotiations that
calls this function. The simplest way is to just define a `request_negotiation` function that calls this
private version directly with the same parameters.
"""
req_id = self.create_negotiation_request(
issues=issues,
partners=partners,
annotation=annotation,
negotiator=negotiator,
extra=extra,
)
return self.awi.request_negotiation_about(
issues=issues,
partners=partners,
req_id=req_id,
roles=roles,
annotation=annotation,
mechanism_name=mechanism_name,
mechanism_params=mechanism_params,
)
def on_event(self, event: Event, sender: EventSource):
if not isinstance(sender, Mechanism) and not isinstance(sender, Mechanism):
raise ValueError(
f"Sender of the negotiation end event is of type {sender.__class__.__name__} "
f"not Mechanism!!"
)
# if event.type == "negotiation_end":
# # will be sent by the World once a negotiation in which this agent is involved is completed l
# mechanism_id = sender.id
# self._running_negotiations.pop(mechanism_id, None)
# ------------------------------------------------------------------
# EVENT CALLBACKS (Called by the `World` when certain events happen)
# ------------------------------------------------------------------
def on_neg_request_rejected_(self, req_id: str, by: Optional[List[str]]):
"""Called when a requested negotiation is rejected
Args:
req_id: The request ID passed to _request_negotiation
by: A list of agents that refused to participate or None if the failure was for another reason
"""
self.on_neg_request_rejected(req_id, by)
self._requested_negotiations.pop(req_id, None)
def on_neg_request_accepted_(self, req_id: str, mechanism: AgentMechanismInterface):
"""Called when a requested negotiation is accepted"""
my_request = req_id is not None
_request_dict = self._requested_negotiations
if req_id is None:
# I am not the requesting agent
req_id = mechanism.id
_request_dict = self._accepted_requests
neg = _request_dict.get(req_id, None)
if neg is None:
return
if my_request:
self.on_neg_request_accepted(req_id, mechanism)
self._running_negotiations[mechanism.id] = RunningNegotiationInfo(
extra=_request_dict[req_id].extra,
negotiator=neg.negotiator,
annotation=_request_dict[req_id].annotation,
uuid=req_id,
my_request=my_request,
)
_request_dict.pop(req_id, None)
def on_negotiation_failure_(
self,
partners: List[str],
annotation: Dict[str, Any],
mechanism: AgentMechanismInterface,
state: MechanismState,
) -> None:
"""Called whenever a negotiation ends without agreement"""
self.on_negotiation_failure(partners, annotation, mechanism, state)
self._running_negotiations.pop(mechanism.id, None)
def on_negotiation_success_(
self, contract: Contract, mechanism: AgentMechanismInterface
) -> None:
"""Called whenever a negotiation ends with agreement"""
self.on_negotiation_success(contract, mechanism)
self._unsigned_contracts.add(contract)
self._running_negotiations.pop(mechanism.id, None)
def on_contract_signed_(self, contract: Contract) -> None:
"""Called whenever a contract is signed by all partners"""
self.on_contract_signed(contract)
if contract in self._unsigned_contracts:
self._unsigned_contracts.remove(contract)
self.contracts.append(contract)
def on_contract_cancelled_(self, contract: Contract, rejectors: List[str]) -> None:
"""Called whenever at least a partner did not sign the contract"""
self.on_contract_cancelled(contract, rejectors)
if contract in self._unsigned_contracts:
self._unsigned_contracts.remove(contract)
def respond_to_negotiation_request_(
self,
initiator: str,
partners: List[str],
issues: List[Issue],
annotation: Dict[str, Any],
mechanism: AgentMechanismInterface,
role: Optional[str],
req_id: Optional[str],
) -> Optional[Negotiator]:
"""Called when a negotiation request is received"""
if req_id is not None:
# I am the one who requested this negotiation
info = self._requested_negotiations.get(req_id, None)
if info and info.negotiator is not None:
return info.negotiator
negotiator = self._respond_to_negotiation_request(
initiator=initiator,
partners=partners,
issues=issues,
annotation=annotation,
mechanism=mechanism,
role=role,
req_id=req_id,
)
if negotiator is not None:
self._accepted_requests[mechanism.id] = NegotiationRequestInfo(
partners,
issues,
annotation,
uuid,
negotiator,
extra={"my_request": False},
requested=False,
)
return negotiator
def __str__(self):
return f"{self.name}"
__repr__ = __str__
def on_simulation_step_ended(self):
"""Will be called at the end of the simulation step after everything else"""
def on_simulation_step_started(self):
"""Will be called at the beginning of the simulation step before everything else (except init)"""
@abstractmethod
def step(self):
"""Called by the simulator at every simulation step"""
@abstractmethod
def init(self):
"""Called to initialize the agent **after** the world is initialized. the AWI is accessible at this point."""
@abstractmethod
def _respond_to_negotiation_request(
self,
initiator: str,
partners: List[str],
issues: List[Issue],
annotation: Dict[str, Any],
mechanism: AgentMechanismInterface,
role: Optional[str],
req_id: Optional[str],
) -> Optional[Negotiator]:
"""
Called by the mechanism to ask for joining a negotiation. The agent can refuse by returning a None
Args:
initiator: The ID of the agent that initiated the negotiation request
partners: The partner list (will include this agent)
issues: The list of issues
annotation: Any annotation specific to this negotiation.
mechanism: The mechanism that started the negotiation
role: The role of this agent in the negotiation
req_id: The req_id passed to the AWI when starting the negotiation (only to the initiator).
Returns:
None to refuse the negotiation or a `Negotiator` object appropriate to the given mechanism to accept it.
Remarks:
- It is expected that world designers will introduce a better way to respond and override this function to
call it
"""
@abstractmethod
def on_neg_request_rejected(self, req_id: str, by: Optional[List[str]]):
"""Called when a requested negotiation is rejected
Args:
req_id: The request ID passed to _request_negotiation
by: A list of agents that refused to participate or None if the failure was for another reason
"""
@abstractmethod
def on_neg_request_accepted(self, req_id: str, mechanism: AgentMechanismInterface):
"""Called when a requested negotiation is accepted"""
@abstractmethod
def on_negotiation_failure(
self,
partners: List[str],
annotation: Dict[str, Any],
mechanism: AgentMechanismInterface,
state: MechanismState,
) -> None:
"""Called whenever a negotiation ends without agreement"""
@abstractmethod
def on_negotiation_success(
self, contract: Contract, mechanism: AgentMechanismInterface
) -> None:
"""Called whenever a negotiation ends with agreement"""
def on_contract_signed(self, contract: Contract) -> None:
"""Called whenever a contract is signed by all partners"""
def on_contract_cancelled(self, contract: Contract, rejectors: List[str]) -> None:
"""Called whenever at least a partner did not sign the contract"""
def on_contracts_finalized(
self,
signed: List[Contract],
cancelled: List[Contract],
rejectors: List[List[str]],
) -> None:
"""
Called for all contracts in a single step to inform the agent about which were finally signed
and which were rejected by any agents (including itself)
Args:
signed: A list of signed contracts. These are binding
cancelled: A list of cancelled contracts. These are not binding
rejectors: A list of lists where each of the internal lists gives the rejectors of one of the
cancelled contracts. Notice that it is possible that this list is empty which
means that the contract other than being rejected by any agents (if that was possible in
the specific world).
Remarks:
The default implementation is to call `on_contract_signed` for singed contracts and `on_contract_cancelled`
for cancelled contracts
"""
for contract in signed:
self.on_contract_signed_(contract)
for contract, r in zip(cancelled, rejectors):
self.on_contract_cancelled_(contract, r)
@abstractmethod
def set_renegotiation_agenda(
self, contract: Contract, breaches: List[Breach]
) -> Optional[RenegotiationRequest]:
"""
Received by partners in ascending order of their total breach levels in order to set the
renegotiation agenda when contract execution fails
Args:
contract: The contract being breached
breaches: All breaches on `contract`
Returns:
Renegotiation agenda (issues to negotiate about to avoid reporting the breaches).
"""
@abstractmethod
def respond_to_renegotiation_request(
self, contract: Contract, breaches: List[Breach], agenda: RenegotiationRequest
) -> Optional[Negotiator]:
"""
Called to respond to a renegotiation request
Args:
agenda:
contract:
breaches:
Returns:
"""
def sign_contract(self, contract: Contract) -> Optional[str]:
"""Called after the signing delay from contract conclusion to sign the contract. Contracts become binding
only after they are signed."""
return self.id
def sign_all_contracts(self, contracts: List[Contract]) -> List[Optional[str]]:
"""Called to sign all contracts concluded in a single step by this agent
Remarks:
default implementation calls `sign_contract` for each contract returning the results
"""
return [self.sign_contract(contract) for contract in contracts]
@abstractmethod
def on_contract_executed(self, contract: Contract) -> None:
"""
Called after successful contract execution for which the agent is one of the partners.
"""
@abstractmethod
def on_contract_breached(
self, contract: Contract, breaches: List[Breach], resolution: Optional[Contract]
) -> None:
"""
Called after complete processing of a contract that involved a breach.
Args:
contract: The contract
breaches: All breaches committed (even if they were resolved)
resolution: The resolution contract if re-negotiation was successful. None if not.
"""
def deflistdict():
return defaultdict(list)
class Operations(Enum):
Negotiations = 1
ContractSigning = 2
AgentSteps = 3
ContractExecution = 4
SimulationStep = 5
StatsUpdate = 6
class World(EventSink, EventSource, ConfigReader, NamedObject, CheckpointMixin, ABC):
"""Base world class encapsulating a world that runs a simulation with several agents interacting within some
dynamically changing environment.
A world maintains its own session.
"""
def __getstate__(self):
state = self.__dict__.copy()
if "logger" in state.keys():
state.pop("logger", None)
return state
def __setstate__(self, state):
self.__dict__ = state
self.logger = create_loggers(
file_name=self.log_file_name,
module_name=None,
screen_level=self.log_screen_level if self.log_to_screen else None,
file_level=self.log_file_level,
app_wide_log_file=True,
)
def __init__(
self,
bulletin_board: BulletinBoard = None,
n_steps=10000,
time_limit=60 * 60,
negotiation_speed=None,
neg_n_steps=100,
neg_time_limit=3 * 60,
neg_step_time_limit=60,
negotiation_quota_per_step=float("inf"),
negotiation_quota_per_simulation=float("inf"),
default_signing_delay=1,
force_signing=False,
batch_signing=True,
breach_processing=BreachProcessing.NONE,
mechanisms: Dict[str, Dict[str, Any]] = None,
awi_type: str = "negmas.situated.AgentWorldInterface",
start_negotiations_immediately: bool = False,
log_folder=None,
log_to_file=True,
log_ufuns=False,
log_negotiations: bool = False,
log_to_screen: bool = False,
log_stats_every: int = 0,
log_file_level=logging.DEBUG,
log_screen_level=logging.ERROR,
log_file_name="log.txt",
save_signed_contracts: bool = True,
save_cancelled_contracts: bool = True,
save_negotiations: bool = True,
save_resolved_breaches: bool = True,
save_unresolved_breaches: bool = True,
ignore_agent_exceptions: bool = False,
ignore_contract_execution_exceptions: bool = False,
safe_stats_monitoring: bool = False,
construct_graphs: bool = False,
checkpoint_every: int = 1,
checkpoint_folder: Optional[Union[str, Path]] = None,
checkpoint_filename: str = None,
extra_checkpoint_info: Dict[str, Any] = None,
single_checkpoint: bool = True,
exist_ok: bool = True,
operations: Collection[Operations] = (
Operations.StatsUpdate,
Operations.Negotiations,
Operations.ContractSigning,
Operations.AgentSteps,
Operations.ContractExecution,
Operations.SimulationStep,
Operations.ContractSigning,
Operations.StatsUpdate,
),
info: Optional[Dict[str, Any]] = None,
name=None,
):
"""
Args:
* General *
name: World Name
bulletin_board: A bulletin board object to use. If not given one will be created
awi_type: The type used for agent world interfaces (must descend from or behave like `AgentWorldInterface` )
info: A dictionary of key-value pairs that is kept within the world but never used. It is useful for storing
contextual information. For example, when running tournaments.
* Simulation parameters *
n_steps: Total simulation time in steps
time_limit: Real-time limit on the simulation
operations: A list of `Operations` to run in order during every simulation step
* Negotiation Parameters *
negotiation_speed: The number of negotiation steps per simulation step. None means infinite
neg_n_steps: Maximum number of steps allowed for a negotiation.
neg_step_time_limit: Time limit for single step of the negotiation protocol.
neg_time_limit: Real-time limit on each single negotiation
negotiation_quota_per_step: Number of negotiations an agent is allowed to start per step
negotiation_quota_per_simulation: Number of negotiations an agent is allowed to start in the simulation
start_negotiations_immediately: If true negotiations start immediately when registered rather than waiting
for the next step
mechanisms: The mechanism types allowed in this world associated with each keyward arguments to be passed
to it.
* Signing parameters *
default_signing_delay: The default number of steps between contract conclusion and signing it. Only takes
effect if `force_signing` is `False`
force_signing: If true, agents are not asked to sign contracts. They are forced to do so. In this
case, `default_singing_delay` is not effective and signature is immediate
batch_signing: If true, contracts are signed in batches not individually
* Breach Processing *
breach_processing: How to handle breaches. Can be any of `BreachProcessing` values
* Logging *
log_folder: Folder to save all logs
log_to_file: If true, will log to a file
log_file_name: Name of the log file
log_file_level: The log-level to save to file (WARNING, ERROR, INFO, DEBUG, CRITICAL, ...)
log_ufuns: Log utility functions
log_negotiations: Log all negotiation events
log_to_screen: Whether to log to screen
log_screen_level: The log-level to show on screen (WARNING, ERROR, INFO, DEBUG, CRITICAL, ...)
log_stats_every: If nonzero and positive, the period of saving stats
construct_graphs: If true, information needed to draw graphs using `draw` method are kept.
* What to save *
save_signed_contracts: Save all signed contracts
save_cancelled_contracts: Save all cancelled contracts
save_negotiations: Save all negotiation records
save_resolved_breaches: Save all resolved breaches
save_unresolved_breaches: Save all unresolved breaches
* Exception Handling *
ignore_agent_exceptions: Ignore agent exceptions and keep running
ignore_contract_execution_exceptions: Ignore contract execution exceptions and keep running
safe_stats_monitoring: Never throw an exception for a failure to save stats or because of a Stats Monitor
object
* Checkpoints *
checkpoint_every: The number of steps to checkpoint after. Set to <= 0 to disable
checkpoint_folder: The folder to save checkpoints into. Set to None to disable
checkpoint_filename: The base filename to use for checkpoints (multiple checkpoints will be prefixed with
step number).
single_checkpoint: If true, only the most recent checkpoint will be saved.
extra_checkpoint_info: Any extra information to save with the checkpoint in the corresponding json file as
a dictionary with string keys
exist_ok: IF true, checkpoints override existing checkpoints with the same filename.
"""
if force_signing:
batch_signing = False
super().__init__()
NamedObject.__init__(self, name=name)
CheckpointMixin.checkpoint_init(
self,
step_attrib="current_step",
every=checkpoint_every,
folder=checkpoint_folder,
filename=checkpoint_filename,
info=extra_checkpoint_info,
exist_ok=exist_ok,
single=single_checkpoint,
)
self.name = (
name.replace("/", ".")
if name is not None
else unique_name(base=self.__class__.__name__, add_time=True, rand_digits=5)
)
self.id = unique_name(self.name, add_time=True, rand_digits=8)
if log_folder is not None:
self._log_folder = Path(log_folder).absolute()
else:
self._log_folder = Path.home() / "negmas" / "logs"
if name is not None:
for n in name.split("/"):
self._log_folder /= n
else:
self._log_folder /= self.name
if (
log_folder
or log_negotiations
or log_stats_every
or log_to_file
or log_ufuns
):
self._log_folder.mkdir(parents=True, exist_ok=True)
self._agent_log_folder = self._log_folder / "_agent_logs"
self._agent_log_folder.mkdir(parents=True, exist_ok=True)
self._agent_loggers: Dict[str, logging.Logger] = {}
if log_file_name is None:
log_file_name = "log.txt"
if len(log_file_name) == 0:
log_to_file = False
self.log_file_name = (
str(self._log_folder / log_file_name) if log_to_file else ""
)
self.log_file_level = log_file_level
self.log_screen_level = log_screen_level
self.log_to_screen = log_to_screen
self.log_negotiations = log_negotiations
self.logger = create_loggers(
file_name=self.log_file_name,
module_name=None,
screen_level=log_screen_level if log_to_screen else None,
file_level=log_file_level,
app_wide_log_file=True,
)
self.ignore_contract_execution_exceptions = ignore_contract_execution_exceptions
self.ignore_agent_exception = ignore_agent_exceptions
self.bulletin_board: BulletinBoard = bulletin_board
self._negotiations: Dict[str, NegotiationInfo] = {}
self.unsigned_contracts: Dict[int, Set[Contract]] = defaultdict(set)
self.breach_processing = breach_processing
self.n_steps = n_steps
self.save_signed_contracts = save_signed_contracts
self.save_cancelled_contracts = save_cancelled_contracts
self.save_negotiations = save_negotiations
self.save_resolved_breaches = save_resolved_breaches
self.save_unresolved_breaches = save_unresolved_breaches
self.construct_graphs = construct_graphs
self.operations = operations
self._current_step = 0
self.negotiation_speed = negotiation_speed
self.default_signing_delay = default_signing_delay
self.time_limit = time_limit
self.neg_n_steps = neg_n_steps
self.neg_time_limit = neg_time_limit
self.neg_step_time_limit = neg_step_time_limit
self._entities: Dict[int, Set[Entity]] = defaultdict(set)
self._negotiations: Dict[str, NegotiationInfo] = {}
self.force_signing = force_signing
self.neg_quota_step = negotiation_quota_per_step
self.neg_quota_simulation = negotiation_quota_per_simulation
self._start_time = -1
self._log_ufuns = log_ufuns
self._log_negs = log_negotiations
self.safe_stats_monitoring = safe_stats_monitoring
self.info = info if info is not None else dict()
if isinstance(mechanisms, Collection) and not isinstance(mechanisms, dict):
mechanisms = dict(zip(mechanisms, [dict()] * len(mechanisms)))
self.mechanisms: Optional[Dict[str, Dict[str, Any]]] = mechanisms
self.awi_type = get_class(awi_type, scope=globals())
self._log_folder = str(self._log_folder)
self._stats: Dict[str, List[Any]] = defaultdict(list)
self.__n_negotiations = 0
self.__n_contracts_signed = 0
self.__n_contracts_concluded = 0
self.__n_contracts_cancelled = 0
self._saved_contracts: Dict[str, Dict[str, Any]] = {}
self._saved_negotiations: Dict[str, Dict[str, Any]] = {}
self._saved_breaches: Dict[str, Dict[str, Any]] = {}
self._started = False
self.batch_signing = batch_signing
self.agents: Dict[str, Agent] = {}
self.immediate_negotiations = start_negotiations_immediately
self.stats_monitors: Set[StatsMonitor] = set()
self.world_monitors: Set[WorldMonitor] = set()
self._edges_negotiation_requests_accepted: Dict[
int, Dict[Tuple[Agent, Agent], List[Dict[str, Any]]]
] = defaultdict(deflistdict)
self._edges_negotiation_requests_rejected: Dict[
int, Dict[Tuple[Agent, Agent], List[Dict[str, Any]]]
] = defaultdict(deflistdict)
self._edges_negotiations_started: Dict[
int, Dict[Tuple[Agent, Agent], List[Dict[str, Any]]]
] = defaultdict(deflistdict)
self._edges_negotiations_rejected: Dict[
int, Dict[Tuple[Agent, Agent], List[Dict[str, Any]]]
] = defaultdict(deflistdict)
self._edges_negotiations_succeeded: Dict[
int, Dict[Tuple[Agent, Agent], List[Dict[str, Any]]]
] = defaultdict(deflistdict)
self._edges_negotiations_failed: Dict[
int, Dict[Tuple[Agent, Agent], List[Dict[str, Any]]]
] = defaultdict(deflistdict)
self._edges_contracts_concluded: Dict[
int, Dict[Tuple[Agent, Agent], List[Dict[str, Any]]]
] = defaultdict(deflistdict)
self._edges_contracts_signed: Dict[
int, Dict[Tuple[Agent, Agent], List[Dict[str, Any]]]
] = defaultdict(deflistdict)
self._edges_contracts_cancelled: Dict[
int, Dict[Tuple[Agent, Agent], List[Dict[str, Any]]]
] = defaultdict(deflistdict)
self._edges_contracts_nullified: Dict[
int, Dict[Tuple[Agent, Agent], List[Dict[str, Any]]]
] = defaultdict(deflistdict)
self._edges_contracts_erred: Dict[
int, Dict[Tuple[Agent, Agent], List[Dict[str, Any]]]
] = defaultdict(deflistdict)
self._edges_contracts_executed: Dict[
int, Dict[Tuple[Agent, Agent], List[Dict[str, Any]]]
] = defaultdict(deflistdict)
self._edges_contracts_breached: Dict[
int, Dict[Tuple[Agent, Agent], List[Dict[str, Any]]]
] = defaultdict(deflistdict)
self.attribs: Dict[str, Dict[str, Any]] = {}
self._sim_start: int = 0
self._step_start: int = 0
if log_stats_every is None or log_stats_every < 1:
self._stats_file_name = None
self._stats_dir_name = None
else:
stats_file_name = _path(str(Path(self._log_folder) / "stats.csv"))
self._stats_file_name = stats_file_name.name
self._stats_dir_name = stats_file_name.parent
self.set_bulletin_board(bulletin_board=bulletin_board)
stats_calls = [_ for _ in self.operations if _ == Operations.StatsUpdate]
self._single_stats_call = len(stats_calls) == 1
self._two_stats_calls = len(stats_calls) == 2
self._n_negs_per_agent_per_step: Dict[str, int] = defaultdict(int)
self._n_negs_per_agent: Dict[str, int] = defaultdict(int)
self.loginfo(f"{self.name}: World Created")
@property
def current_step(self):
return self._current_step
@property
def log_folder(self):
return self._log_folder
def _agent_logger(self, aid: str) -> logging.Logger:
"""Returns the logger associated with a given agent"""
if aid not in self._agent_loggers.keys():
self._agent_loggers[aid] = create_loggers(
file_name=self._agent_log_folder / f"{aid}.txt",
module_name=None,
file_level=self.log_file_level,
app_wide_log_file=False,
module_wide_log_file=False,
)
return self._agent_loggers[aid]
def loginfo_agent(self, aid: str, s: str, event: Event = None) -> None:
"""logs information to the agent individual log
Args:
s (str): The string to log
event (Event): The event to announce after logging
"""
logger = self._agent_logger(aid)
logger.info(f"{self._log_header()}: " + s.strip())
if event:
self.announce(event)
def logdebug_agent(self, aid: str, s: str, event: Event = None) -> None:
"""logs debug to the agent individual log
Args:
s (str): The string to log
event (Event): The event to announce after logging
"""
logger = self._agent_logger(aid)
logger.debug(f"{self._log_header()}: " + s.strip())
if event:
self.announce(event)
def logwarning_agent(self, aid: str, s: str, event: Event = None) -> None:
"""logs warning to the agent individual log
Args:
s (str): The string to log
event (Event): The event to announce after logging
"""
logger = self._agent_logger(aid)
logger.warning(f"{self._log_header()}: " + s.strip())
if event:
self.announce(event)
def logerror_agent(self, aid: str, s: str, event: Event = None) -> None:
"""logs information to the agent individual log
Args:
s (str): The string to log
event (Event): The event to announce after logging
"""
logger = self._agent_logger(aid)
logger.error(f"{self._log_header()}: " + s.strip())
if event:
self.announce(event)
def loginfo(self, s: str, event: Event = None) -> None:
"""logs info-level information
Args:
s (str): The string to log
event (Event): The event to announce after logging
"""
self.logger.info(f"{self._log_header()}: " + s.strip())
if event:
self.announce(event)
def logdebug(self, s: str, event: Event = None) -> None:
"""logs debug-level information
Args:
s (str): The string to log
event (Event): The event to announce after logging
"""
self.logger.debug(f"{self._log_header()}: " + s.strip())
if event:
self.announce(event)
def logwarning(self, s: str, event: Event = None) -> None:
"""logs warning-level information
Args:
s (str): The string to log
event (Event): The event to announce after logging
"""
self.logger.warning(f"{self._log_header()}: " + s.strip())
if event:
self.announce(event)
def logerror(self, s: str, event: Event = None) -> None:
"""logs error-level information
Args:
s (str): The string to log
event (Event): The event to announce after logging
"""
self.logger.error(f"{self._log_header()}: " + s.strip())
if event:
self.announce(event)
def set_bulletin_board(self, bulletin_board):
self.bulletin_board = (
bulletin_board if bulletin_board is not None else BulletinBoard()
)
self.bulletin_board.add_section("breaches")
self.bulletin_board.add_section("stats")
self.bulletin_board.add_section("settings")
self.bulletin_board.record("settings", self.n_steps, "n_steps")
self.bulletin_board.record("settings", self.time_limit, "time_limit")
self.bulletin_board.record(
"settings", self.negotiation_speed, "negotiation_speed"
)
self.bulletin_board.record("settings", self.neg_n_steps, "neg_n_steps")
self.bulletin_board.record("settings", self.neg_time_limit, "neg_time_limit")
self.bulletin_board.record(
"settings", self.neg_step_time_limit, "neg_step_time_limit"
)
self.bulletin_board.record(
"settings", self.default_signing_delay, "default_signing_delay"
)
self.bulletin_board.record("settings", self.force_signing, "force_signing")
self.bulletin_board.record("settings", self.batch_signing, "batch_signing")
self.bulletin_board.record(
"settings", self.breach_processing, "breach_processing"
)
self.bulletin_board.record(
"settings",
list(self.mechanisms.keys()) if self.mechanisms is not None else [],
"mechanism_names",
)
self.bulletin_board.record(
"settings",
self.mechanisms if self.mechanisms is not None else dict(),
"mechanisms",
)
self.bulletin_board.record(
"settings", self.immediate_negotiations, "start_negotiations_immediately"
)
@property
def time(self) -> Optional[float]:
"""Elapsed time since mechanism started in seconds. None if the mechanism did not start running"""
if self._start_time is None:
return None
return time.monotonic() - self._start_time
@property
def remaining_time(self) -> Optional[float]:
"""Returns remaining time in seconds. None if no time limit is given."""
if self.time_limit is None:
return None
limit = self.time_limit - (time.monotonic() - self._start_time)
if limit < 0.0:
return 0.0
return limit
@property
def relative_time(self) -> float:
"""Returns a number between ``0`` and ``1`` indicating elapsed relative time or steps."""
if self.time_limit is None and self.n_steps is None:
return 0.0
relative_step = (
(self.current_step + 1) / self.n_steps
if self.n_steps is not None
else np.nan
)
relative_time = (
self.time / self.time_limit if self.time_limit is not None else np.nan
)
return max([relative_step, relative_time])
@property
def remaining_steps(self) -> Optional[int]:
"""Returns the remaining number of steps until the end of the mechanism run. None if unlimited"""
if self.n_steps is None:
return None
return self.n_steps - self.current_step
def _register_breach(self, breach: Breach) -> None:
# we do not report breachs with no victims
if breach.victims is None or len(breach.victims) < 1:
return
self.bulletin_board.record(
section="breaches", key=breach.id, value=self.breach_record(breach)
)
@property
def saved_negotiations(self) -> List[Dict[str, Any]]:
return list(self._saved_negotiations.values())
@property
def stats(self) -> Dict[str, Any]:
return self._stats
def _process_unsigned(self):
"""Processes all concluded but unsigned contracts"""
unsigned = self.unsigned_contracts.get(self.current_step, None)
signed = []
cancelled = []
if unsigned:
if self.batch_signing:
agent_contracts = defaultdict(list)
agent_signed = defaultdict(list)
agent_cancelled = defaultdict(list)
contract_signatures = defaultdict(int)
contract_rejectors = defaultdict(list)
for contract in unsigned:
for p in contract.partners:
if contract.signatures.get(p, None) is None:
agent_contracts[p].append(contract)
else:
contract_signatures[contract.id] += 1
for agent_id, contracts in agent_contracts.items():
slist = self.agents[agent_id].sign_all_contracts(contracts)
for contract, signature in zip(contracts, slist):
if signature is not None:
contract_signatures[contract.id] += 1
else:
contract_rejectors[contract.id].append(agent_id)
for contract in unsigned:
if contract_signatures[contract.id] == len(contract.partners):
contract.signatures = dict(
zip(contract.partners, contract.partners)
)
contract.signed_at = self.current_step
for partner in contract.partners:
agent_signed[partner].append(contract)
signed.append(contract)
else:
rejectors = contract_rejectors.get(contract.id, [])
for partner in contract.partners:
agent_cancelled[partner].append((contract, rejectors))
cancelled.append(contract)
everyone = set(agent_signed.keys()).union(set(agent_cancelled.keys()))
for agent_id in everyone:
cinfo = agent_cancelled[agent_id]
rejectors = [_[1] for _ in cinfo]
clist = [_[0] for _ in cinfo]
self.agents[agent_id].on_contracts_finalized(
agent_signed[agent_id], clist, rejectors
)
else:
for contract in unsigned:
rejectors = self._sign_contract(contract)
if rejectors is not None and len(rejectors) == 0:
signed.append(contract)
else:
cancelled.append(contract)
for contract in signed:
self.on_contract_signed(contract)
for contract in cancelled:
self.on_contract_cancelled(contract)
def _log_negotiation(self, negotiation: NegotiationInfo) -> None:
if not self._log_negs:
return
mechanism = negotiation.mechanism
agreement = mechanism.state.agreement
negs_folder = str(Path(self._log_folder) / "negotiations")
os.makedirs(negs_folder, exist_ok=True)
record = {
"partner_ids": [_.id for _ in negotiation.partners],
"partners": [_.name for _ in negotiation.partners],
"requested_at": negotiation.requested_at,
"concluded_at": self.current_step,
"issues": [str(issue) for issue in negotiation.issues],
"Failed": agreement is None,
"agreement": str(agreement),
"id": negotiation.mechanism.id,
}
record.update(to_flat_dict(negotiation.annotation))
add_records(str(Path(self._log_folder) / "negotiation_info.csv"), [record])
data = pd.DataFrame([to_flat_dict(_) for _ in mechanism.history])
data.to_csv(os.path.join(negs_folder, f"{mechanism.id}.csv"), index=False)
def _step_a_mechanism(
self, mechanism, force_immediate_signing
) -> Tuple[Optional[Contract], bool]:
"""Steps a mechanism one step.
Returns:
the agreement or NOne and whether the negotaition is still urnning
"""
contract = None
result = mechanism.step()
agreement, is_running = result.agreement, result.running
if agreement is not None or not is_running:
negotiation = self._negotiations.get(mechanism.id, None)
self._log_negotiation(negotiation)
if agreement is None:
self._register_failed_negotiation(mechanism.ami, negotiation)
else:
contract = self._register_contract(
mechanism.ami,
negotiation,
self._tobe_signed_at(agreement, force_immediate_signing),
)
if negotiation:
self._negotiations.pop(mechanism.uuid, None)
return contract, is_running
def _step_negotiations(
self,
mechanisms: List[Mechanism],
n_steps: Optional[int],
force_immediate_signing,
partners: List[Agent],
) -> Tuple[List[Contract], List[bool], int, int, int, int]:
""" Runs all bending negotiations """
running = [_ is not None for _ in mechanisms]
contracts = [None] * len(mechanisms)
indices = list(range(len(mechanisms)))
n_steps_broken_, n_steps_success_ = 0, 0
n_broken_, n_success_ = 0, 0
current_step = 0
if n_steps is None:
n_steps = float("inf")
while any(running):
random.shuffle(indices)
for i in indices:
if not running[i]:
continue
mechanism = mechanisms[i]
contract, r = self._step_a_mechanism(mechanism, force_immediate_signing)
contracts[i] = contract
running[i] = r
if not running:
if contract is None:
n_broken_ += 1
n_steps_broken_ += mechanism.state.step + 1
else:
n_success_ += 1
n_steps_success_ += mechanism.state.step + 1
self._add_edges(
partners[0],
partners,
self._edges_negotiations_succeeded
if contract is not None
else self._edges_negotiations_failed,
issues=mechanism.issues,
bi=True,
)
current_step += 1
if current_step >= n_steps:
break
return (
contracts,
running,
n_steps_broken_,
n_steps_success_,
n_broken_,
n_success_,
)
def step(self) -> bool:
"""A single simulation step"""
self._n_negs_per_agent_per_step = defaultdict(int)
if self.current_step >= self.n_steps:
return False
did_not_start, self._started = self._started, True
if self.current_step == 0:
self._sim_start = time.perf_counter()
self._step_start = self._sim_start
for priority in sorted(self._entities.keys()):
for agent in self._entities[priority]:
agent.init_()
# update monitors
for monitor in self.stats_monitors:
if self.safe_stats_monitoring:
__stats = copy.deepcopy(self.stats)
else:
__stats = self.stats
monitor.init(__stats, world_name=self.name)
for monitor in self.world_monitors:
monitor.init(self)
else:
self._step_start = time.perf_counter()
# do checkpoint processing
self.checkpoint_on_step_started()
for agent in self.agents.values():
agent.on_simulation_step_started()
self.loginfo(
f"{len(self._negotiations)} Negotiations/{len(self.agents)} Agents"
)
# initialize stats
# ----------------
n_new_contract_executions = 0
n_new_breaches = 0
n_new_contract_errors = 0
n_new_contract_nullifications = 0
activity_level = 0
n_steps_broken, n_steps_success = 0, 0
n_broken, n_success = 0, 0
stage = 0
stats_stage = 0
blevel = 0.0
self._stats["n_registered_negotiations_before"].append(len(self._negotiations))
def _run_negotiations(n_steps: Optional[int] = None):
""" Runs all bending negotiations """
nonlocal n_steps_broken, n_steps_success, n_broken, n_success
mechanisms = list(
(_.mechanism, _.partners)
for _ in self._negotiations.values()
if _ is not None
)
_, _, n_steps_broken_, n_steps_success_, n_broken_, n_success_ = self._step_negotiations(
[_[0] for _ in mechanisms], n_steps, False, [_[1] for _ in mechanisms]
)
n_total_broken = n_broken + n_broken_
if n_total_broken > 0:
n_steps_broken = (
n_steps_broken * n_broken + n_steps_broken_ * n_broken_
) / n_total_broken
n_broken = n_total_broken
n_total_success = n_success + n_success_
if n_total_success > 0:
n_steps_success = (
n_steps_success * n_success + n_steps_success_ * n_success_
) / n_total_success
n_success = n_total_success
def _step_agents():
# Step all entities in the world once:
# ------------------------------------
# note that entities are simulated in the partial-order specified by their priority value
tasks: List[Entity] = []
for priority in sorted(self._entities.keys()):
tasks += [_ for _ in self._entities[priority]]
for task in tasks:
try:
task.step_()
except Exception as e:
if not self.ignore_agent_exception:
raise e
exc_type, exc_value, exc_traceback = sys.exc_info()
self.logerror(
f"Entity exception @{task.id}: "
f"{traceback.format_tb(exc_traceback)}",
Event("entity-exception", dict(exception=e)),
)
def _sign_contracts():
self._process_unsigned()
def _simulation_step():
nonlocal stage
self.simulation_step(stage)
stage += 1
def _execute_contracts():
# execute contracts that are executable at this step
# --------------------------------------------------
nonlocal n_new_breaches, n_new_contract_executions, n_new_contract_errors, n_new_contract_nullifications, activity_level, blevel
current_contracts = [
_ for _ in self.executable_contracts() if _.nullified_at < 0
]
if len(current_contracts) > 0:
# remove expired contracts
executed = set()
current_contracts = self.order_contracts_for_execution(
current_contracts
)
for contract in current_contracts:
if contract.signed_at < 0:
continue
try:
contract_breaches = self.start_contract_execution(contract)
except Exception as e:
contract.executed_at = self.current_step
self._saved_contracts[contract.id]["breaches"] = ""
self._saved_contracts[contract.id]["executed_at"] = -1
self._saved_contracts[contract.id]["dropped_at"] = -1
self._saved_contracts[contract.id]["nullified_at"] = -1
self._saved_contracts[contract.id][
"erred_at"
] = self._current_step
self._add_edges(
contract.partners[0],
contract.partners,
self._edges_contracts_erred,
bi=True,
)
n_new_contract_errors += 1
if not self.ignore_contract_execution_exceptions:
raise e
exc_type, exc_value, exc_traceback = sys.exc_info()
self.logerror(
f"Contract exception @{str(contract)}: "
f"{traceback.format_tb(exc_traceback)}",
Event("contract-exceptin", dict(exception=e)),
)
continue
if contract_breaches is None:
self._saved_contracts[contract.id]["breaches"] = ""
self._saved_contracts[contract.id]["executed_at"] = -1
self._saved_contracts[contract.id]["dropped_at"] = -1
self._saved_contracts[contract.id][
"nullified_at"
] = self._current_step
self._add_edges(
contract.partners[0],
contract.partners,
self._edges_contracts_nullified,
bi=True,
)
self._saved_contracts[contract.id]["erred_at"] = -1
n_new_contract_nullifications += 1
elif len(contract_breaches) < 1:
self._saved_contracts[contract.id]["breaches"] = ""
self._saved_contracts[contract.id]["dropped_at"] = -1
self._saved_contracts[contract.id][
"executed_at"
] = self._current_step
self._add_edges(
contract.partners[0],
contract.partners,
self._edges_contracts_executed,
bi=True,
)
self._saved_contracts[contract.id]["nullified_at"] = -1
self._saved_contracts[contract.id]["erred_at"] = -1
executed.add(contract)
n_new_contract_executions += 1
_size = self.contract_size(contract)
if _size is not None:
activity_level += _size
for partner in contract.partners:
self.agents[partner].on_contract_executed(contract)
else:
self._saved_contracts[contract.id]["executed_at"] = -1
self._saved_contracts[contract.id]["nullified_at"] = -1
self._saved_contracts[contract.id]["dropped_at"] = -1
self._saved_contracts[contract.id]["erred_at"] = -1
self._saved_contracts[contract.id]["breaches"] = "; ".join(
f"{_.perpetrator}:{_.type}({_.level})"
for _ in contract_breaches
)
breachers = set(
(_.perpetrator, tuple(_.victims)) for _ in contract_breaches
)
for breacher, victims in breachers:
if isinstance(victims, str) or isinstance(victims, Agent):
victims = [victims]
self._add_edges(
breacher,
victims,
self._edges_contracts_breached,
bi=False,
)
for b in contract_breaches:
self._saved_breaches[b.id] = b.as_dict()
resolution = self._process_breach(
contract, list(contract_breaches)
)
if resolution is None:
n_new_breaches += 1
blevel += sum(_.level for _ in contract_breaches)
else:
n_new_contract_executions += 1
self.complete_contract_execution(
contract, list(contract_breaches), resolution
)
for partner in contract.partners:
self.agents[partner].on_contract_breached(
contract, list(contract_breaches), resolution
)
contract.executed_at = self.current_step
dropped = self.get_dropped_contracts()
self.delete_executed_contracts() # note that all contracts even breached ones are to be deleted
for c in dropped:
self._saved_contracts[c.id]["dropped_at"] = self._current_step
self._stats["n_contracts_dropped"].append(len(dropped))
def _stats_update():
nonlocal stats_stage
self.update_stats(stats_stage)
stats_stage += 1
operation_map = {
Operations.AgentSteps: _step_agents,
Operations.ContractExecution: _execute_contracts,
Operations.ContractSigning: _sign_contracts,
Operations.Negotiations: _run_negotiations,
Operations.SimulationStep: _simulation_step,
Operations.StatsUpdate: _stats_update,
}
for operation in self.operations:
operation_map[operation]()
# remove all negotiations that are completed
# ------------------------------------------
completed = list(
k
for k, _ in self._negotiations.items()
if _ is not None and _.mechanism.completed
)
for key in completed:
self._negotiations.pop(key, None)
# update stats
# ------------
self._stats["n_contracts_executed"].append(n_new_contract_executions)
self._stats["n_contracts_erred"].append(n_new_contract_errors)
self._stats["n_contracts_nullified"].append(n_new_contract_nullifications)
self._stats["n_contracts_cancelled"].append(self.__n_contracts_cancelled)
self._stats["n_breaches"].append(n_new_breaches)
self._stats["breach_level"].append(blevel)
self._stats["n_contracts_signed"].append(self.__n_contracts_signed)
self._stats["n_contracts_concluded"].append(self.__n_contracts_concluded)
self._stats["n_negotiations"].append(self.__n_negotiations)
self._stats["n_negotiation_rounds_successful"].append(n_steps_success)
self._stats["n_negotiation_rounds_failed"].append(n_steps_broken)
self._stats["n_negotiation_successful"].append(n_success)
self._stats["n_negotiation_failed"].append(n_broken)
self._stats["n_registered_negotiations_after"].append(len(self._negotiations))
self._stats["activity_level"].append(activity_level)
current_time = time.perf_counter() - self._step_start
self._stats["step_time"].append(current_time)
total = self._stats.get("total_time", [0.0])[-1]
self._stats["total_time"].append(total + current_time)
self.__n_negotiations = 0
self.__n_contracts_signed = 0
self.__n_contracts_concluded = 0
self.__n_contracts_cancelled = 0
self.append_stats()
for agent in self.agents.values():
agent.on_simulation_step_ended()
for monitor in self.stats_monitors:
if self.safe_stats_monitoring:
__stats = copy.deepcopy(self.stats)
else:
__stats = self.stats
monitor.step(__stats, world_name=self.name)
for monitor in self.world_monitors:
monitor.step(self)
self._current_step += 1
# always indicate that the simulation is to continue
return True
@property
def total_time(self):
"""Returns total simulation time (till now) in mx"""
return self._stats.get("total_time", [0.0])[-1]
def append_stats(self):
if self._stats_file_name is not None:
save_stats(
self,
log_dir=self._stats_dir_name,
stats_file_name=self._stats_file_name,
)
@property
def saved_breaches(self) -> List[Dict[str, Any]]:
return list(self._saved_breaches.values())
@property
def resolved_breaches(self) -> List[Dict[str, Any]]:
return list(_ for _ in self._saved_breaches.values() if _["resolved"])
@property
def unresolved_breaches(self) -> List[Dict[str, Any]]:
return list(_ for _ in self._saved_breaches.values() if not _["resolved"])
def run(self):
"""Runs the simulation until it ends"""
self._start_time = time.monotonic()
for _ in range(self.n_steps):
if (
self.time_limit is not None
and (time.monotonic() - self._start_time) >= self.time_limit
):
break
if not self.step():
break
def register(self, x: "Entity", simulation_priority: int = 0):
"""
Registers an entity in the world so it can be looked up by name. Should not be called directly
Args:
x: The entity to be registered
simulation_priority: The simulation periority. Entities with lower periorities will be stepped first during
Returns:
"""
# super().register(x) # If we inherit from session, we can do that but it is not needed as we do not do string
# based resolution now
if hasattr(x, "_world"):
x._world = self
if hasattr(x, "step_"):
self._entities[simulation_priority].add(x)
def register_stats_monitor(self, m: StatsMonitor):
self.stats_monitors.add(m)
def unregister_stats_monitor(self, m: StatsMonitor):
self.stats_monitors.remove(m)
def register_world_monitor(self, m: WorldMonitor):
self.world_monitors.add(m)
def unregister_world_monitor(self, m: WorldMonitor):
self.world_monitors.remove(m)
def join(self, x: "Agent", simulation_priority: int = 0, **kwargs):
"""Add an agent to the world.
Args:
x: The agent to be registered
simulation_priority: The simulation priority. Entities with lower pprioritieswill be stepped first during
kwargs: Any key-value pairs specifying attributes of the agent. NegMAS internally uses the attribute 'color'
when drawing the agent in `draw`
Returns:
"""
self.register(x, simulation_priority=simulation_priority)
self.agents[x.id] = x
self.attribs[x.id] = kwargs
x.awi = self.awi_type(self, x)
if self._started and not x.initialized:
x.init_()
self.loginfo(f"{x.name} joined", Event("agent-joined", dict(agent=x)))
def _add_edges(
self,
src: Agent,
dst: List[Agent],
target: Dict[int, Dict[Tuple[Agent, Agent], List[Dict[str, Any]]]],
bi=False,
issues: List[Issue] = None,
agreement: Dict[str, Any] = None,
):
"""Registers an edge"""
if not self.construct_graphs:
return
attr = None
if issues is not None:
attr = {i.name: i.values for i in issues}
if agreement is not None:
attr = agreement
for p in dst:
if p == src:
continue
src_id = src.id if isinstance(src, Agent) else src
p_id = p.id if isinstance(p, Agent) else p
target[self.current_step][(src_id, p_id)].append(attr)
if bi:
target[self.current_step][(p_id, src_id)].append(attr)
def _combine_edges(
self,
beg: int,
end: int,
target: Dict[int, Dict[Tuple[Agent, Agent], List[Dict[str, Any]]]],
):
"""Combines edges for the given steps [beg, end)"""
result = deflistdict()
def add_dicts(d1, d2):
d3 = deflistdict()
for k, v in d1.items():
d3[k] = d1[k] + d2[k]
for k, v in d2.items():
if k not in d3.keys():
d3[k] = d2[k]
return d3
for i in range(beg, end):
result = add_dicts(result, target[i])
return result
def _get_edges(
self,
target: Dict[int, Dict[Tuple[Agent, Agent], List[Dict[str, Any]]]],
step: int,
) -> List[Tuple[Agent, Agent, int]]:
"""Get the edges for the given step"""
return [(*k, {"weight": len(v)}) for k, v in target[step].items() if len(v) > 0]
def _register_negotiation(
self,
mechanism_name,
mechanism_params,
roles,
caller,
partners,
annotation,
issues,
req_id,
run_to_completion=False,
may_run_immediately=True,
) -> Tuple[Optional[NegotiationInfo], Optional[Contract], Optional[Mechanism]]:
"""Registers a negotiation and returns the negotiation info"""
if self._n_negs_per_agent_per_step[caller.id] >= self.neg_quota_step:
return None, None, None
if self._n_negs_per_agent[caller.id] >= self.neg_quota_simulation:
return None, None, None
factory = MechanismFactory(
world=self,
mechanism_name=mechanism_name,
mechanism_params=mechanism_params,
issues=issues,
req_id=req_id,
caller=caller,
partners=partners,
roles=roles,
annotation=annotation,
neg_n_steps=self.neg_n_steps,
neg_time_limit=self.neg_time_limit,
neg_step_time_limit=self.neg_step_time_limit,
log_ufuns_file=str(Path(self._log_folder) / "ufuns.csv")
if self._log_ufuns
else None,
)
neg = factory.init()
if neg is None:
self._add_edges(
caller, partners, self._edges_negotiations_rejected, issues=issues
)
return None, None, None
if neg.mechanism is None:
self._add_edges(
caller, partners, self._edges_negotiations_rejected, issues=issues
)
return neg, None, None
self.__n_negotiations += 1
self._n_negs_per_agent_per_step[caller.id] += 1
self._n_negs_per_agent[caller.id] += 1
self._add_edges(
caller, partners, self._edges_negotiations_started, issues=issues
)
# if not run_to_completion:
self._negotiations[neg.mechanism.uuid] = neg
if run_to_completion:
running = True
while running:
contract, running = self._step_a_mechanism(neg.mechanism, True)
self._add_edges(
caller,
partners,
self._edges_negotiations_succeeded
if contract is not None
else self._edges_negotiations_failed,
issues=issues,
)
return None, contract, neg.mechanism
if may_run_immediately and self.immediate_negotiations:
running = True
for i in range(self.negotiation_speed):
contract, running = self._step_a_mechanism(neg.mechanism, False)
if not running:
self._add_edges(
caller,
partners,
self._edges_negotiations_succeeded
if contract is not None
else self._edges_negotiations_failed,
issues=issues,
)
return None, contract, neg.mechanism
# self.loginfo(
# f'{caller.id} request was accepted')
return neg, None, None
def _unregister_negotiation(self, neg: MechanismFactory) -> None:
if neg is None or neg.mechanism is None:
return
del self._negotiations[neg.mechanism.uuid]
def request_negotiation_about(
self,
req_id: str,
caller: "Agent",
issues: List[Issue],
partners: List["Agent"],
roles: List[str] = None,
annotation: Optional[Dict[str, Any]] = None,
mechanism_name: str = None,
mechanism_params: Dict[str, Any] = None,
) -> bool:
"""
Requests to start a negotiation with some other agents
Args:
req_id: An ID For the request that is unique to the caller
caller: The agent requesting the negotiation
partners: The list of partners that the agent wants to negotiate with. Roles will be determined by these agents.
issues: Negotiation issues
annotation: Extra information to be passed to the `partners` when asking them to join the negotiation
partners: A list of partners to participate in the negotiation
roles: The roles of different partners. If None then each role for each partner will be None
mechanism_name: Name of the mechanism to use. It must be one of the mechanism_names that are supported by the
`World` or None which means that the `World` should select the mechanism. If None, then `roles` and `my_role`
must also be None
mechanism_params: A dict of parameters used to initialize the mechanism object
Returns:
None. The caller will be informed by a callback function `on_neg_request_accepted` or
`on_neg_request_rejected` about the status of the negotiation.
"""
self.loginfo(
f"{caller.name} requested negotiation "
+ (
f"using {mechanism_name}[{mechanism_params}] "
if mechanism_name is not None or mechanism_params is not None
else ""
)
+ f"with {[_.name for _ in partners]} (ID {req_id})",
Event(
"negotiation-request",
dict(
caller=caller,
partners=partners,
issues=issues,
mechanism_name=mechanism_name,
annotation=annotation,
req_id=req_id,
),
),
)
neg, *_ = self._register_negotiation(
mechanism_name=mechanism_name,
mechanism_params=mechanism_params,
roles=roles,
caller=caller,
partners=partners,
annotation=annotation,
issues=issues,
req_id=req_id,
run_to_completion=False,
)
success = neg is not None and neg.mechanism is not None
self._add_edges(
caller,
partners,
self._edges_negotiation_requests_accepted
if success
else self._edges_negotiation_requests_rejected,
issues=issues,
)
return success
def run_negotiation(
self,
caller: "Agent",
issues: Collection[Issue],
partners: Collection["Agent"],
negotiator: Negotiator,
ufun: UtilityFunction = None,
caller_role: str = None,
roles: Collection[str] = None,
annotation: Optional[Dict[str, Any]] = None,
mechanism_name: str = None,
mechanism_params: Dict[str, Any] = None,
) -> Optional[Tuple[Contract, AgentMechanismInterface]]:
"""
Runs a negotiation until completion
Args:
caller: The agent requesting the negotiation
partners: The list of partners that the agent wants to negotiate with. Roles will be determined by these agents.
negotiator: The negotiator to be used in the negotiation
ufun: The utility function. Only needed if the negotiator does not already know it
caller_role: The role of the caller in the negotiation
issues: Negotiation issues
annotation: Extra information to be passed to the `partners` when asking them to join the negotiation
partners: A list of partners to participate in the negotiation
roles: The roles of different partners. If None then each role for each partner will be None
mechanism_name: Name of the mechanism to use. It must be one of the mechanism_names that are supported by the
`World` or None which means that the `World` should select the mechanism. If None, then `roles` and `my_role`
must also be None
mechanism_params: A dict of parameters used to initialize the mechanism object
Returns:
A Tuple of a contract and the ami of the mechanism used to get it in case of success. None otherwise
"""
partners = [self.agents[_] for _ in partners]
self.loginfo(
f"{caller.name} requested immediate negotiation "
f"{mechanism_name}[{mechanism_params}] with {[_.name for _ in partners]}",
Event(
"negotiation-request-immediate",
dict(
caller=caller,
partners=partners,
issues=issues,
mechanism_name=mechanism_name,
annotation=annotation,
),
),
)
req_id = caller.create_negotiation_request(
issues=issues,
partners=partners,
annotation=annotation,
negotiator=negotiator,
extra={},
)
neg, contract, mechanism = self._register_negotiation(
mechanism_name=mechanism_name,
mechanism_params=mechanism_params,
roles=roles,
caller=caller,
partners=partners,
annotation=annotation,
issues=issues,
req_id=req_id,
run_to_completion=True,
)
if contract is not None:
return contract, mechanism.ami
if neg and neg.mechanism:
mechanism = neg.mechanism
if negotiator is not None:
mechanism.add(negotiator, ufun=ufun, role=caller_role)
mechanism.run()
if mechanism.agreement is None:
contract = None
self._register_failed_negotiation(
mechanism=mechanism.ami, negotiation=neg
)
else:
contract = self._register_contract(
mechanism.ami, neg, self._tobe_signed_at(mechanism.agreement, True)
)
return contract, mechanism.ami
return None, None
def run_negotiations(
self,
caller: "Agent",
issues: Union[List[Issue], List[List[Issue]]],
partners: List[List["Agent"]],
negotiators: List[Negotiator],
ufuns: List[UtilityFunction] = None,
caller_roles: List[str] = None,
roles: Optional[List[Optional[List[str]]]] = None,
annotations: Optional[List[Optional[Dict[str, Any]]]] = None,
mechanism_names: Optional[Union[str, List[str]]] = None,
mechanism_params: Optional[Union[Dict[str, Any], List[Dict[str, Any]]]] = None,
all_or_none: bool = False,
) -> List[Tuple[Contract, AgentMechanismInterface]]:
"""
Requests to run a set of negotiations simultaneously. Returns after all negotiations are run to completion
Args:
caller: The agent requesting the negotiation
partners: The list of partners that the agent wants to negotiate with. Roles will be determined by these agents.
issues: Negotiation issues
negotiators: The negotiator to be used in the negotiation
ufuns: The utility function. Only needed if the negotiator does not already know it
caller_roles: The role of the caller in the negotiation
annotations: Extra information to be passed to the `partners` when asking them to join the negotiation
partners: A list of partners to participate in the negotiation
roles: The roles of different partners. If None then each role for each partner will be None
mechanism_names: Name of the mechanism to use. It must be one of the mechanism_names that are supported by the
`World` or None which means that the `World` should select the mechanism. If None, then `roles` and `my_role`
must also be None
mechanism_params: A dict of parameters used to initialize the mechanism object
all_of_none: If True, ALL partners must agree to negotiate to go through.
Returns:
A list of tuples each with two values: contract (None for failure) and ami (The mechanism info [None if
the partner refused the negotiation])
"""
partners = [[self.agents[_] for _ in p] for p in partners]
n_negs = len(partners)
if isinstance(issues[0], Issue):
issues = [issues] * n_negs
if roles is None or not (
isinstance(roles, list) and isinstance(roles[0], list)
):
roles = [roles] * n_negs
if annotations is None or isinstance(annotations, dict):
annotations = [annotations] * n_negs
if mechanism_names is None or isinstance(mechanism_names, str):
mechanism_names = [mechanism_names] * n_negs
if mechanism_params is None or isinstance(mechanism_params, dict):
mechanism_params = [mechanism_params] * n_negs
if caller_roles is None or isinstance(caller_roles, str):
caller_roles = [caller_roles] * n_negs
if negotiators is None or isinstance(negotiators, Negotiator):
raise ValueError(f"Must pass all negotiators for run_negotiations")
if ufuns is None or isinstance(ufuns, UtilityFunction):
ufuns = [ufuns] * n_negs
self.loginfo(
f"{caller.name} requested {n_negs} immediate negotiation "
f"{mechanism_names}[{mechanism_params}] between {[[_.name for _ in p] for p in partners]}",
Event(
"negotiation-request",
dict(
caller=caller,
partners=partners,
issues=issues,
mechanism_name=mechanism_names,
all_or_none=all_or_none,
annotations=annotations,
),
),
)
negs = []
for (issue, partner, role, annotation, mech_name, mech_param) in zip(
issues, partners, roles, annotations, mechanism_names, mechanism_params
):
neg, *_ = self._register_negotiation(
mechanism_name=mech_name,
mechanism_params=mech_param,
roles=role,
caller=caller,
partners=partner,
annotation=annotation,
issues=issue,
req_id=None,
run_to_completion=False,
may_run_immediately=False,
)
neg.partners.append(caller)
if neg is None and all_or_none:
for _n in negs:
self._unregister_negotiation(_n)
return []
negs.append(neg)
if all(_ is None for _ in negs):
return []
completed = [False] * n_negs
contracts = [None] * n_negs
amis = [None] * n_negs
for i, (neg, crole, ufun, negotiator) in enumerate(
zip(negs, caller_roles, ufuns, negotiators)
):
completed[i] = neg is None or (neg.mechanism is None) or negotiator is None
if completed[i]:
continue
mechanism = neg.mechanism
mechanism.add(negotiator, ufun=ufun, role=crole)
locs = [i for i in range(n_negs) if not completed[i]]
cs, rs, _, _, _, _ = self._step_negotiations(
[negs[i].mechanism for i in locs],
float("inf"),
True,
[negs[i].partners for _ in locs],
)
for i, loc in enumerate(locs):
contracts[loc] = cs[i]
completed[loc] = not rs[i]
amis[i] = negs[i].mechanism.ami
return list(zip(contracts, amis))
def _log_header(self):
if self.time is None:
return f"{self.name} (not started)"
return f"{self.current_step}/{self.n_steps} [{self.relative_time:0.2%}]"
def _register_contract(
self, mechanism, negotiation, to_be_signed_at
) -> Optional[Contract]:
partners = negotiation.partners
if self.save_negotiations:
_stats = {
"final_status": "failed",
"partners": [_.id for _ in partners],
"partner_types": [_.__class__.__name__ for _ in partners],
"ended_at": self.current_step,
"requested_at": negotiation.requested_at,
"mechanism_type": mechanism.__class__.__name__,
}
_stats.update(mechanism.state.__dict__)
self._saved_negotiations[mechanism.id] = _stats
if mechanism.state.agreement is None or negotiation is None:
return None
agreement = mechanism.state.agreement
agreement = outcome_as_dict(
agreement, issue_names=[_.name for _ in mechanism.issues]
)
signed_at = -1
contract = Contract(
partners=list(_.id for _ in partners),
annotation=negotiation.annotation,
issues=negotiation.issues,
agreement=agreement,
concluded_at=self.current_step,
to_be_signed_at=to_be_signed_at,
signed_at=signed_at,
mechanism_state=mechanism.state,
)
self.on_contract_concluded(contract, to_be_signed_at)
for partner in partners:
partner.on_negotiation_success_(contract=contract, mechanism=mechanism)
if self.batch_signing:
if to_be_signed_at != self.current_step:
sign_status = f"to be signed at {contract.to_be_signed_at}"
else:
sign_status = ""
else:
if to_be_signed_at == self.current_step:
rejectors = self._sign_contract(contract)
signed = rejectors is not None and len(rejectors) == 0
if signed:
self.on_contract_signed(contract)
sign_status = (
"signed"
if signed
else f"cancelled by {rejectors if rejectors is not None else 'error!!'}"
)
else:
sign_status = f"to be signed at {contract.to_be_signed_at}"
# self.on_contract_processed(contract=contract)
if negotiation.annotation is not None:
annot_ = dict(
zip(
negotiation.annotation.keys(),
(str(_) for _ in negotiation.annotation.values()),
)
)
else:
annot_ = ""
self.logdebug(
f"Contract [{sign_status}]: "
f"{[_.name for _ in partners]}"
f" > {str(mechanism.state.agreement)} on annotation {annot_}",
Event(
"negotiation-success",
dict(mechanism=mechanism, contract=contract, partners=partners),
),
)
return contract
def _register_failed_negotiation(self, mechanism, negotiation) -> None:
partners = negotiation.partners
mechanism_state = mechanism.state
annotation = negotiation.annotation
self._add_edges(
partners[0],
partners,
self._edges_negotiations_failed,
issues=mechanism.issues,
bi=True,
)
if self.save_negotiations:
_stats = {
"final_status": "failed",
"partners": [_.id for _ in partners],
"partner_types": [_.__class__.__name__ for _ in partners],
"ended_at": self.current_step,
"requested_at": negotiation.requested_at,
"mechanism_type": mechanism.__class__.__name__,
}
_stats.update(mechanism.state.__dict__)
self._saved_negotiations[mechanism.id] = _stats
for partner in partners:
partner.on_negotiation_failure_(
partners=[_.id for _ in partners],
annotation=annotation,
mechanism=mechanism,
state=mechanism_state,
)
self.logdebug(
f"Negotiation failure between {[_.name for _ in partners]}"
f" on annotation {negotiation.annotation} ",
Event("negotiation-failure", dict(mechanism=mechanism, partners=partners)),
)
def _sign_contract(self, contract: Contract) -> Optional[List[str]]:
"""Called to sign a contract and returns whether or not it was signed"""
# if self._contract_finalization_time(contract) >= self.n_steps or \
# self._contract_execution_time(contract) < self.current_step:
# return None
partners = [self.agents[_] for _ in contract.partners]
def _do_sign(c, p):
s_ = c.signatures.get(p, None)
if s_ is not None:
return s_
try:
return p.sign_all_contracts([c])[0]
except Exception as e:
exc_type, exc_value, exc_traceback = sys.exc_info()
self.logerror(
f"Signature exception @ {p.name}: {traceback.format_tb(exc_traceback)}",
Event("agent-exception", dict(method="sign_contract", exception=e)),
)
return None
if self.force_signing:
signatures = [(partner, partner.id) for partner in partners]
rejectors = []
else:
signatures = list(
zip(partners, (_do_sign(contract, partner) for partner in partners))
)
rejectors = [
partner for partner, signature in signatures if signature is None
]
if len(rejectors) == 0:
contract.signatures = {a.id: s for a, s in signatures}
contract.signed_at = self.current_step
for partner in partners:
partner.on_contract_signed_(contract=contract)
else:
for partner in partners:
partner.on_contract_cancelled_(
contract=contract, rejectors=[_.id for _ in rejectors]
)
return [_.id for _ in rejectors]
def on_contract_signed(self, contract: Contract) -> None:
"""Called to add a contract to the existing set of contract after it is signed
Args:
contract: The contract to add
Remarks:
- By default this function just adds the contract to the set of contracts maintaned by the world.
- You should ALWAYS call this function when overriding it.
"""
self._add_edges(
contract.partners[0],
contract.partners,
self._edges_contracts_signed,
bi=True,
)
self.__n_contracts_signed += 1
try:
self.unsigned_contracts[self.current_step].remove(contract)
except KeyError:
pass
record = self.contract_record(contract)
if self.save_signed_contracts:
record["signed_at"] = self.current_step
record["executed_at"] = -1
record["breaches"] = ""
record["nullified_at"] = -1
record["erred_at"] = -1
record["dropped_at"] = -1
self._saved_contracts[contract.id] = record
else:
self._saved_contracts.pop(contract.id, None)
def on_contract_processed(self, contract):
"""
Called whenever a contract finished processing to be removed from unsigned contracts
Args:
contract: Contract
Remarks:
- called by on_contract_cancelled and on_contract_signed
"""
unsigned = self.unsigned_contracts.get(self.current_step, None)
if unsigned is None:
return
try:
unsigned.remove(contract)
except KeyError:
pass
def on_contract_cancelled(self, contract):
"""Called whenever a concluded contract is not signed (cancelled)
Args:
contract: The contract to add
Remarks:
- By default this function just adds the contract to the set of contracts maintaned by the world.
- You should ALWAYS call this function when overriding it.
"""
self._add_edges(
contract.partners[0],
contract.partners,
self._edges_contracts_cancelled,
bi=True,
)
record = self.contract_record(contract)
record["signed_at"] = -1
record["executed_at"] = -1
record["breaches"] = ""
record["nullified_at"] = -1
record["dropped_at"] = -1
record["erred_at"] = -1
self._saved_contracts[contract.id] = record
self.__n_contracts_cancelled += 1
self.on_contract_processed(contract)
def ignore_contract(self, contract):
"""Ignores the contract as if it was never agreed upon
Args:
contract: The contract to add
"""
if contract.agreement is not None:
self.__n_contracts_concluded -= 1
if contract.id in self._saved_contracts.keys():
if self._saved_contracts[contract.id]["signed_at"] >= 0:
self.__n_contracts_signed -= 1
del self._saved_contracts[contract.id]
self.on_contract_processed(contract)
@property
def saved_contracts(self) -> List[Dict[str, Any]]:
return list(self._saved_contracts.values())
@property
def executed_contracts(self) -> List[Dict[str, Any]]:
return list(
_ for _ in self._saved_contracts.values() if _.get("executed_at", -1) >= 0
)
@property
def signed_contracts(self) -> List[Dict[str, Any]]:
return list(
_ for _ in self._saved_contracts.values() if _.get("signed_at", -1) >= 0
)
@property
def nullified_contracts(self) -> List[Dict[str, Any]]:
return list(
_ for _ in self._saved_contracts.values() if _.get("nullified_at", -1) >= 0
)
@property
def erred_contracts(self) -> List[Dict[str, Any]]:
return list(
_ for _ in self._saved_contracts.values() if _.get("erred_at", -1) >= 0
)
@property
def cancelled_contracts(self) -> List[Dict[str, Any]]:
return list(
_ for _ in self._saved_contracts.values() if not _.get("signed_at", -1) < 0
)
def on_contract_concluded(self, contract: Contract, to_be_signed_at: int) -> None:
"""Called to add a contract to the existing set of unsigned contract after it is concluded
Args:
contract: The contract to add
to_be_signed_at: The timestep at which the contract is to be signed
Remarks:
- By default this function just adds the contract to the set of contracts maintaned by the world.
- You should ALWAYS call this function when overriding it.
"""
self.__n_contracts_concluded += 1
self._add_edges(
contract.partners[0],
contract.partners,
self._edges_contracts_concluded,
agreement=contract.agreement,
bi=True,
)
self.unsigned_contracts[to_be_signed_at].add(contract)
def save_config(self, file_name: str):
"""
Saves the config of the world as a yaml file
Args:
file_name: Name of file to save the config to
Returns:
"""
with open(file_name, "w") as file:
yaml.safe_dump(self.__dict__, file)
def _process_breach(
self, contract: Contract, breaches: List[Breach], force_immediate_signing=True
) -> Optional[Contract]:
new_contract = None
# calculate total breach level
total_breach_levels = defaultdict(int)
for breach in breaches:
total_breach_levels[breach.perpetrator] += breach.level
if self.breach_processing == BreachProcessing.VICTIM_THEN_PERPETRATOR:
# give agents the chance to set renegotiation agenda in ascending order of their total breach levels
for agent_name, _ in sorted(
zip(total_breach_levels.keys(), total_breach_levels.values()),
key=lambda x: x[1],
):
agent = self.agents[agent_name]
agenda = agent.set_renegotiation_agenda(
contract=contract, breaches=breaches
)
if agenda is None:
continue
negotiators = []
for partner in contract.partners:
negotiator = self.agents[partner].respond_to_renegotiation_request(
contract=contract, breaches=breaches, agenda=agenda
)
if negotiator is None:
break
negotiators.append(negotiator)
else:
# everyone accepted this renegotiation
results = self.run_negotiation(
caller=agent,
issues=agenda.issues,
partners=[self.agents[_] for _ in contract.partners],
)
if results is not None:
new_contract, mechanism = results
self._register_contract(
mechanism=mechanism,
negotiation=None,
to_be_signed_at=self._tobe_signed_at(
mechanism.agreement, force_immediate_signing
),
)
break
elif self.breach_processing == BreachProcessing.META_NEGOTIATION:
raise NotImplemented(
"Meta negotiation is not yet implemented. Agents should negotiate about the "
"agend then a negotiation should be conducted as usual"
)
if new_contract is not None:
for breach in breaches:
if self.save_resolved_breaches:
self._saved_breaches[breach.id]["resolved"] = True
else:
self._saved_breaches.pop(breach.id, None)
return new_contract
for breach in breaches:
if self.save_unresolved_breaches:
self._saved_breaches[breach.id]["resolved"] = False
else:
self._saved_breaches.pop(breach.id, None)
self._register_breach(breach)
return None
def _tobe_signed_at(self, agreement: Outcome, force_immediate_signing=False) -> int:
return (
self.current_step
if force_immediate_signing
else self.current_step + self.default_signing_delay
)
# todo add _get_signing_delay(contract) and implement it in SCML2019
def graph(
self,
steps: Optional[Union[Tuple[int, int], int]] = None,
what: Collection[str] = EDGE_TYPES,
who: Callable[[Agent], bool] = None,
together: bool = True,
) -> Union[nx.Graph, List[nx.Graph]]:
"""
Generates a graph showing some aspect of the simulation
Args:
steps: The step/steps to generate the graphs for. If a tuple is given all edges within the given range
(inclusive beginning, exclusive end) will be accumulated
what: The edges to have on the graph. Options are: negotiations, concluded, signed, executed
who: Either a callable that receives an agent and returns True if it is to be shown or None for all
together: IF specified all edge types are put in the same graph.
Returns:
A networkx graph representing the world if together==True else a list of graphs one for each item in what
"""
if steps is None:
steps = self.current_step
if isinstance(steps, int):
steps = [steps, steps + 1]
steps = tuple(min(self.n_steps - 1, max(0, _)) for _ in steps)
if who is None:
who = lambda x: True
agents = [_.id for _ in self.agents.values() if who(_)]
if together:
g = nx.MultiDiGraph()
g.add_nodes_from(agents)
graphs = [g] * len(what)
else:
graphs = [nx.DiGraph() for _ in what]
for g in graphs:
g.add_nodes_from(agents)
max_step = max(steps) - 1
for g, edge_type in zip(graphs, what):
edge_info = getattr(self, f"_edges_{edge_type.replace('-', '_')}")
edge_info = {max_step: self._combine_edges(*steps, edge_info)}
color = EDGE_COLORS[edge_type]
edgelist = self._get_edges(edge_info, max_step)
for e in edgelist:
e[2]["color"] = color
g.add_edges_from(edgelist)
return graphs[0] if together else graphs
def draw(
self,
steps: Optional[Union[Tuple[int, int], int]] = None,
what: Collection[str] = DEFAULT_EDGE_TYPES,
who: Callable[[Agent], bool] = None,
where: Callable[[Agent], Union[int, Tuple[float, float]]] = None,
together: bool = True,
axs: Collection[Axis] = None,
ncols: int = 4,
figsize: Tuple[int, int] = (15, 15),
show_node_labels=True,
show_edge_labels=True,
**kwargs,
) -> Union[Tuple[Axis, nx.Graph], Tuple[Axis, List[nx.Graph]]]:
"""
Generates a graph showing some aspect of the simulation
Args:
steps: The step/steps to generate the graphs for. If a tuple is given all edges within the given range
(inclusive beginning, exclusive end) will be accomulated
what: The edges to have on the graph. Options are: negotiations, concluded, signed, executed
who: Either a callable that receives an agent and returns True if it is to be shown or None for all
where: A callable that returns for each agent the position it showed by drawn at either as an integer
specifying the column in which to draw the column or a tuple of two floats specifying the position
within the drawing area of the agent. If None, the default Networkx layout will be used.
together: IF specified all edge types are put in the same graph.
axs: The axes used for drawing. If together is true, it should be a single `Axis` object otherwise it should
be a list of `Axis` objects with the same length as what.
show_node_labels: show node labels!
show_edge_labels: show edge labels!
kwargs: passed to networx.draw_networkx
Returns:
A networkx graph representing the world if together==True else a list of graphs one for each item in what
"""
if not self.construct_graphs:
self.logwarning(
"Asked to draw a world simulation without enabling `construct_graphs`. Will be ignored"
)
return [None, None]
if steps is None:
steps = self.current_step
if isinstance(steps, int):
steps = [steps, steps + 1]
steps = tuple(min(self.n_steps - 1, max(0, _)) for _ in steps)
if who is None:
who = lambda x: True
if together:
titles = [""]
else:
titles = what
if axs is None:
if together:
fig, axs = plt.subplots()
else:
nrows = int(math.ceil(len(what) / ncols))
fig, axs = plt.subplots(nrows, ncols, figsize=figsize)
axs = axs.flatten().tolist()
if together:
axs = [axs]
graphs = self.graph(steps, what, who, together)
graph = graphs[0] if not together else graphs
graphs = [graphs] if together else graphs
if where is None:
pos = None
else:
pos = [where(a) for a in graph.nodes]
if not isinstance(pos[0], tuple):
deltax = 5
deltay = 5
cols = defaultdict(list)
for agent, p in zip(graph.nodes, pos):
cols[p].append(agent)
pos = dict()
for c, ros in cols.items():
for r, agent in enumerate(ros):
pos[agent] = ((1 + c) * deltay, r * deltax)
else:
pos = dict(zip(graph.nodes, pos))
if together:
g = graph
nx.draw_networkx_nodes(g, pos, ax=axs[0])
edges = [_ for _ in g.edges]
if len(edges) > 0:
info = [_ for _ in g.edges.data("color")]
colors = [_[2] for _ in info]
edges = [(_[0], _[1]) for _ in info]
clist = list(set(colors))
edgelists = [list() for _ in range(len(clist))]
for c, lst in zip(clist, edgelists):
for i, clr in enumerate(colors):
if clr == c:
lst.append(edges[i])
for lst, clr in zip(edgelists, clist):
nx.draw_networkx_edges(
g, pos, edgelist=g.edges, edge_color=clr, ax=axs[0]
)
if show_edge_labels:
info = [_ for _ in g.edges.data("weight")]
weights = [str(_[2]) for _ in info if _[2] > 1]
edges = [(_[0], _[1]) for _ in info if _[2] > 1]
nx.draw_networkx_edge_labels(
g, pos, dict(zip(edges, weights)), ax=axs[0]
)
if show_node_labels:
nx.draw_networkx_labels(g, pos, dict(zip(g.nodes, g.nodes)), ax=axs[0])
else:
for g, ax, title in zip(graphs, axs, titles):
nx.draw_networkx_nodes(g, pos, ax=ax)
nx.draw_networkx_edges(
g, pos, edgelist=g.edges, edge_color=EDGE_COLORS[title], ax=ax
)
if show_edge_labels:
info = [_ for _ in g.edges.data("weight")]
weights = [str(_[2]) for _ in info if _[2] > 1]
edges = [(_[0], _[1]) for _ in info if _[2] > 1]
nx.draw_networkx_edge_labels(
g, pos, dict(zip(edges, weights)), ax=ax
)
if show_node_labels:
nx.draw_networkx_labels(g, pos, dict(zip(g.nodes, g.nodes)), ax=ax)
ax.set_ylabel(title)
total_time = time.perf_counter() - self._sim_start
step = max(steps)
remaining = (self.n_steps - step - 1) * total_time / (step + 1)
title = (
f"Step: {step + 1}/{self.n_steps} [{humanize_time(total_time)} rem "
f"{humanize_time(remaining)}] {total_time/(remaining + total_time):04.2%}"
)
if together:
axs[0].set_title(title)
else:
f = plt.gcf()
f.suptitle(title)
return (axs[0], graph) if together else (axs, graphs)
@property
def business_size(self) -> float:
"""The total business size defined as the total money transferred within the system"""
return sum(self.stats["activity_level"])
def n_saved_contracts(self, ignore_no_issue: bool = True) -> int:
"""
Number of saved contracts
Args:
ignore_no_issue: If true, only contracts resulting from negotiation (has some issues) will be counted
"""
return len(self._saved_contracts)
@property
def agreement_fraction(self) -> float:
"""Fraction of negotiations ending in agreement and leading to signed contracts"""
n_negs = sum(self.stats["n_negotiations"])
n_contracts = self.n_saved_contracts(True)
return n_contracts / n_negs if n_negs != 0 else np.nan
@property
def cancellation_fraction(self) -> float:
"""Fraction of negotiations ending in agreement and leading to signed contracts"""
n_negs = sum(self.stats["n_negotiations"])
n_contracts = self.n_saved_contracts(True)
n_signed_contracts = len(
[_ for _ in self._saved_contracts.values() if _["signed_at"] >= 0]
)
return (1.0 - n_signed_contracts / n_contracts) if n_contracts != 0 else np.nan
@property
def n_negotiation_rounds_successful(self) -> float:
"""Average number of rounds in a successful negotiation"""
n_negs = sum(self.stats["n_contracts_concluded"])
if n_negs == 0:
return np.nan
return sum(self.stats["n_negotiation_rounds_successful"]) / n_negs
@property
def n_negotiation_rounds_failed(self) -> float:
"""Average number of rounds in a successful negotiation"""
n_negs = sum(self.stats["n_negotiations"]) - self.n_saved_contracts(True)
if n_negs == 0:
return np.nan
return sum(self.stats["n_negotiation_rounds_failed"]) / n_negs
@property
def contract_execution_fraction(self) -> float:
"""Fraction of signed contracts successfully executed with no breaches, or errors"""
n_executed = sum(self.stats["n_contracts_executed"])
n_signed_contracts = len(
[_ for _ in self._saved_contracts.values() if _["signed_at"] >= 0]
)
return n_executed / n_signed_contracts if n_signed_contracts > 0 else 0.0
@property
def contract_dropping_fraction(self) -> float:
"""Fraction of signed contracts that were never executed because they were signed to late to be executable"""
n_executed = sum(self.stats["n_contracts_dropped"])
n_signed_contracts = len(
[_ for _ in self._saved_contracts.values() if _["signed_at"] >= 0]
)
return n_executed / n_signed_contracts if n_signed_contracts > 0 else 0.0
@property
def contract_err_fraction(self) -> float:
"""Fraction of signed contracts that caused exception during their execution"""
n_erred = sum(self.stats["n_contracts_erred"])
n_signed_contracts = len(
[_ for _ in self._saved_contracts.values() if _["signed_at"] >= 0]
)
return n_erred / n_signed_contracts if n_signed_contracts > 0 else 0.0
@property
def contract_nullification_fraction(self) -> float:
"""Fraction of signed contracts were nullified by the system (e.g. due to bankruptcy)"""
n_nullified = sum(self.stats["n_contracts_nullified"])
n_signed_contracts = len(
[_ for _ in self._saved_contracts.values() if _["signed_at"] >= 0]
)
return n_nullified / n_signed_contracts if n_signed_contracts > 0 else 0.0
@property
def breach_level(self) -> float:
"""The average breach level per contract """
blevel = np.nansum(self.stats["breach_level"])
n_contracts = sum(self.stats["n_contracts_executed"]) + sum(
self.stats["n_breaches"]
)
return blevel / n_contracts if n_contracts > 0 else 0.0
@property
def breach_fraction(self) -> float:
"""Fraction of signed contracts that led to breaches"""
n_breaches = sum(self.stats["n_breaches"])
n_signed_contracts = len(
[_ for _ in self._saved_contracts.values() if _["signed_at"] >= 0]
)
return n_breaches / n_signed_contracts if n_signed_contracts != 0 else 0.0
breach_rate = breach_fraction
agreement_rate = agreement_fraction
cancellation_rate = cancellation_fraction
@abstractmethod
def delete_executed_contracts(self) -> None:
"""Called after processing executable contracts at every simulation step to delete processed contracts"""
@abstractmethod
def executable_contracts(self) -> Collection[Contract]:
"""Called at every time-step to get the contracts that are `executable` at this point of the simulation"""
def get_dropped_contracts(self) -> Collection[Contract]:
"""Called at the end of every time-step to get a list of the contracts that are signed but will never be
executed"""
return []
def update_stats(self, stage: int):
"""
Called to update any custom stats that the world designer wants to keep
Args:
stage: How many times was this method called during this stage
Remarks:
- Default behavior is:
- If `Operations` . `StatsUpdate` appears once in operations, it calls post_step_stats once
- Otherwise: it calls pre_step_stats for stage 0, and post_step_stats for any other stage.
"""
if self._single_stats_call:
self.post_step_stats()
return
if stage == 0:
self.pre_step_stats()
return
self.post_step_stats()
return
def post_step_stats(self):
"""Called at the end of the simulation step to update all stats
Kept for backward compatibility and will be dropped. Override `update_stats` ins"""
def pre_step_stats(self):
"""Called at the beginning of the simulation step to prepare stats or update them
Kept for backward compatibility and will be dropped. Override `update_stats` instead"""
@abstractmethod
def order_contracts_for_execution(
self, contracts: Collection[Contract]
) -> Collection[Contract]:
"""Orders the contracts in a specific time-step that are about to be executed"""
return contracts
@abstractmethod
def contract_record(self, contract: Contract) -> Dict[str, Any]:
"""Converts a contract to a record suitable for permanent storage"""
@abstractmethod
def breach_record(self, breach: Breach) -> Dict[str, Any]:
"""Converts a breach to a record suitable for storage during the simulation"""
@abstractmethod
def start_contract_execution(self, contract: Contract) -> Optional[Set[Breach]]:
"""
Tries to execute the contract
Args:
contract:
Returns:
Set[Breach]: The set of breaches committed if any. If there are no breaches return an empty set
Remarks:
- You must call super() implementation of this method before doing anything
- It is possible to return None which indicates that the contract was nullified (i.e. not executed due to a
reason other than an execution exeception).
"""
self.loginfo(
f"Executing {str(contract)}",
Event("executing-contract", dict(contract=contract)),
)
return set()
@abstractmethod
def complete_contract_execution(
self, contract: Contract, breaches: List[Breach], resolution: Contract
) -> None:
"""
Called after breach resolution is completed for contracts for which some potential breaches occurred.
Args:
contract: The contract considered.
breaches: The list of potential breaches that was generated by `_execute_contract`.
resolution: The agreed upon resolution
Returns:
"""
@abstractmethod
def execute_action(
self, action: Action, agent: "Agent", callback: Callable = None
) -> bool:
"""Executes the given action by the given agent"""
@abstractmethod
def get_private_state(self, agent: "Agent") -> dict:
"""Reads the private state of the given agent"""
@abstractmethod
def simulation_step(self, stage: int):
"""A single step of the simulation.
Args:
stage: How many times so far was this method called within the current simulation step
Remarks:
- Using the stage parameter, it is possible to have `Operations` . `SimulationStep` several times with
the list of operations while differentiating between these calls.
"""
@abstractmethod
def contract_size(self, contract: Contract) -> float:
"""
Returns an estimation of the **activity level** associated with this contract. Higher is better
Args:
contract:
Returns:
"""
class SimpleWorld(World, ABC):
"""
Represents a simple world simulation with sane values for most callbacks and methods.
"""
def delete_executed_contracts(self) -> None:
pass
def post_step_stats(self):
pass
def pre_step_stats(self):
pass
def order_contracts_for_execution(
self, contracts: Collection[Contract]
) -> Collection[Contract]:
return contracts
def contract_record(self, contract: Contract) -> Dict[str, Any]:
return to_flat_dict(contract, deep=True)
def breach_record(self, breach: Breach) -> Dict[str, Any]:
return to_flat_dict(breach, deep=True)
def contract_size(self, contract: Contract) -> float:
return 0.0
class TimeInAgreementMixin:
def init(self, time_field="time"):
self._time_field_name = time_field
self.contracts_per_step: Dict[int, List[Contract]] = defaultdict(list)
def on_contract_signed(self: World, contract: Contract):
super().on_contract_signed(contract=contract)
self.contracts_per_step[contract.agreement[self._time_field_name]].append(
contract
)
def executable_contracts(self: World) -> Collection[Contract]:
"""Called at every time-step to get the contracts that are `executable` at this point of the simulation"""
if set(
_["id"]
for _ in self._saved_contracts.values()
if _["delivery_time"] == self.current_step and _["signed_at"] >= 0
) != set(_.id for _ in self.contracts_per_step.get(self.current_step, [])):
saved = set(
_["id"]
for _ in self._saved_contracts.values()
if _["delivery_time"] == self.current_step and _["signed_at"] >= 0
)
used = set(_.id for _ in self.contracts_per_step.get(self.current_step, []))
err = (
f"Some signed contracts due at {self.current_step} are not being executed: {saved - used} "
f"({used - saved}):\n"
)
for c in saved - used:
err += f"Saved Only:{str(self._saved_contracts[c])}\n"
for c in used - saved:
con = None
for _ in self.contracts_per_step.get(self.current_step, []):
if _.id == c:
con = _
break
err += f"Executable Only:{con}\n"
raise ValueError(err)
return self.contracts_per_step.get(self.current_step, [])
def delete_executed_contracts(self: World) -> None:
self.contracts_per_step.pop(self.current_step, None)
def get_dropped_contracts(self) -> Collection[Contract]:
return [
_
for _ in self.contracts_per_step.get(self.current_step, [])
if self._saved_contracts[_.id]["signed_at"] >= 0
and self._saved_contracts[_.id].get("breaches", "") == ""
and self._saved_contracts[_.id].get("nullified_at", -1) < 0
and self._saved_contracts[_.id].get("erred_at", -1) < 0
and self._saved_contracts[_.id].get("executed_at", -1) < 0
]
class NoContractExecutionMixin:
"""
A mixin to add when there is no contract execution
"""
def delete_executed_contracts(self: World) -> None:
pass
def executable_contracts(self) -> Collection[Contract]:
return []
def start_contract_execution(self, contract: Contract) -> Set[Breach]:
return set()
def complete_contract_execution(
self, contract: Contract, breaches: List[Breach], resolution: Contract
) -> None:
pass
def save_stats(
world: World,
log_dir: str,
params: Dict[str, Any] = None,
stats_file_name: Optional[str] = None,
):
"""
Saves the statistics of a world run.
Args:
world: The world
log_dir: The directory to save the stats into.
params: A parameter list to save with the world
stats_file_name: File name to use for stats file(s) without extension
Returns:
"""
def is_json_serializable(x):
try:
json.dumps(x)
except:
return False
return True
log_dir = Path(log_dir)
os.makedirs(log_dir, exist_ok=True)
if params is None:
d = to_dict(world, add_type_field=False, deep=False)
to_del = []
for k, v in d.items():
if isinstance(v, list) or isinstance(v, tuple):
d[k] = str(v)
if not is_json_serializable(v):
to_del.append(k)
for k in to_del:
del d[k]
params = d
if stats_file_name is None:
stats_file_name = "stats"
dump(params, log_dir / "params")
dump(world.stats, log_dir / stats_file_name)
if world.info is not None:
dump(world.info, log_dir / "info")
if hasattr(world, "info") and world.info is not None:
dump(world.info, log_dir / "info")
try:
data = pd.DataFrame.from_dict(world.stats)
data.to_csv(str(log_dir / f"{stats_file_name}.csv"), index_label="index")
except:
pass
if world.save_negotiations:
if len(world.saved_negotiations) > 0:
data = pd.DataFrame(world.saved_negotiations)
data.to_csv(str(log_dir / "negotiations.csv"), index_label="index")
else:
with open(log_dir / "negotiations.csv", "w") as f:
f.write("")
if world.save_resolved_breaches or world.save_unresolved_breaches:
if len(world.saved_breaches) > 0:
data = pd.DataFrame(world.saved_breaches)
data.to_csv(str(log_dir / "breaches.csv"), index_label="index")
else:
with open(log_dir / "breaches.csv", "w") as f:
f.write("")
if world.save_signed_contracts:
if len(world.signed_contracts) > 0:
data = pd.DataFrame(world.signed_contracts)
# data = data.sort_values(["delivery_time"])
# data = data.loc[
# :,
# [
# "seller_type",
# "buyer_type",
# "seller_name",
# "buyer_name",
# "delivery_time",
# "unit_price",
# "quantity",
# "product_name",
# "n_neg_steps",
# "signed_at",
# "concluded_at",
# "cfp",
# ],
# ]
data.to_csv(str(log_dir / "signed_contracts.csv"), index_label="index")
else:
with open(log_dir / "signed_contracts.csv", "w") as f:
f.write("")
if world.save_cancelled_contracts:
if len(world.cancelled_contracts) > 0:
data = pd.DataFrame(world.cancelled_contracts)
# data = data.sort_values(["delivery_time"])
# data = data.loc[
# :,
# [
# "seller_type",
# "buyer_type",
# "seller_name",
# "buyer_name",
# "delivery_time",
# "unit_price",
# "quantity",
# "product_name",
# "n_neg_steps",
# "signed_at",
# "concluded_at",
# "cfp",
# ],
# ]
data.to_csv(str(log_dir / "cancelled_contracts.csv"), index_label="index")
else:
with open(log_dir / "cancelled_contracts.csv", "w") as f:
f.write("")
if world.save_signed_contracts or world.save_cancelled_contracts:
if len(world.saved_contracts) > 0:
data = pd.DataFrame(world.saved_contracts)
for col in ("delivery_time", "time"):
if col in data.columns:
data = data.sort_values(["delivery_time"])
break
data.to_csv(str(log_dir / "contracts_full_info.csv"), index_label="index")
# data = data.loc[
# :,
# [
# "seller_type",
# "buyer_type",
# "seller_name",
# "buyer_name",
# "delivery_time",
# "unit_price",
# "quantity",
# "product_name",
# "n_neg_steps",
# "signed_at",
# "concluded_at",
# "cfp",
# ],
# ]
if world.save_signed_contracts and world.save_cancelled_contracts:
data.to_csv(str(log_dir / "all_contracts.csv"), index_label="index")
else:
with open(log_dir / "contracts_full_info.csv", "w") as f:
f.write("")
if world.save_signed_contracts and world.save_cancelled_contracts:
with open(log_dir / "all_contracts.csv", "w") as f:
f.write("")
class NoResponsesMixin:
"""A mixin that can be added to Agent to minimize the number of abstract methods"""
def on_neg_request_rejected(self, req_id: str, by: Optional[List[str]]):
pass
def on_neg_request_accepted(self, req_id: str, mechanism: AgentMechanismInterface):
pass
def on_negotiation_failure(
self,
partners: List[str],
annotation: Dict[str, Any],
mechanism: AgentMechanismInterface,
state: MechanismState,
) -> None:
pass
def on_negotiation_success(
self, contract: Contract, mechanism: AgentMechanismInterface
) -> None:
pass
def on_contract_signed(self, contract: Contract) -> None:
pass
def on_contract_cancelled(self, contract: Contract, rejectors: List[str]) -> None:
pass
def set_renegotiation_agenda(
self, contract: Contract, breaches: List[Breach]
) -> Optional[RenegotiationRequest]:
pass
def respond_to_renegotiation_request(
self, contract: Contract, breaches: List[Breach], agenda: RenegotiationRequest
) -> Optional[Negotiator]:
pass
def on_contract_executed(self, contract: Contract) -> None:
pass
def on_contract_breached(
self, contract: Contract, breaches: List[Breach], resolution: Optional[Contract]
) -> None:
pass