CARNegotiator

class negmas.gb.CARNegotiator(*args, **kwargs)

Bases: MAPNegotiator

Conceding Accepting Rational Strategy (neither complete nor an equilibrium)

Parameters:

• name – Negotiator name

• parent – Parent controller if any

• preferences – The preferences of the negotiator

• ufun – The ufun of the negotiator (overrides prefrences)

• owner – The Agent that owns the negotiator.

Attributes Summary

ami
annotation	Returns the private information (annotation) not shared with other negotiators
capabilities	Agent capabilities
components
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?
has_ufun	Does the entity has an associated ufun?
id	The unique ID of this entity
name	A convenient name of the entity (intended primarily for printing/logging/debugging).
nmi
opponent_ufun
owner	Returns the owner agent of the negotiator
parent	Returns the parent controller
preferences	The utility function attached to that object
private_info	Returns the private information (annotation) not shared with other negotiators
prob_ufun	Returns the preferences if it is a ProbUtilityFunction else None
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.
short_type_name
type_name
ufun	Returns the preferences if it is a BaseUtilityFunction else None
uuid	The unique ID of this entity

Methods Summary

__call__(state[, dest])	Called by the mechanism to counter the offer.
add_capabilities(capabilities)	Adds named capabilities to the negotiator.
add_handler(notification_type, callback)	Adds a notification handler to the list of handlers of the given type.
before_death(cntxt)	Called whenever the parent is about to kill this negotiator.
cancel([reason])	A method that may be called by a mechanism to make the negotiator cancel whatever it is currently processing.
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
create(*args, **kwargs)	Creates an object and returns a proxy to it.
from_checkpoint(file_name[, return_info])	Creates an object from a saved checkpoint
generate_proposal(state[, dest])
generate_response(state, offer[, source])
handlers(notification_type)	Gets the list of handlers registered for some notification type.
insert_component(component[, name, index, ...])	Adds a component at the given index.
is_acceptable_as_agreement(outcome)	Whether the given outcome is acceptable as a final agreement of a negotiation.
isin(negotiation_id)	Is that agent participating in the given negotiation? Tests if the agent is participating in the given negotiation.
join(nmi, state, *[, preferences, ufun, role])	Called by the mechanism when the agent is about to enter a negotiation.
on_leave(state)	A call back called after leaving a negotiation.
on_mechanism_error(state)	A call back called whenever an error happens in the mechanism.
on_negotiation_end(state)	A call back called at each negotiation end
on_negotiation_start(state)	A call back called at each negotiation start
on_notification(notification, notifier)	Called whenever the agent receives a notification
on_notification_(notification, notifier)	Called when a notification is received.
on_partner_ended(partner)	Called when a partner ends the negotiation.
on_partner_joined(partner)	Called when a partner joins the negotiation.
on_partner_left(partner)	Called when a partner leaves the negotiation.
on_partner_proposal(state, partner_id, offer)	A callback called by the mechanism when a partner proposes something
on_partner_response(state, partner_id, ...)	A callback called by the mechanism when a partner responds to some offer
on_preferences_changed(changes)	Called to inform the component that the ufun has changed and the kinds of change that happened.
on_round_end(state)	A call back called at each negotiation round end
on_round_start(state)	A call back called at each negotiation round start
propose(state[, dest])	Propose an offer or None to refuse.
propose_(state[, dest])
remove_capability(name)	Removes named capability from the negotiator
remove_component(name)	Removes the component with the given name
remove_component_at(index)	Removes the component at the givne index.
remove_handler(notification_type, callback)	Removes a notification handler from the list of handlers of the given type.
respond(state[, source])	Called to respond to an offer.
respond_(state[, source])
set_id(id)	Sets the unique ID of this entity
set_preferences(value[, force, ...])	Sets the utility function/Preferences.
spawn([spawn_as, spawn_params])
spawn_object(*args, **kwargs)

Attributes Documentation

ami

annotation

Returns the private information (annotation) not shared with other negotiators

capabilities

Agent capabilities

components

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?

has_ufun

Does the entity has an associated ufun?

id

The unique ID of this entity

name

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

nmi

opponent_ufun

owner

Returns the owner agent of the negotiator

parent

Returns the parent controller

preferences

The utility function attached to that object

private_info

Returns the private information (annotation) not shared with other negotiators

prob_ufun

Returns the preferences if it is a ProbUtilityFunction else None

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

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.

short_type_name

type_name

ufun

Returns the preferences if it is a BaseUtilityFunction else None

uuid

The unique ID of this entity

Methods Documentation

__call__(state: SAOState, dest: str | None = None) → SAOResponse

Called by the mechanism to counter the offer. It just calls respond_ and propose_ as needed.

Parameters:

• state – SAOState giving current state of the negotiation.

• dest – The partner to respond to with a counter offer (for AOP, SAOP, MAOP this can safely be ignored).

Returns:

The response to the given offer with a counter offer if the response is REJECT

Return type:

Tuple[ResponseType, Outcome]

add_capabilities(capabilities: dict) → None

Adds named capabilities to the negotiator.

Parameters:

capabilities – The capabilities to be added as a dict

Returns:

None

Remarks:

It is the responsibility of the caller to be really capable of added capabilities.

add_handler(notification_type: str, callback: Callable[[Notification, str], bool])

Adds a notification handler to the list of handlers of the given type. These handlers will be called in the order in which they are received

Parameters:

• notification_type – Notification type as specificed in the type member of the Notification class

• callback – The callback which must receive a Notification object and a string and returns a boolean. If True is returned from one callback, the remaining callbacks will not be called

Returns:

before_death(cntxt: dict[str, Any]) → bool

Called whenever the parent is about to kill this negotiator.

It should return False if the negotiator does not want to be killed but the controller can still force-kill it

cancel(reason=None) → None

A method that may be called by a mechanism to make the negotiator cancel whatever it is currently processing.

Negotiators can just ignore this message (default behavior) but if there is a way to actually cancel work, it should be implemented here to improve the responsiveness of the negotiator.

checkpoint(path: PathLike, file_name: str | None = None, info: dict[str, Any] | None = None, exist_ok: bool = False, single_checkpoint: bool = True, step_attribs: tuple[str, ...] = ('current_step', '_current_step', '_Entity__current_step', '_step')) → Path

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

Parameters:

• path – Full path to a directory to store the checkpoint

• file_name – Name of the file to dump into. If not given, a unique name is created

• info – Information to save with the checkpoint (must be json serializable)

• exist_ok – If true, override existing dump

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

• step_attribs – 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

Returns:

full path to the file used to save the checkpoint

classmethod checkpoint_info(file_name: Path | str) → dict[str, Any]

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

Parameters:

file_name – Name of the object

Returns:

classmethod create(*args, **kwargs)

Creates an object and returns a proxy to it.

classmethod from_checkpoint(file_name: Path | str, return_info: bool = False) → NamedObject | tuple[NamedObject, dict[str, Any]]

Creates an object from a saved checkpoint

Parameters:

• file_name

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

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

generate_proposal(state: GBState, dest: str | None = None) → Outcome | None

generate_response(state: GBState, offer: Outcome | None, source: str | None = None) → ResponseType

handlers(notification_type: str) → list[Callable[[Notification, str], bool]]

Gets the list of handlers registered for some notification type. This list can be modified in place to change the order of handlers for example. It is NOT a copy.

insert_component(component: Component, name: str | None = None, index: int = -1, override: bool = False) → None

Adds a component at the given index. If a negative number is given, appends at the end

is_acceptable_as_agreement(outcome: Outcome) → bool

Whether the given outcome is acceptable as a final agreement of a negotiation.

The default behavior is to reject only if a reserved value is defined for the agent and is known to be higher than the utility of the outcome.

isin(negotiation_id: str | None) → bool

Is that agent participating in the given negotiation? Tests if the agent is participating in the given negotiation.

Parameters:

negotiation_id (Optional[str]) – The negotiation ID tested. If None, it means ANY negotiation

Returns:

True if participating in the given negotiation (or any

negotiation if it was None)

Return type:

bool

join(nmi: NegotiatorMechanismInterface, state: MechanismState, *, preferences: Preferences | None = None, ufun: BaseUtilityFunction | None = None, role: str = 'negotiator') → bool

Called by the mechanism when the agent is about to enter a negotiation. It can prevent the agent from entering

Parameters:

• nmi – The negotiation.

• state – The current state of the negotiation

• preferences – The preferences used by the negotiator (see ufun )

• ufun – The ufun function to use (overrides preferences )

• role – role of the negotiator.

Returns:

bool indicating whether or not the agent accepts to enter. If False is returned it will not enter the negotiation

Remarks:

• Joining a neogiation will fail in the following conditions:

  1. The negotiator already has preferences and is asked to join with new ones

  2. The negotiator is already in a negotiation

on_leave(state: MechanismState) → None

A call back called after leaving a negotiation.

on_mechanism_error(state: MechanismState) → None

A call back called whenever an error happens in the mechanism. The error and its explanation are accessible in state

on_negotiation_end(state: MechanismState) → None

A call back called at each negotiation end

on_negotiation_start(state: MechanismState) → None

A call back called at each negotiation start

on_notification(notification: Notification, notifier: str)

Called whenever the agent receives a notification

Parameters:

• notification – The notification!!

• notifier – The notifier!!

Returns:

None

Remarks:

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

on_notification_(notification: Notification, notifier: str) → bool

Called when a notification is received. Do NOT directly override this method

Parameters:

• notification

• notifier

Returns:

on_partner_ended(partner: str)

Called when a partner ends the negotiation.

Note that the negotiator owning this component may never receive this offer. This is only receivd if the mechanism is sending notifications on every offer.

on_partner_joined(partner: str)

Called when a partner joins the negotiation.

This is only receivd if the mechanism is sending notifications.

on_partner_left(partner: str)

Called when a partner leaves the negotiation.

This is only receivd if the mechanism is sending notifications.

on_partner_proposal(state: GBState, partner_id: str, offer: Outcome) → None

A callback called by the mechanism when a partner proposes something

Parameters:

• state – GBState giving the state of the negotiation when the offer was porposed.

• partner_id – The ID of the agent who proposed

• offer – The proposal.

Remarks:

• Will only be called if enable_callbacks is set for the mechanism

on_partner_response(state: GBState, partner_id: str, outcome: Outcome, response: ResponseType) → None

A callback called by the mechanism when a partner responds to some offer

Parameters:

• state – GBState giving the state of the negotiation when the partner responded.

• partner_id – The ID of the agent who responded

• outcome – The proposal being responded to.

• response – The response

Remarks:

• Will only be called if enable_callbacks is set for the mechanism

on_preferences_changed(changes: list[PreferencesChange])

Called to inform the component that the ufun has changed and the kinds of change that happened.

on_round_end(state: MechanismState) → None

A call back called at each negotiation round end

on_round_start(state: MechanismState) → None

A call back called at each negotiation round start

propose(state: GBState, dest: str | None = None) → Outcome | None

Propose an offer or None to refuse.

Parameters:

state – GBState giving current state of the negotiation.

Returns:

The outcome being proposed or None to refuse to propose

Remarks:

• This function guarantees that no agents can propose something with a utility value

propose_(state: SAOState, dest: str | None = None) → Outcome | ExtendedOutcome | None

remove_capability(name: str) → None

Removes named capability from the negotiator

Parameters:

capabilities – The capabilities to be added as a dict

Returns:

None

Remarks:

It is the responsibility of the caller to be really capable of added capabilities.

remove_component(name: str) → None

Removes the component with the given name

remove_component_at(index: int) → None

Removes the component at the givne index.

remove_handler(notification_type: str, callback: Callable[[Notification, str], bool]) → bool

Removes a notification handler from the list of handlers of the given type.

Parameters:

• notification_type – Notification type as specificed in the type member of the Notification class

• callback – The callback which must receive a Notification object and a string and returns a boolean. If True is returned from one callback, the remaining callbacks will not be called

Returns:

Whether or not the handler was in the list of handlers for this type. In all cases, the handler will not be called after this call (either it was not there or it will be removed).

respond(state: GBState, source: str | None = None) → ResponseType

Called to respond to an offer. This is the method that should be overriden to provide an acceptance strategy.

Parameters:

state – a GBState giving current state of the negotiation.

Returns:

The response to the offer

Return type:

ResponseType

Remarks:

• The default implementation never ends the negotiation

• The default implementation asks the negotiator to propose`() and accepts the `offer if its utility was at least as good as the offer that it would have proposed (and above the reserved value).

• Current offer is accessible through state.threads[source].current_offer as long as source != None otherwise it is None

respond_(state: SAOState, source: str | None = None) → ResponseType

set_id(id: str)

Sets the unique ID of this entity

set_preferences(value: Preferences | None, force=False, ignore_exceptions: bool = False) → Preferences | None

Sets the utility function/Preferences.

Parameters:

• value – The value to set to

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

classmethod spawn(spawn_as='object', spawn_params: dict[str, Any] | None = None, *args, **kwargs)

classmethod spawn_object(*args, **kwargs)