scml.oneshot.context

Module Contents

Classes

ContextParams	Basic Parameters you can assume about a context. Returned by extract_context_params
Context	A context used for generating worlds satisfying predefined conditions and testing for them
GeneralContext	A context that generates oneshot worlds with agents of a given types with predetermined structure and settings
LimitedPartnerNumbersContext	Generates a world limiting the range of the agent level, production capacity
FixedPartnerNumbersContext	Generates a world limiting the range of the agent level, production capacity
MonopolicContext	An agent that has no competitors in the same level as themselves
SingleAgentPerLevelSupplierContext	A world in which every level has exactly one factory and the agent is a supplier
EutopiaContext	An unrealistic context in which the agent is the only one in its level and all other agents are nice.
EutopiaSupplierContext	An unrealistic context in which the agent is the only supplier and all consumers are nice.
EutopiaConsumerContext	An unrealistic context in which the agent is the only consumer and all suppliers are nice.
FixedPartnerNumbersOneShotContext	Generates a world limiting the range of the agent level, production capacity
ANACContext	Generates a oneshot world with no constraints except compatibility with a specific ANAC competition year.
LimitedPartnerNumbersOneShotContext	Generates a oneshot world limiting the range of the agent level, production capacity
ANACOneShotContext	Generates a oneshot world with no constraints except compatibility with a specific ANAC competition year.
SupplierContext	A world context that can generate any world compatible with the observation manager
StrongSupplierContext	A supplier with almost many consumers relative to competitors
BalancedSupplierContext	A supplier with almost same number of consumers as competitors
WeakSupplierContext	A supplier with few consumers relative to competitors
ConsumerContext	A world context that can generate any world compatible with the observation manager
StrongConsumerContext	A consumer with almost many suppliers relative to competitors
BalancedConsumerContext	A consumer with almost same number of suppliers as competitors
WeakConsumerContext	A consumer with few suppliers relative to competitors
RepeatingContext	Encapsulates one or more configs and switches between them when asked to generate or make something.

class scml.oneshot.context.ContextParams

Basic Parameters you can assume about a context. Returned by extract_context_params

perishable: bool

nlines: int

nsuppliers: int

nconsumers: int

class scml.oneshot.context.Context

Bases: abc.ABC

A context used for generating worlds satisfying predefined conditions and testing for them

__call__(*args, **kwargs)

abstract generate(types: tuple[type[scml.oneshot.agent.OneShotAgent], Ellipsis] | None = None, params: tuple[dict[str, Any], Ellipsis] | None = None, name: str | None = None) → tuple[scml.oneshot.world.SCMLBaseWorld, tuple[scml.oneshot.agent.OneShotAgent]]

Generates a world with one or more agents to be controlled externally and returns both

Parameters:

• agent_types – The types of a list of agents to be guaranteed to exist in the world

• agent_params – The parameters to pass to the constructors of these agents. None means no parameters for any agents

• name – The name of the worlds to generate. Uses a random name if not given

Returns:

The constructed world and a tuple of the agents created corresponding (in order) to the given agent types/params

abstract is_valid_world(world: scml.oneshot.world.SCMLBaseWorld) → bool

Checks that the given world could have been generated from this context

abstract is_valid_awi(awi: scml.oneshot.awi.OneShotAWI) → bool

Checks that the given AWI is connected to a world that could have been generated from this context

abstract contains_context(context: Context) → bool

Checks that the any world generated from the given context could have been generated from this context

__contains__(other: SCMLBaseWorld | OneShotAWI | Context) → bool

class scml.oneshot.context.GeneralContext

Bases: BaseContext

A context that generates oneshot worlds with agents of a given types with predetermined structure and settings

perishable: bool = True

price_multiplier: numpy.ndarray | tuple[float, float] | float = (1.5, 2.0)

force_signing = True

n_steps: tuple[int, int] | int = (20, 200)

n_processes: tuple[int, int] | int = 2

n_lines: tuple[int, int] | int = 10

n_agents_per_process: numpy.ndarray | list[int] | tuple[int, int] | int = ()

production_costs: numpy.ndarray | tuple[int, int] | int = (1, 4)

cash_availability: tuple[float, float] | float = (1.5, 2.5)

shortfall_penalty: tuple[float, float] | float = (0.2, 1.0)

shortfall_penalty_dev: tuple[float, float] | float = (0.0, 0.1)

disposal_cost: tuple[float, float] | float = (0.0, 0.2)

disposal_cost_dev: tuple[float, float] | float = (0.0, 0.02)

storage_cost: tuple[float, float] | float = (0.0, 0.02)

storage_cost_dev: tuple[float, float] | float = 0

cost_increases_with_level = True

penalties_scale: str | list[str] = 'trading'

process_inputs: tuple[int, int] | int = 1

process_outputs: numpy.ndarray | tuple[int, int] | int = 1

exogenous_generation_method = 'profitable'

profit_means: numpy.ndarray | tuple[float, float] | float = (0.1, 0.2)

profit_stddevs: numpy.ndarray | tuple[float, float] | float = 0.05

max_productivity: numpy.ndarray | tuple[float, float] | float = (0.8, 1.0)

initial_balance: numpy.ndarray | tuple[int, int] | int | None

exogenous_supply_predictability: tuple[float, float] | float = (0.6, 0.9)

exogenous_sales_predictability: tuple[float, float] | float = (0.6, 0.9)

exogenous_control: tuple[float, float] | float

exogenous_price_dev: tuple[float, float] | float = (0.1, 0.2)

equal_exogenous_supply = False

equal_exogenous_sales = False

cap_exogenous_quantities: bool = True

__attrs_post_init__()

extract_context_params(min_values: bool, level: int | None = None) → ContextParams

make_predefined_config(agent_types: list[type[scml.oneshot.agent.OneShotAgent]], agent_processes: list[int], agent_params: list[dict[str, Any]], n_agents_per_process: list[int]) → dict[str, Any]

Generates a config for a world

contains_context(context: Context, raise_on_failure: bool = False, warn_on_failure: bool = False, n_tests: int = NTESTS) → bool

Checks that the any world generated from the given context could have been generated from this context

_assign_types(n_processes, types, params, levels, n_agents_per_process)

_distribute_agents(n_types)

make_config() → dict[str, Any]

Generates a config for a world

is_valid_world(world: scml.oneshot.world.SCMLBaseWorld, raise_on_failure: bool = False, warn_on_failure: bool = False, types: tuple[str | type[scml.oneshot.agent.OneShotAgent], Ellipsis] | None = None) → bool

Checks that the given world could have been generated from this context

contains_general_context(context: GeneralContext) → bool

Checks that the any world generated from the given context could have been generated from this context

class scml.oneshot.context.LimitedPartnerNumbersContext

Bases: GeneralContext

Generates a world limiting the range of the agent level, production capacity and the number of suppliers, consumers, and optionally same-level competitors.

level: int = 0

n_consumers: tuple[int, int]

n_suppliers: tuple[int, int] = (0, 0)

n_competitors: tuple[int, int] = ()

buying_strength: Strength | None

selling_strength: Strength | None

__attrs_post_init__()

extract_context_params(min_values: bool, level: int | None = None) → ContextParams

make_config() → dict[str, Any]

Generates a config

find_test_agents(world: scml.oneshot.world.SCMLBaseWorld, types: tuple[type[scml.oneshot.agent.OneShotAgent], Ellipsis] | None = None) → list[str]

is_valid_world(world: scml.oneshot.world.SCMLBaseWorld, types: tuple[type[scml.oneshot.agent.OneShotAgent], Ellipsis] | None = None, raise_on_failure: bool = False, warn_on_failure: bool = False) → bool

Checks that the given world could have been generated from this context

contains_limited_partner_context(context: LimitedPartnerNumbersContext, raise_on_failure: bool = False, warn_on_failure: bool = False) → bool

contains_context(context: Context, raise_on_failure: bool = False, warn_on_failure: bool = False, n_tests: int = NTESTS) → bool

Checks that the any world generated from the given context could have been generated from this context

class scml.oneshot.context.FixedPartnerNumbersContext

Bases: LimitedPartnerNumbersContext

Generates a world limiting the range of the agent level, production capacity and the number of suppliers, consumers, and optionally same-level competitors.

level: int = 0

n_consumers: int = 4

n_suppliers: int = 0

n_competitors: int = 3

__attrs_post_init__()

extract_context_params(min_values: bool, level: int | None = None) → ContextParams

class scml.oneshot.context.MonopolicContext

Bases: LimitedPartnerNumbersContext

An agent that has no competitors in the same level as themselves

n_competitors: tuple[int, int] = (0, 0)

n_agents_per_process: numpy.ndarray | list[int] | tuple[int, int] | int

__attrs_post_init__()

class scml.oneshot.context.SingleAgentPerLevelSupplierContext

Bases: MonopolicContext

A world in which every level has exactly one factory and the agent is a supplier

level: int = 0

n_consumers: tuple[int, int] = (1, 1)

n_suppliers: tuple[int, int] = (0, 0)

n_agents_per_process: numpy.ndarray | list[int] | tuple[int, int] | int

class scml.oneshot.context.EutopiaContext

Bases: MonopolicContext

An unrealistic context in which the agent is the only one in its level and all other agents are nice.

non_competitors: tuple[str | type[scml.oneshot.agent.OneShotAgent], Ellipsis]

class scml.oneshot.context.EutopiaSupplierContext

Bases: EutopiaContext

An unrealistic context in which the agent is the only supplier and all consumers are nice.

level: int

n_consumers: tuple[int, int]

n_suppliers: tuple[int, int] = (0, 0)

class scml.oneshot.context.EutopiaConsumerContext

Bases: EutopiaContext

An unrealistic context in which the agent is the only consumer and all suppliers are nice.

level: int

n_consumers: tuple[int, int] = (0, 0)

n_suppliers: tuple[int, int]

class scml.oneshot.context.FixedPartnerNumbersOneShotContext

Bases: FixedPartnerNumbersContext

Generates a world limiting the range of the agent level, production capacity and the number of suppliers, consumers, and optionally same-level competitors.

class scml.oneshot.context.ANACContext

Bases: GeneralContext

Generates a oneshot world with no constraints except compatibility with a specific ANAC competition year.

year: int = 2024

__attrs_post_init__()

class scml.oneshot.context.LimitedPartnerNumbersOneShotContext

Bases: LimitedPartnerNumbersContext

Generates a oneshot world limiting the range of the agent level, production capacity and the number of suppliers, consumers, and optionally same-level competitors.

year: int = 2024

__attrs_post_init__()

class scml.oneshot.context.ANACOneShotContext

Bases: ANACContext

Generates a oneshot world with no constraints except compatibility with a specific ANAC competition year.

__attrs_post_init__()

class scml.oneshot.context.SupplierContext(*args, **kwargs)

Bases: LimitedPartnerNumbersOneShotContext

A world context that can generate any world compatible with the observation manager

class scml.oneshot.context.StrongSupplierContext(*args, **kwargs)

Bases: SupplierContext

A supplier with almost many consumers relative to competitors

class scml.oneshot.context.BalancedSupplierContext(*args, **kwargs)

Bases: SupplierContext

A supplier with almost same number of consumers as competitors

class scml.oneshot.context.WeakSupplierContext(*args, **kwargs)

Bases: SupplierContext

A supplier with few consumers relative to competitors

class scml.oneshot.context.ConsumerContext(*args, **kwargs)

Bases: LimitedPartnerNumbersOneShotContext

A world context that can generate any world compatible with the observation manager

class scml.oneshot.context.StrongConsumerContext(*args, **kwargs)

Bases: ConsumerContext

A consumer with almost many suppliers relative to competitors

class scml.oneshot.context.BalancedConsumerContext(*args, **kwargs)

Bases: ConsumerContext

A consumer with almost same number of suppliers as competitors

class scml.oneshot.context.WeakConsumerContext(*args, **kwargs)

Bases: ConsumerContext

A consumer with few suppliers relative to competitors

class scml.oneshot.context.RepeatingContext

Bases: BaseContext

Encapsulates one or more configs and switches between them when asked to generate or make something.

configs: tuple[dict[str, Any], Ellipsis]

randomize: bool = True

rename: bool = True

_next: int

__attrs_post_init__()

extract_context_params(min_values: bool, level: int | None = None) → ContextParams

make_config(types: tuple[type[scml.oneshot.agent.OneShotAgent], Ellipsis] = DEFAULT_PLACEHOLDER_AGENT_TYPES, params: tuple[dict[str, Any], Ellipsis] | None = None) → dict[str, Any]

Generates a config for a world

classmethod from_context(context: BaseContext, n: int = 1, types: tuple[type[scml.oneshot.agent.OneShotAgent]] = DEFAULT_PLACEHOLDER_AGENT_TYPES, rename: bool = False, randomize: bool = False)

contains_repeating_context(context: RepeatingContext, raise_on_failure: bool = False, warn_on_failure: bool = False)

is_valid_world(world: scml.oneshot.world.SCMLBaseWorld, raise_on_failure=RAISE_ON_FAILURE, warn_on_failure=WARN_ON_FAILURE, types: tuple[str | type[scml.oneshot.agent.OneShotAgent], Ellipsis] | None = None) → bool

Checks that the given world could have been generated from this context

contains_context(context: Context, raise_on_failure: bool = False, warn_on_failure: bool = False, n_tests: int = NTESTS) → bool

Checks that the any world generated from the given context could have been generated from this context