haive.games.battleship.generic_engines
======================================

.. py:module:: haive.games.battleship.generic_engines

.. autoapi-nested-parse::

   Generic Battleship engine creation using the generic player agent system.

   This module provides generic engine creation functions for Battleship games, allowing
   for configurable LLM models and game-specific player identifiers.



Classes
-------

.. autoapisummary::

   haive.games.battleship.generic_engines.BattleshipEngineFactory
   haive.games.battleship.generic_engines.BattleshipPlayerIdentifiers
   haive.games.battleship.generic_engines.BattleshipPromptGenerator


Functions
---------

.. autoapisummary::

   haive.games.battleship.generic_engines.create_budget_battleship_engines
   haive.games.battleship.generic_engines.create_generic_battleship_config_from_example
   haive.games.battleship.generic_engines.create_generic_battleship_engines
   haive.games.battleship.generic_engines.create_generic_battleship_engines_simple
   haive.games.battleship.generic_engines.create_mixed_battleship_engines
   haive.games.battleship.generic_engines.create_naval_battleship_engines


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

.. py:class:: BattleshipEngineFactory

   Bases: :py:obj:`haive.games.core.agent.generic_player_agent.GenericGameEngineFactory`\ [\ :py:obj:`str`\ , :py:obj:`str`\ ]


   Factory for creating Battleship game engines.

   Init  .


   .. py:method:: get_structured_output_model(role)

      Get the structured output model for a specific role.



.. py:class:: BattleshipPlayerIdentifiers

   Bases: :py:obj:`haive.games.core.agent.generic_player_agent.GamePlayerIdentifiers`\ [\ :py:obj:`str`\ , :py:obj:`str`\ ]


   Player identifiers for Battleship game.

   Init  .


.. py:class:: BattleshipPromptGenerator(players)

   Bases: :py:obj:`haive.games.core.agent.generic_player_agent.GenericPromptGenerator`\ [\ :py:obj:`str`\ , :py:obj:`str`\ ]


   Prompt generator for Battleship game.

   Init  .

   :param players: [TODO: Add description]


   .. py:method:: create_analyzer_prompt(player)

      Create analysis prompt for Battleship game state.



   .. py:method:: create_move_prompt(player)

      Create move prompt for Battleship player.



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

   Create budget-friendly Battleship engines.


.. py:function:: create_generic_battleship_config_from_example(example_name, temperature = 0.3)

   Create Battleship engines from a predefined example configuration.

   :param example_name: Name of the example configuration
   :param temperature: Generation temperature

   :returns: Dictionary of Battleship engines
   :rtype: Dict[str, AugLLMConfig]

   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
       - "naval_commanders": High-powered models for strategic gameplay



.. py:function:: create_generic_battleship_engines(player_configs)

   Create Battleship engines from detailed player configurations.

   :param player_configs: Dictionary mapping role names to player configurations

   :returns: Dictionary of Battleship engines
   :rtype: Dict[str, AugLLMConfig]

   Expected roles:
       - "player1_player": Player 1 configuration
       - "player2_player": Player 2 configuration
       - "player1_analyzer": Player 1 analyzer configuration
       - "player2_analyzer": Player 2 analyzer configuration



.. py:function:: create_generic_battleship_engines_simple(player1_model, player2_model, temperature = 0.3)

   Create Battleship engines with simple model specifications.

   :param player1_model: Model for player 1 and analyzer
   :param player2_model: Model for player 2 and analyzer
   :param temperature: Generation temperature

   :returns: Dictionary of Battleship engines
   :rtype: Dict[str, AugLLMConfig]


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

   Create mixed-provider Battleship engines.


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

   Create naval commander-style Battleship engines with high-powered models.