IndependentNegotiationsAgent¶
-
class
scml.scml2020.
IndependentNegotiationsAgent
(*args, negotiator_type=<class 'negmas.sao.AspirationNegotiator'>, negotiator_params=None, horizon=5, **kwargs)[source]¶ Bases:
scml.DoNothingAgent
Implements the base class for agents that negotiate independently with different partners.
These agents do not take production capacity, availability of materials or any other aspects of the simulation into account. They are to serve only as baselines.
- Parameters
negotiator_type (
Union
[SAONegotiator
,str
]) – The type of the negotiator to use. The default isAspirationNegotiator
negotiator_params (
Optional
[Dict
[str
,Any
]]) – key-value pairs to pass to the constructor of negotiatorshorizon – The number of production step to handle together using a single set of negotiations. See
step
for details
Remarks:
IndependentNegotiationsAgent
agents assume that each production process has one input type with the sameindex as itself and one output type with one added to the index (i.e. process $i$ takes product $i$ as input and creates product $i+1$ as output.
It does not assume that all lines have the same production cost (it uses the average cost though).
It does not assume that the agent has a single production process.
Attributes Summary
A list of negotiation requests sent to this agent that are already accepted by it.
Gets the Agent-world interface.
The unique ID of this entity
Was the agent initialized (i.e.
A convenient name of the entity (intended primarily for printing/logging/debugging).
A list of the negotiation requests sent by this agent that are not yet accepted or rejected.
The negotiations currently requested by the agent.
The negotiations currently requested by the agent.
Returns a short name of the type of this entity
Returns the name of the type of this entity
All contracts that are not yet signed.
The unique ID of this entity
Methods Summary
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_exogenous_sales
(quantities, unit_prices)Called to confirm the amount of guaranteed sales the agent is willing to accept
confirm_exogenous_supplies
(quantities, …)Called to confirm the amount of guaranteed supplies the agent is willing to accept
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 IDcreate_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
()Initializes the agent by finding the average production cost.
init_
()Called to initialize the agent after the world is initialized.
negotiator
(is_seller[, issues, outcomes])Creates a negotiator
notify
(notifiable, notification)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_nullified
(contract, …)Called whenever a contract is nullified (because the partner is bankrupt)
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
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_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)Called to sign all contracts concluded in a single step by this agent
sign_contract
(contract)Called after the signing delay from contract conclusion to sign the contract.
start_negotiations
(product, quantity, …)Starts a set of negotiations to by/sell the product with the given limits
step
()Every
horizon
steps, create new negotiations based on external supplies and sales.step_
()Called at every time-step.
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
[NegotiationInfo
]
-
awi
¶ Gets the Agent-world interface.
- Return type
AgentWorldInterface
-
id
¶ The unique ID of this entity
-
initialized
¶ Was the agent initialized (i.e. was init_() called)
- Return type
bool
-
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
[NegotiationInfo
]
-
requested_negotiations
¶ The negotiations currently requested by the agent.
- Return type
List
[NegotiationRequestInfo
]- Returns
A list of negotiation request information objects (
NegotiationRequestInfo
)
-
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
-
unsigned_contracts
¶ All contracts that are not yet signed.
- Return type
List
[Contract
]
-
uuid
¶ The unique ID of this entity
Methods Documentation
-
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 (
Union
[Path
,str
]) – Full path to a directory to store the checkpointfile_name (
Optional
[str
]) – Name of the file to dump into. If not given, a unique name is createdinfo (
Optional
[Dict
[str
,Any
]]) – Information to save with the checkpoint (must be json serializable)exist_ok (
bool
) – If true, override existing dumpsingle_checkpoint (
bool
) – If true, keep a single checkpoint for the last stepstep_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 (
Union
[str
,Path
]) – Name of the object
Returns:
- Return type
Dict
[str
,Any
]
-
confirm_exogenous_sales
(quantities, unit_prices)[source]¶ Called to confirm the amount of guaranteed sales the agent is willing to accept
- Parameters
quantities (
ndarray
) – An n_products vector giving the maximum quantity that can sold (without negotiation)unit_prices (
ndarray
) – An n_products vector giving the guaranteed unit prices
- Return type
ndarray
- Returns
An n_products vector specifying the quantities to be sold (up to the given
quantities
limit).
-
confirm_exogenous_supplies
(quantities, unit_prices)[source]¶ Called to confirm the amount of guaranteed supplies the agent is willing to accept
- Parameters
quantities (
ndarray
) – An n_products vector giving the maximum quantity that can bought (without negotiation)unit_prices (
ndarray
) – An n_products vector giving the guaranteed unit prices
- Return type
ndarray
- Returns
An n_products vector specifying the quantities to be bought (up to the given
quantities
limit).
-
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 processedbalance (
int
) – The current balance of the factoryinventory – 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:
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 issuespartners (
List
[str
]) – partnersannotation (
Optional
[Dict
[str
,Any
]]) – annotationnegotiator (
Optional
[Negotiator
]) – the negotiator to useextra (
Optional
[Dict
[str
,Any
]]) – any extra information
- Return type
str
- Returns
A unique identifier for this negotiation info structure
-
classmethod
from_checkpoint
(file_name, return_info=False)¶ Creates an object from a saved checkpoint
- Parameters
file_name (
Union
[str
,Path
]) –return_info – If True, tbe information saved when the file was dumped are returned
- Return type
Union
[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 (
Union
[str
,dict
]) – Either a file name or a dictionarysection (
Optional
[str
]) – A section in the file or a key in the dictionary to use for loading paramsignore_children (
bool
) – If true then children will be ignored and there will be a single returntry_parsing_children (
bool
) – If true the children will first be parsed asConfigReader
classes if they are nottypes (e.g. int, str, float, Iterable[int|str|float] (simple) –
scope – The scope at which to evaluate any child classes. This MUST be passed as scope=globals() if you are
any children that are to be parsed. (having) –
- 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.
-
negotiator
(is_seller, issues=None, outcomes=None)[source]¶ Creates a negotiator
- Return type
SAONegotiator
-
notify
(notifiable, notification)¶
-
on_contract_breached
(contract, breaches, resolution)¶ Called after complete processing of a contract that involved a breach.
- Parameters
contract (
Contract
) – The contractbreaches (
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_nullified
(contract, compensation_money, new_quantity)¶ Called whenever a contract is nullified (because the partner is bankrupt)
- Parameters
contract (
Contract
) – The contract being nullifiedcompensation_money (
int
) – The compensation money that is already added to the agent’s walletnew_quantity (
int
) – The new quantity that will actually be executed for this contract at its delivery time.
Remarks:
compensation_money and new_quantity will never be both nonzero
compensation_money and new_quantity may both be zero which means that the contract will be cancelled without compensation
compensation_money will be nonzero iff immediate_compensation is enabled for this world
- 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)[source]¶ 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 bindingcancelled (
List
[Contract
]) – A list of cancelled contracts. These are not bindingrejectors (
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 andon_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 ofFailure
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_negotiationby (
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_negotiationby (
Optional
[List
[str
]]) – 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
-
classmethod
read_config
(config, section=None)¶ Reads the configuration from a file or a dict and prepares it for parsing
- Parameters
config (
Union
[str
,dict
]) – Either a file name or a dictionarysection (
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)[source]¶ Called whenever another agent requests a negotiation with this agent.
- Parameters
initiator (
str
) – The ID of the agent that requested this negotiationissues (
List
[Issue
]) – Negotiation issuesannotation (
Dict
[str
,Any
]) – Annotation attached with this negotiationmechanism (
AgentMechanismInterface
) – TheAgentMechanismInterface
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
Optional
[Negotiator
]
-
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_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 breachedbreaches (
List
[Breach
]) – All breaches oncontract
- Return type
Optional
[RenegotiationRequest
]- Returns
Renegotiation agenda (issues to negotiate about to avoid reporting the breaches).
-
sign_all_contracts
(contracts)[source]¶ 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 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
Optional
[str
]
-
start_negotiations
(product, quantity, unit_price, time, to_buy)[source]¶ Starts a set of negotiations to by/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 aboutunit_price (
int
) – The maximum/minimum unit price for buy/selltime (
int
) – The maximum/minimum time for buy/sellto_buy (
bool
) – Is the negotiation to buy or to sell
Remarks:
This method assumes that products cannot be in my_input_products and my_output_products
- Return type
None
-
step_
()¶ Called at every time-step. This function is called directly by the world.