negmas.situated Package

Functions

save_stats(world, log_dir[, params, ...])

Saves the statistics of a world run.

show_edge_colors()

Plots the edge colors used with their meaning

Classes

Operations(value)

An enumeration.

RunningNegotiationInfo(negotiator, ...)

Keeps track of running negotiations for an agent

NegotiationInfo(mechanism, partners, ...[, ...])

Saves information about a negotiation

NegotiationRequestInfo(partners, issues, ...)

Keeps track to negotiation requests that an agent sent

Action(type, params)

An action that an Agent can execute in a World through the Simulator.

Contract([partners, agreement, annotation, ...])

A agreement definition which encapsulates an agreement with partners and extra information

Breach(contract, perpetrator, type[, ...])

BreachProcessing(value)

The way breaches are to be handled

Agent([name, type_postfix, preferences, ufun])

Base class for all agents that can run within a World and engage in situated negotiations

Adapter(obj[, include_adapter_type_name, ...])

Represents an adapter agent that makes some included object act as an agent in some world.

BulletinBoard()

The bulletin-board which carries all public information.

World([bulletin_board, n_steps, time_limit, ...])

Base world class encapsulating a world that runs a simulation with several agents interacting within some dynamically changing environment.

Entity([type_postfix])

Defines an entity that is a part of the world but does not participate in the simulation

AgentWorldInterface(world, agent)

Agent World Interface class

NegotiationInfo(mechanism, partners, ...[, ...])

Saves information about a negotiation

RenegotiationRequest(publisher, issues[, ...])

A request for renegotiation.

StatsMonitor([type_postfix])

A monitor object capable of receiving stats of a world

WorldMonitor([type_postfix])

A monitor object capable of monitoring a world.

SimpleWorld([bulletin_board, n_steps, ...])

Represents a simple world simulation with sane values for most callbacks and methods.

NoContractExecutionMixin()

A mixin to add when there is no contract execution

TimeInAgreementMixin()

NoResponsesMixin()

A mixin that can be added to Agent to minimize the number of abstract methods

NegWorld(*args, domain, types[, params, ...])

A world that runs a list of negotiators in a given domain to evaluate them

NegAgent(*args, negotiator_type[, ...])

Wraps a negotiator for evaluaton

NegDomain(name, issues, ufuns, partner_types)

A representation of a negotiation domain in which a negotiator can be evaluated

Class Inheritance Diagram

digraph inheritance7cb3f27120 { bgcolor=transparent; fontsize=11; randkir=TB; rankdir=LR; size=""; "ABC" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Helper class that provides a standard way to create an ABC using"]; "Action" [URL="../../api/negmas.situated.Action.html#negmas.situated.Action",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An action that an `Agent` can execute in a `World` through the `Simulator`."]; "Adapter" [URL="../../api/negmas.situated.Adapter.html#negmas.situated.Adapter",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents an adapter agent that makes some included object act as an"]; "Agent" -> "Adapter" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Agent" [URL="../../api/negmas.situated.Agent.html#negmas.situated.Agent",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for all agents that can run within a `World` and engage in situated negotiations"]; "Entity" -> "Agent" [arrowsize=0.5,style="setlinewidth(0.5)"]; "EventSink" -> "Agent" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ConfigReader" -> "Agent" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Notifier" -> "Agent" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Rational" -> "Agent" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ABC" -> "Agent" [arrowsize=0.5,style="setlinewidth(0.5)"]; "AgentWorldInterface" [URL="../../api/negmas.situated.AgentWorldInterface.html#negmas.situated.AgentWorldInterface",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Agent World Interface class"]; "Breach" [URL="../../api/negmas.situated.Breach.html#negmas.situated.Breach",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Breach(contract: 'Contract', perpetrator: 'str', type: 'str', victims: 'List[str]' = <factory>, level: 'float' = 1.0, step: 'int' = -1, id: 'str' = <factory>)"]; "BreachProcessing" [URL="../../api/negmas.situated.BreachProcessing.html#negmas.situated.BreachProcessing",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The way breaches are to be handled"]; "Enum" -> "BreachProcessing" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BulletinBoard" [URL="../../api/negmas.situated.BulletinBoard.html#negmas.situated.BulletinBoard",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The bulletin-board which carries all public information. It consists of sections each with a dictionary of records."]; "EventSource" -> "BulletinBoard" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ConfigReader" -> "BulletinBoard" [arrowsize=0.5,style="setlinewidth(0.5)"]; "CheckpointMixin" [URL="../../api/negmas.checkpoints.CheckpointMixin.html#negmas.checkpoints.CheckpointMixin",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Adds the ability to save checkpoints to a `NamedObject`"]; "ConfigReader" [URL="../../api/negmas.helpers.ConfigReader.html#negmas.helpers.ConfigReader",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Contract" [URL="../../api/negmas.situated.Contract.html#negmas.situated.Contract",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A agreement definition which encapsulates an agreement with partners and extra information"]; "Entity" [URL="../../api/negmas.situated.Entity.html#negmas.situated.Entity",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Defines an entity that is a part of the world but does not participate in the simulation"]; "Enum" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Generic enumeration."]; "EventSink" [URL="../../api/negmas.events.EventSink.html#negmas.events.EventSink",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An object capable of receiving events"]; "EventSource" [URL="../../api/negmas.events.EventSource.html#negmas.events.EventSource",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An object capable of raising events"]; "NamedObject" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="The base class of all named entities."]; "NegAgent" [URL="../../api/negmas.situated.NegAgent.html#negmas.situated.NegAgent",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Wraps a negotiator for evaluaton"]; "Agent" -> "NegAgent" [arrowsize=0.5,style="setlinewidth(0.5)"]; "NegDomain" [URL="../../api/negmas.situated.NegDomain.html#negmas.situated.NegDomain",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A representation of a negotiation domain in which a negotiator can be evaluated"]; "NegWorld" [URL="../../api/negmas.situated.NegWorld.html#negmas.situated.NegWorld",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A world that runs a list of negotiators in a given domain to evaluate them"]; "NoContractExecutionMixin" -> "NegWorld" [arrowsize=0.5,style="setlinewidth(0.5)"]; "World" -> "NegWorld" [arrowsize=0.5,style="setlinewidth(0.5)"]; "NegotiationInfo" [URL="../../api/negmas.situated.NegotiationInfo.html#negmas.situated.NegotiationInfo",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Saves information about a negotiation"]; "NegotiationRequestInfo" [URL="../../api/negmas.situated.NegotiationRequestInfo.html#negmas.situated.NegotiationRequestInfo",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="NegotiationRequestInfo(partners, issues, annotation, uuid, negotiator, requested, extra)"]; "NoContractExecutionMixin" [URL="../../api/negmas.situated.NoContractExecutionMixin.html#negmas.situated.NoContractExecutionMixin",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A mixin to add when there is no contract execution"]; "NoResponsesMixin" [URL="../../api/negmas.situated.NoResponsesMixin.html#negmas.situated.NoResponsesMixin",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A mixin that can be added to Agent to minimize the number of abstract methods"]; "Notifier" [URL="../../api/negmas.events.Notifier.html#negmas.events.Notifier",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An object that can notify other objects"]; "NamedObject" -> "Notifier" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Operations" [URL="../../api/negmas.situated.Operations.html#negmas.situated.Operations",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An enumeration."]; "Enum" -> "Operations" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Rational" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="A rational object is an object that can have preferences."]; "NamedObject" -> "Rational" [arrowsize=0.5,style="setlinewidth(0.5)"]; "RenegotiationRequest" [URL="../../api/negmas.situated.RenegotiationRequest.html#negmas.situated.RenegotiationRequest",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A request for renegotiation."]; "RunningNegotiationInfo" [URL="../../api/negmas.situated.RunningNegotiationInfo.html#negmas.situated.RunningNegotiationInfo",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="RunningNegotiationInfo(negotiator, annotation, uuid, extra, my_request)"]; "SimpleWorld" [URL="../../api/negmas.situated.SimpleWorld.html#negmas.situated.SimpleWorld",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a simple world simulation with sane values for most callbacks and methods."]; "World" -> "SimpleWorld" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ABC" -> "SimpleWorld" [arrowsize=0.5,style="setlinewidth(0.5)"]; "StatsMonitor" [URL="../../api/negmas.situated.StatsMonitor.html#negmas.situated.StatsMonitor",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A monitor object capable of receiving stats of a world"]; "Entity" -> "StatsMonitor" [arrowsize=0.5,style="setlinewidth(0.5)"]; "TimeInAgreementMixin" [URL="../../api/negmas.situated.TimeInAgreementMixin.html#negmas.situated.TimeInAgreementMixin",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "World" [URL="../../api/negmas.situated.World.html#negmas.situated.World",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base world class encapsulating a world that runs a simulation with several agents interacting within some"]; "EventSink" -> "World" [arrowsize=0.5,style="setlinewidth(0.5)"]; "EventSource" -> "World" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ConfigReader" -> "World" [arrowsize=0.5,style="setlinewidth(0.5)"]; "NamedObject" -> "World" [arrowsize=0.5,style="setlinewidth(0.5)"]; "CheckpointMixin" -> "World" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ABC" -> "World" [arrowsize=0.5,style="setlinewidth(0.5)"]; "WorldMonitor" [URL="../../api/negmas.situated.WorldMonitor.html#negmas.situated.WorldMonitor",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A monitor object capable of monitoring a world. It has read/write access to the world"]; "Entity" -> "WorldMonitor" [arrowsize=0.5,style="setlinewidth(0.5)"]; }