haive.games.fox_and_geese.configurable_config
=============================================

.. py:module:: haive.games.fox_and_geese.configurable_config

.. autoapi-nested-parse::

   Configurable FoxAndGeese configuration using the generic player agent system.

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



Classes
-------

.. autoapisummary::

   haive.games.fox_and_geese.configurable_config.ConfigurableFoxAndGeeseConfig


Functions
---------

.. autoapisummary::

   haive.games.fox_and_geese.configurable_config.create_advanced_fox_and_geese_config
   haive.games.fox_and_geese.configurable_config.create_budget_fox_and_geese_config
   haive.games.fox_and_geese.configurable_config.create_experimental_fox_and_geese_config
   haive.games.fox_and_geese.configurable_config.create_fox_and_geese_config
   haive.games.fox_and_geese.configurable_config.create_fox_and_geese_config_from_example
   haive.games.fox_and_geese.configurable_config.create_fox_and_geese_config_from_player_configs
   haive.games.fox_and_geese.configurable_config.get_example_config
   haive.games.fox_and_geese.configurable_config.list_example_configurations


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

.. py:class:: ConfigurableFoxAndGeeseConfig

   Bases: :py:obj:`haive.games.fox_and_geese.config.FoxAndGeeseConfig`


   Configurable FoxAndGeese configuration with dynamic LLM selection.

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

   .. attribute:: fox_model

      Model for fox (can be string or LLMConfig)

   .. attribute:: geese_model

      Model for geese (can be string or LLMConfig)

   .. attribute:: fox_name

      Name for fox

   .. attribute:: geese_name

      Name for geese

   .. attribute:: example_config

      Optional example configuration name

   .. attribute:: player_configs

      Optional detailed player configurations

   .. attribute:: temperature

      Temperature for LLM generation

   .. attribute:: enable_analysis

      Whether to enable strategic analysis

   .. attribute:: visualize_game

      Whether to visualize game state

   .. attribute:: recursion_limit

      Python recursion limit for game execution


   .. py:method:: model_post_init(__context)

      Initialize engines after model creation.



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

   Create an advanced FoxAndGeese configuration with powerful models.


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

   Create a budget-friendly FoxAndGeese configuration.


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

   Create an experimental FoxAndGeese configuration with mixed providers.


.. py:function:: create_fox_and_geese_config(fox_model = 'gpt-4o', geese_model = 'claude-3-5-sonnet-20240620', **kwargs)

   Create a configurable FoxAndGeese configuration with simple model specifications.

   :param fox_model: Model for fox and analyzer
   :param geese_model: Model for geese and analyzer
   :param \*\*kwargs: Additional configuration parameters

   :returns: Configured FoxAndGeese game
   :rtype: ConfigurableFoxAndGeeseConfig

   .. rubric:: Examples

   >>> config = create_fox_and_geese_config("gpt-4o", "claude-3-opus", temperature=0.5)
   >>> config = create_fox_and_geese_config(
   ...     "openai:gpt-4o",
   ...     "anthropic:claude-3-5-sonnet-20240620",
   ...     enable_analysis=True
   ... )


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

   Create a configurable FoxAndGeese configuration from a predefined example.

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

   :returns: Configured FoxAndGeese game
   :rtype: ConfigurableFoxAndGeeseConfig

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

   .. rubric:: Examples

   >>> config = create_fox_and_geese_config_from_example("budget", enable_analysis=False)
   >>> config = create_fox_and_geese_config_from_example("advanced", visualize_game=True)


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

   Create a configurable FoxAndGeese configuration from detailed player.
   configurations.

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

   :returns: Configured FoxAndGeese game
   :rtype: ConfigurableFoxAndGeeseConfig

   Expected roles:
       - "fox_player": Player 1 configuration
       - "geese_player": Player 2 configuration
       - "fox_analyzer": Player 1 analyzer configuration
       - "geese_analyzer": Player 2 analyzer configuration

   .. rubric:: Examples

   >>> player_configs = {
   ...     "fox_player": PlayerAgentConfig(
   ...         llm_config="gpt-4o",
   ...         temperature=0.7,
   ...         player_name="Strategic Fox"
   ...     ),
   ...     "geese_player": PlayerAgentConfig(
   ...         llm_config="claude-3-opus",
   ...         temperature=0.3,
   ...         player_name="Tactical Geese"
   ...     ),
   ...     "fox_analyzer": PlayerAgentConfig(
   ...         llm_config="gpt-4o",
   ...         temperature=0.2,
   ...         player_name="FoxAndGeese Strategist"
   ...     ),
   ...     "geese_analyzer": PlayerAgentConfig(
   ...         llm_config="claude-3-opus",
   ...         temperature=0.2,
   ...         player_name="FoxAndGeese Analyst"
   ...     ),
   ... }
   >>> config = create_fox_and_geese_config_from_player_configs(player_configs)


.. 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: ConfigurableFoxAndGeeseConfig

   :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]