IndDecentralizingAgent

class scml.scml2020.IndDecentralizingAgent(*args, negotiator_type=<class 'negmas.sao.negotiators.timebased.AspirationNegotiator'>, negotiator_params=None, **kwargs)[source]

Bases: scml.scml2020.agents.decentralizing._NegotiationCallbacks, scml.scml2020.components.negotiation.IndependentNegotiationsManager, scml.scml2020.components.trading.PredictionBasedTradingStrategy, scml.scml2020.components.production.SupplyDrivenProductionStrategy, scml.scml2020.agent.SCML2020Agent

Attributes Summary

accepted_negotiation_requests

A list of negotiation requests sent to this agent that are already accepted by it.

awi

Gets the Agent-world interface.

crisp_ufun

Returns the preferences if it is a CrispUtilityFunction else None

has_cardinal_preferences

Does the entity has an associated ufun?

has_preferences

Does the entity has an associated ufun?

id

The unique ID of this entity

initialized

Was the agent initialized (i.e.

internal_state

Returns the internal state of the agent for debugging purposes

name

A convenient name of the entity (intended primarily for printing/logging/debugging).

negotiation_requests

A list of the negotiation requests sent by this agent that are not yet accepted or rejected.

preferences

The utility function attached to that object

prob_ufun

Returns the preferences if it is a ProbUtilityFunction else None

requested_negotiations

The negotiations currently requested by the agent.

reserved_outcome

Reserved outcome is the outcome that will be realized by default for this agent.

reserved_value

Reserved value is what the entity gets if no agreement is reached in the negotiation.

running_negotiations

The negotiations currently requested by the agent.

short_type_name

Returns a short name of the type of this entity

type_name

Returns the name of the type of this entity

type_postfix

ufun

Returns the preferences if it is a UtilityFunction else None

unsigned_contracts

All contracts that are not yet signed.

use_trading

uuid

The unique ID of this entity

Methods Summary

acceptable_unit_price(step, sell)

Returns the maximum/minimum acceptable unit price for buying/selling at the given time-step

before_step()

can_be_produced(contract_id)

Returns True if the SELL contract given can be honored in principle given the production capacity of the agent (n.

checkpoint(path[, file_name, info, ...])

Saves a checkpoint of the current object at the given path.

checkpoint_info(file_name)

Returns the information associated with a dump of the object saved in the given file

confirm_production(commands, balance, inventory)

Called just before production starts at every time-step allowing the agent to change what is to be produced in its factory

create(*args, **kwargs)

Creates an object and returns a proxy to it.

create_negotiation_request(issues, partners, ...)

Creates a new NegotiationRequestInfo record and returns itS ID

create_ufun(is_seller[, issues, outcomes])

Creates a utility function

from_checkpoint(file_name[, return_info])

Creates an object from a saved checkpoint

from_config(config[, section, ...])

Creates an object of this class given the configuration info

init()

Called to initialize the agent after the world is initialized.

init_()

Called to initialize the agent after the world is initialized.

negotiator(is_seller[, issues, outcomes, ...])

Creates a negotiator

notify(notifiable, notification)

on_agent_bankrupt(agent, contracts, ...)

Called whenever a contract is nullified (because the partner is bankrupt)

on_contract_breached(contract, breaches, ...)

Called after complete processing of a contract that involved a breach.

on_contract_cancelled(contract, rejectors)

Called whenever at least a partner did not sign the contract

on_contract_cancelled_(contract, rejectors)

Called whenever at least a partner did not sign the contract

on_contract_executed(contract)

Called after successful contract execution for which the agent is one of the partners.

on_contract_signed(contract)

Called whenever a contract is signed by all partners

on_contract_signed_(contract)

Called whenever a contract is signed by all partners

on_contracts_finalized(signed, cancelled, ...)

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)

on_event(event, sender)

on_failures(failures)

Called whenever there are failures either in production or in execution of guaranteed transactions

on_neg_request_accepted(req_id, mechanism)

Called when a requested negotiation is accepted

on_neg_request_accepted_(req_id, mechanism)

Called when a requested negotiation is accepted

on_neg_request_rejected(req_id, by)

Called when a requested negotiation is rejected

on_neg_request_rejected_(req_id, by)

Called when a requested negotiation is rejected

on_negotiation_failure(partners, annotation, ...)

Called whenever a negotiation ends without agreement

on_negotiation_failure_(partners, ...)

Called whenever a negotiation ends without agreement

on_negotiation_success(contract, mechanism)

Called whenever a negotiation ends with agreement

on_negotiation_success_(contract, mechanism)

Called whenever a negotiation ends with agreement

on_preferences_changed(changes)

Called to inform the entity that its ufun has changed.

on_simulation_step_ended()

Will be called at the end of the simulation step after everything else

on_simulation_step_started()

Will be called at the beginning of the simulation step before everything else (except init)

predict_quantity(contract)

read_config(config[, section])

Reads the configuration from a file or a dict and prepares it for parsing

respond_to_negotiation_request(initiator, ...)

Called whenever another agent requests a negotiation with this agent.

respond_to_negotiation_request_(initiator, ...)

Called when a negotiation request is received

respond_to_renegotiation_request(contract, ...)

Called to respond to a renegotiation request

set_preferences(value[, force])

Sets tha utility function/Preferences.

set_renegotiation_agenda(contract, breaches)

Received by partners in ascending order of their total breach levels in order to set the renegotiation agenda when contract execution fails

sign_all_contracts(contracts)

Signs all contracts

sign_contract(contract)

Called after the signing delay from contract conclusion to sign the contract.

spawn([spawn_as, spawn_params])

spawn_object(*args, **kwargs)

start_negotiations(product, quantity, ...[, ...])

Starts a set of negotiations to buy/sell the product with the given limits

step()

Generates buy and sell negotiations as needed

step_()

Called at every time-step.

target_quantities(steps, sell)

Implemented for speed but not really required

target_quantity(step, sell)

Returns the target quantity to sell/buy at a given time-step

to_dict()

trade_prediction_before_step()

Will be called at the beginning of every step to update the prediction

trade_prediction_init()

Will be called to update expected_outputs, expected_inputs, input_cost, output_cost during init()

trade_prediction_step()

Will be called at the end of every step to update the prediction

Attributes Documentation

accepted_negotiation_requests

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 type

list[NegotiationRequestInfo]

awi

Gets the Agent-world interface.

Return type

AgentWorldInterface

crisp_ufun

Returns the preferences if it is a CrispUtilityFunction else None

Return type

UtilityFunction | None

has_cardinal_preferences

Does the entity has an associated ufun?

Return type

bool

has_preferences

Does the entity has an associated ufun?

Return type

bool

id

The unique ID of this entity

initialized

Was the agent initialized (i.e. was init_() called)

Return type

bool

internal_state
name

A convenient name of the entity (intended primarily for printing/logging/debugging).

negotiation_requests

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 type

list[NegotiationRequestInfo]

preferences

The utility function attached to that object

Return type

Preferences | None

prob_ufun

Returns the preferences if it is a ProbUtilityFunction else None

Return type

ProbUtilityFunction | None

requested_negotiations

The negotiations currently requested by the agent.

Return type

list[NegotiationRequestInfo]

Returns

A list of negotiation request information objects (NegotiationRequestInfo)

reserved_outcome

Reserved outcome is the outcome that will be realized by default for this agent.

Remarks:

  • Reserved outcomes are defined for OrdinalPreferences.

See also

reserved_value

Return type

tuple | None

reserved_value

Reserved value is what the entity gets if no agreement is reached in the negotiation.

The reserved value can either be explicity defined for the ufun or it can be the output of the ufun for None outcome.

Return type

float

running_negotiations

The negotiations currently requested by the agent.

Return type

list[RunningNegotiationInfo]

Returns

A list of negotiation information objects (RunningNegotiationInfo)

short_type_name

Returns a short name of the type of this entity

type_name

Returns the name of the type of this entity

type_postfix
ufun

Returns the preferences if it is a UtilityFunction else None

Return type

BaseUtilityFunction | None

unsigned_contracts

All contracts that are not yet signed.

Return type

list[Contract]

use_trading
uuid

The unique ID of this entity

Methods Documentation

acceptable_unit_price(step, sell)

Returns the maximum/minimum acceptable unit price for buying/selling at the given time-step

Parameters
  • step (int) – Simulation step

  • sell (bool) – Sell or buy

Return type

int

before_step()
can_be_produced(contract_id)

Returns True if the SELL contract given can be honored in principle given the production capacity of the agent (n. lines). It does not check for the availability of inputs or enough money to run the production process.

Remarks:

  • Cannot be called before calling on_contracts_finalized

checkpoint(path, file_name=None, info=None, exist_ok=False, single_checkpoint=True, step_attribs=('current_step', '_current_step', '_Entity__current_step', '_step'))

Saves a checkpoint of the current object at the given path.

Parameters
  • path (PathLike) – Full path to a directory to store the checkpoint

  • file_name (Optional[str]) – Name of the file to dump into. If not given, a unique name is created

  • info (Optional[dict[str, Any]]) – Information to save with the checkpoint (must be json serializable)

  • exist_ok (bool) – If true, override existing dump

  • single_checkpoint (bool) – If true, keep a single checkpoint for the last step

  • step_attribs (tuple[str, ...]) – Attributes to represent the time-step of the object. Any of the given attributes will be used in the file name generated if single_checkpoint is False. If single_checkpoint is True, the filename will not contain time-step information

Return type

Path

Returns

full path to the file used to save the checkpoint

classmethod checkpoint_info(file_name)

Returns the information associated with a dump of the object saved in the given file

Parameters

file_name (Path | str) – Name of the object

Returns:

Return type

dict[str, Any]

confirm_production(commands, balance, inventory)

Called just before production starts at every time-step allowing the agent to change what is to be produced in its factory

Parameters
  • commands (ndarray) – an n_lines vector giving the process to be run at every line (NO_COMMAND indicates nothing to be processed

  • balance (int) – The current balance of the factory

  • inventory – an n_products vector giving the number of items available in the inventory of every product type.

Return type

ndarray

Returns

an n_lines vector giving the process to be run at every line (NO_COMMAND indicates nothing to be processed

Remarks:

  • Not called in SCML2020 competition.

  • The inventory will contain zero items of all products that the factory does not buy or sell

  • The default behavior is to just retrun commands confirming production of everything.

classmethod create(*args, **kwargs)

Creates an object and returns a proxy to it.

create_negotiation_request(issues, partners, annotation, negotiator, extra)

Creates a new NegotiationRequestInfo record and returns itS ID

Parameters
  • issues (list[Issue]) – negotiation issues

  • partners (list[str]) – partners

  • annotation (dict[str, Any] | None) – annotation

  • negotiator (Negotiator | None) – the negotiator to use

  • extra (dict[str, Any] | None) – any extra information

Return type

str

Returns

A unique identifier for this negotiation info structure

create_ufun(is_seller, issues=None, outcomes=None)[source]

Creates a utility function

classmethod from_checkpoint(file_name, return_info=False)

Creates an object from a saved checkpoint

Parameters
  • file_name (Path | str) –

  • return_info – If True, tbe information saved when the file was dumped are returned

Return type

NamedObject | tuple[NamedObject, dict[str, Any]]

Returns

Either the object or the object and dump-info as a dict (if return_info was true)

Remarks:

  • If info is returned, it is guaranteed to have the following members:
    • time: Dump time

    • type: Type of the dumped object

    • id: ID

    • name: name

classmethod from_config(config, section=None, ignore_children=True, try_parsing_children=True, scope=None)

Creates an object of this class given the configuration info

Parameters
  • config (str | dict) – Either a file name or a dictionary

  • section (Optional[str]) – A section in the file or a key in the dictionary to use for loading params

  • ignore_children (bool) – If true then children will be ignored and there will be a single return

  • try_parsing_children (bool) – If true the children will first be parsed as ConfigReader classes if they are not

  • int (simple types (e.g.) –

  • str

  • float

  • Iterable[int|str|float]

  • scope – The scope at which to evaluate any child classes. This MUST be passed as scope=globals() if you are

  • parsed. (having any children that are to be) –

Returns

An object of cls if ignore_children is True or a tuple with an object of cls and a dictionary with children that were not parsed.

Remarks:

  • This function will return an object of its class after passing the key-value pairs found in the config to the init function.

  • Requiring passing scope=globals() to this function is to get around the fact that in python eval() will be called with a globals dictionary based on the module in which the function is defined not called. This means that in general when eval() is called to create the children, it will not have access to the class definitions of these children (except if they happen to be imported in this file). To avoid this problem causing an undefined_name exception, the caller must pass her globals() as the scope.

init()

Called to initialize the agent after the world is initialized. the AWI is accessible at this point.

init_()

Called to initialize the agent after the world is initialized. the AWI is accessible at this point.

negotiator(is_seller, issues=None, outcomes=None, partner=None)

Creates a negotiator

Return type

SAONegotiator

notify(notifiable, notification)
on_agent_bankrupt(agent, contracts, quantities, compensation_money)

Called whenever a contract is nullified (because the partner is bankrupt)

Parameters
  • agent (str) – The ID of the agent that went bankrupt.

  • contracts (List[Contract]) – All future contracts between this agent and the bankrupt agent.

  • quantities (List[int]) – The actual quantities that these contracts will be executed at.

  • compensation_money (int) – The compensation money that is already added to the agent’s wallet (if ANY).

Remarks:

  • compensation_money will be nonzero iff immediate_compensation is enabled for this world

Return type

None

on_contract_breached(contract, breaches, resolution)

Called after complete processing of a contract that involved a breach.

Parameters
  • contract (Contract) – The contract

  • breaches (List[Breach]) – All breaches committed (even if they were resolved)

  • resolution (Optional[Contract]) – The resolution contract if re-negotiation was successful. None if not.

Return type

None

on_contract_cancelled(contract, rejectors)

Called whenever at least a partner did not sign the contract

Return type

None

on_contract_cancelled_(contract, rejectors)

Called whenever at least a partner did not sign the contract

Return type

None

on_contract_executed(contract)

Called after successful contract execution for which the agent is one of the partners.

Return type

None

on_contract_signed(contract)

Called whenever a contract is signed by all partners

Return type

None

on_contract_signed_(contract)

Called whenever a contract is signed by all partners

Return type

None

on_contracts_finalized(signed, cancelled, rejectors)

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)

Parameters
  • signed (List[Contract]) – A list of signed contracts. These are binding

  • cancelled (List[Contract]) – A list of cancelled contracts. These are not binding

  • rejectors (List[List[str]]) – 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

Return type

None

on_event(event, sender)
on_failures(failures)

Called whenever there are failures either in production or in execution of guaranteed transactions

Parameters

failures (List[Failure]) – A list of Failure s.

Return type

None

on_neg_request_accepted(req_id, mechanism)

Called when a requested negotiation is accepted

on_neg_request_accepted_(req_id, mechanism)

Called when a requested negotiation is accepted

on_neg_request_rejected(req_id, by)

Called when a requested negotiation is rejected

Parameters
  • req_id (str) – The request ID passed to _request_negotiation

  • by (Optional[List[str]]) – A list of agents that refused to participate or None if the failure was for another reason

on_neg_request_rejected_(req_id, by)

Called when a requested negotiation is rejected

Parameters
  • req_id (str) – The request ID passed to _request_negotiation

  • by (list[str] | None) – A list of agents that refused to participate or None if the failure was for another reason

on_negotiation_failure(partners, annotation, mechanism, state)

Called whenever a negotiation ends without agreement

Return type

None

on_negotiation_failure_(partners, annotation, mechanism, state)

Called whenever a negotiation ends without agreement

Return type

None

on_negotiation_success(contract, mechanism)

Called whenever a negotiation ends with agreement

Return type

None

on_negotiation_success_(contract, mechanism)

Called whenever a negotiation ends with agreement

Return type

None

on_preferences_changed(changes)

Called to inform the entity that its ufun has changed.

Parameters

changes (list[PreferencesChange]) – An ordered list of changes that happened.

Remarks:

  • You MUST call the super() version of this function either before or after your code when you are overriding it.

  • The most general form of change is PreferencesChange.General which indicates that you cannot trust anything you knew about the ufun anymore

on_simulation_step_ended()

Will be called at the end of the simulation step after everything else

on_simulation_step_started()

Will be called at the beginning of the simulation step before everything else (except init)

predict_quantity(contract)
classmethod read_config(config, section=None)

Reads the configuration from a file or a dict and prepares it for parsing

Parameters
  • config (str | dict) – Either a file name or a dictionary

  • section (Optional[str]) – A section in the file or a key in the dictionary to use for loading params

Return type

dict[str, Any]

Returns

A dict ready to be parsed by from_config

Remarks:

respond_to_negotiation_request(initiator, issues, annotation, mechanism)

Called whenever another agent requests a negotiation with this agent.

Parameters
  • initiator (str) – The ID of the agent that requested this negotiation

  • issues (List[Issue]) – Negotiation issues

  • annotation (Dict[str, Any]) – Annotation attached with this negotiation

  • mechanism (NegotiatorMechanismInterface) – The NegotiatorMechanismInterface interface to the mechanism to be used for this negotiation.

Return type

Optional[Negotiator]

Returns

None to reject the negotiation, otherwise a negotiator

respond_to_negotiation_request_(initiator, partners, issues, annotation, mechanism, role, req_id)

Called when a negotiation request is received

Return type

Negotiator | None

respond_to_renegotiation_request(contract, breaches, agenda)

Called to respond to a renegotiation request

Parameters
  • agenda (RenegotiationRequest) –

  • contract (Contract) –

  • breaches (List[Breach]) –

Returns:

Return type

Optional[Negotiator]

set_preferences(value, force=False)

Sets tha utility function/Preferences.

Parameters
  • value (Preferences | None) – The value to set to

  • force – If true, on_preferecnes_changed() will always be called even if value == self.preferences

Return type

Preferences | None

set_renegotiation_agenda(contract, breaches)

Received by partners in ascending order of their total breach levels in order to set the renegotiation agenda when contract execution fails

Parameters
  • contract (Contract) – The contract being breached

  • breaches (List[Breach]) – All breaches on contract

Return type

Optional[RenegotiationRequest]

Returns

Renegotiation agenda (issues to negotiate about to avoid reporting the breaches).

sign_all_contracts(contracts)

Signs all contracts

Return type

List[Optional[str]]

sign_contract(contract)

Called after the signing delay from contract conclusion to sign the contract. Contracts become binding only after they are signed.

Return type

str | None

classmethod spawn(spawn_as='object', spawn_params=None, *args, **kwargs)
classmethod spawn_object(*args, **kwargs)
start_negotiations(product, quantity, unit_price, step, partners=None)

Starts a set of negotiations to buy/sell the product with the given limits

Parameters
  • product (int) – product type. If it is an input product, negotiations to buy it will be started otherweise to sell.

  • quantity (int) – The maximum quantity to negotiate about

  • unit_price (int) – The maximum/minimum unit price for buy/sell

  • step (int) – The maximum/minimum time for buy/sell

  • partners (Optional[List[str]]) – A list of partners to negotiate with

Remarks:

  • This method assumes that product is either my_input_product or my_output_product

Return type

None

step()

Generates buy and sell negotiations as needed

step_()

Called at every time-step. This function is called directly by the world.

target_quantities(steps, sell)

Implemented for speed but not really required

Return type

ndarray

target_quantity(step, sell)

Returns the target quantity to sell/buy at a given time-step

Parameters
  • step (int) – Simulation step

  • sell (bool) – Sell or buy

Return type

int

to_dict()
trade_prediction_before_step()

Will be called at the beginning of every step to update the prediction

Return type

None

trade_prediction_init()

Will be called to update expected_outputs, expected_inputs, input_cost, output_cost during init()

trade_prediction_step()

Will be called at the end of every step to update the prediction

Return type

None