dspex

# Generated by SnakeBridge v0.16.0 - DO NOT EDIT MANUALLY
# Regenerate with: mix compile
# Library: dspy 3.1.3
# Python module: dspy.datasets
# Python class: HotPotQA

defmodule Dspy.Datasets.HotPotQA do
  @moduledoc """
  Wrapper for Python class HotPotQA.
  """
  def __snakebridge_python_name__, do: "dspy.datasets"
  def __snakebridge_python_class__, do: "HotPotQA"
  def __snakebridge_library__, do: "dspy"
  @opaque t :: SnakeBridge.Ref.t()

  @doc """
  Initialize self.  See help(type(self)) for accurate signature.

  ## Parameters

  - `args` (term())
  - `only_hard_examples` (term() keyword-only default: True)
  - `keep_details` (term() keyword-only default: 'dev_titles')
  - `unofficial_dev` (term() keyword-only default: True)
  - `kwargs` (term())
  """
  @spec new(list(term()), keyword()) :: {:ok, SnakeBridge.Ref.t()} | {:error, Snakepit.Error.t()}
  def new(args, opts \\ []) do
    {args, opts} = SnakeBridge.Runtime.normalize_args_opts(args, opts)
    SnakeBridge.Runtime.call_class(__MODULE__, :__init__, [] ++ List.wrap(args), opts)
  end

  @doc """
  Python method `HotPotQA._shuffle_and_sample`.

  ## Parameters

  - `split` (String.t())
  - `data` (term())
  - `size` (term())
  - `seed` (integer() default: 0)

  ## Returns

  - `list(term())`
  """
  @spec _shuffle_and_sample(
          SnakeBridge.Ref.t(),
          String.t(),
          term(),
          term(),
          list(term()),
          keyword()
        ) :: {:ok, list(term())} | {:error, Snakepit.Error.t()}
  def _shuffle_and_sample(ref, split, data, size, args, opts \\ []) do
    {args, opts} = SnakeBridge.Runtime.normalize_args_opts(args, opts)

    SnakeBridge.Runtime.call_method(
      ref,
      :_shuffle_and_sample,
      [split, data, size] ++ List.wrap(args),
      opts
    )
  end

  @doc """
  Python method `HotPotQA.prepare_by_seed`.

  ## Parameters

  - `train_seeds` (term() default: None)
  - `train_size` (integer() default: 16)
  - `dev_size` (integer() default: 1000)
  - `divide_eval_per_seed` (boolean() default: True)
  - `eval_seed` (integer() default: 2023)
  - `kwargs` (term())

  ## Returns

  - `term()`
  """
  @spec prepare_by_seed(SnakeBridge.Ref.t(), list(term()), keyword()) ::
          {:ok, term()} | {:error, Snakepit.Error.t()}
  def prepare_by_seed(ref, args, opts \\ []) do
    {args, opts} = SnakeBridge.Runtime.normalize_args_opts(args, opts)
    SnakeBridge.Runtime.call_method(ref, :prepare_by_seed, [] ++ List.wrap(args), opts)
  end

  @doc """
  Python method `HotPotQA.reset_seeds`.

  ## Parameters

  - `train_seed` (term() default: None)
  - `train_size` (term() default: None)
  - `eval_seed` (term() default: None)
  - `dev_size` (term() default: None)
  - `test_size` (term() default: None)

  ## Returns

  - `nil`
  """
  @spec reset_seeds(SnakeBridge.Ref.t(), list(term()), keyword()) ::
          {:ok, nil} | {:error, Snakepit.Error.t()}
  def reset_seeds(ref, args, opts \\ []) do
    {args, opts} = SnakeBridge.Runtime.normalize_args_opts(args, opts)
    SnakeBridge.Runtime.call_method(ref, :reset_seeds, [] ++ List.wrap(args), opts)
  end

  @spec dev(SnakeBridge.Ref.t()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
  def dev(ref) do
    SnakeBridge.Runtime.get_attr(ref, :dev)
  end

  @spec test(SnakeBridge.Ref.t()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
  def test(ref) do
    SnakeBridge.Runtime.get_attr(ref, :test)
  end

  @spec train(SnakeBridge.Ref.t()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
  def train(ref) do
    SnakeBridge.Runtime.get_attr(ref, :train)
  end
end