haive.games.among_us.configurable_config
========================================

.. py:module:: haive.games.among_us.configurable_config

.. autoapi-nested-parse::

   Configurable Among Us configuration using the generic player agent system.

   This module provides configurable Among Us game configurations that replace hardcoded
   LLM settings with dynamic, configurable player agents.



Classes
-------

.. autoapisummary::

   haive.games.among_us.configurable_config.ConfigurableAmongUsConfig


Functions
---------

.. autoapisummary::

   haive.games.among_us.configurable_config.create_among_us_config
   haive.games.among_us.configurable_config.create_among_us_config_from_example
   haive.games.among_us.configurable_config.create_among_us_config_from_player_configs
   haive.games.among_us.configurable_config.create_budget_among_us_config
   haive.games.among_us.configurable_config.create_detective_among_us_config
   haive.games.among_us.configurable_config.create_experimental_among_us_config
   haive.games.among_us.configurable_config.get_example_config
   haive.games.among_us.configurable_config.list_example_configurations


Module Contents
---------------

.. py:class:: ConfigurableAmongUsConfig

   Bases: :py:obj:`haive.games.among_us.config.AmongUsConfig`


   Configurable Among Us configuration with dynamic LLM selection.

   This configuration allows users to specify different LLMs for different
   roles in the Among Us game, providing flexibility and avoiding hardcoded models.

   .. attribute:: crewmate_model

      Model for crewmate players (can be string or LLMConfig)

   .. attribute:: impostor_model

      Model for impostor players (can be string or LLMConfig)

   .. attribute:: crewmate_player_name

      Name for the crewmate players

   .. attribute:: impostor_player_name

      Name for the impostor players

   .. attribute:: example_config

      Optional example configuration name

   .. attribute:: player_configs

      Optional detailed player configurations

   .. attribute:: temperature

      Temperature for LLM generation

   .. attribute:: max_rounds

      Maximum number of rounds before game ends

   .. attribute:: enable_analysis

      Whether to enable game state analysis

   .. attribute:: recursion_limit

      Python recursion limit for game execution


   .. py:method:: model_post_init(__context)

      Initialize engines after model creation.



.. py:function:: create_among_us_config(crewmate_model = 'gpt-4o', impostor_model = 'claude-3-5-sonnet-20240620', **kwargs)

   Create a configurable Among Us configuration with simple model specifications.

   :param crewmate_model: Model for crewmate players and analyzers
   :param impostor_model: Model for impostor players and analyzers
   :param \*\*kwargs: Additional configuration parameters

   :returns: Configured Among Us game
   :rtype: ConfigurableAmongUsConfig

   .. rubric:: Examples

   >>> config = create_among_us_config("gpt-4o", "claude-3-opus", temperature=0.5)
   >>> config = create_among_us_config(
   ...     "openai:gpt-4o",
   ...     "anthropic:claude-3-5-sonnet-20240620",
   ...     max_rounds=75
   ... )


.. py:function:: create_among_us_config_from_example(example_name, **kwargs)

   Create a configurable Among Us configuration from a predefined example.

   :param example_name: Name of the example configuration
   :param \*\*kwargs: Additional configuration parameters to override

   :returns: Configured Among Us game
   :rtype: ConfigurableAmongUsConfig

   Available examples:
       - "gpt_vs_claude": GPT crewmate vs Claude impostor
       - "gpt_only": GPT for both players
       - "claude_only": Claude for both players
       - "budget": Cost-effective models
       - "mixed": Different provider per role
       - "detective_vs_mastermind": High-powered models for intense gameplay

   .. rubric:: Examples

   >>> config = create_among_us_config_from_example("budget", max_rounds=40)
   >>> config = create_among_us_config_from_example("detective_vs_mastermind", enable_analysis=False)


.. py:function:: create_among_us_config_from_player_configs(player_configs, **kwargs)

   Create a configurable Among Us configuration from detailed player configurations.

   :param player_configs: Dictionary mapping role names to player configurations
   :param \*\*kwargs: Additional configuration parameters

   :returns: Configured Among Us game
   :rtype: ConfigurableAmongUsConfig

   Expected roles:
       - "crewmate_player": Crewmate player configuration
       - "impostor_player": Impostor player configuration
       - "crewmate_analyzer": Crewmate analyzer configuration
       - "impostor_analyzer": Impostor analyzer configuration

   .. rubric:: Examples

   >>> player_configs = {
   ...     "crewmate_player": PlayerAgentConfig(
   ...         llm_config="gpt-4o",
   ...         temperature=0.7,
   ...         player_name="Detective Crewmate"
   ...     ),
   ...     "impostor_player": PlayerAgentConfig(
   ...         llm_config="claude-3-opus",
   ...         temperature=0.3,
   ...         player_name="Stealth Impostor"
   ...     ),
   ...     "crewmate_analyzer": PlayerAgentConfig(
   ...         llm_config="gpt-4o",
   ...         temperature=0.2,
   ...         player_name="Crew Analyst"
   ...     ),
   ...     "impostor_analyzer": PlayerAgentConfig(
   ...         llm_config="claude-3-opus",
   ...         temperature=0.2,
   ...         player_name="Impostor Strategist"
   ...     ),
   ... }
   >>> config = create_among_us_config_from_player_configs(player_configs)


.. py:function:: create_budget_among_us_config(**kwargs)

   Create a budget-friendly Among Us configuration.


.. py:function:: create_detective_among_us_config(**kwargs)

   Create a detective-style Among Us configuration with powerful models.


.. py:function:: create_experimental_among_us_config(**kwargs)

   Create an experimental Among Us configuration with mixed providers.


.. py:function:: get_example_config(name)

   Get a predefined example configuration by name.

   :param name: Name of the example configuration

   :returns: The example configuration
   :rtype: ConfigurableAmongUsConfig

   :raises ValueError: If the example name is not found


.. py:function:: list_example_configurations()

   List all available example configurations.

   :returns: Mapping of configuration names to descriptions
   :rtype: Dict[str, str]