dspex

# Generated by SnakeBridge v0.14.0 - DO NOT EDIT MANUALLY
# Regenerate with: mix compile
# Library: dspy 3.1.2
# Python module: dspy.predict.parallel
# Python class: Parallel

defmodule Dspy.Predict.ParallelClass do
  @moduledoc """
  Wrapper for Python class Parallel.
  """
  def __snakebridge_python_name__, do: "dspy.predict.parallel"
  def __snakebridge_python_class__, do: "Parallel"
  def __snakebridge_library__, do: "dspy"
  @opaque t :: SnakeBridge.Ref.t()

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

  ## Parameters

  - `num_threads` (term() default: None)
  - `max_errors` (term() default: None)
  - `access_examples` (boolean() default: True)
  - `return_failed_examples` (boolean() default: False)
  - `provide_traceback` (term() default: None)
  - `disable_progress_bar` (boolean() default: False)
  - `timeout` (integer() default: 120)
  - `straggler_limit` (integer() default: 3)
  """
  @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 `Parallel.forward`.

  ## Parameters

  - `exec_pairs` (list({term(), Dspy.Primitives.ExampleClass.t()}))
  - `num_threads` (term() default: None)

  ## Returns

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