Minga.Extension.ModelRoutes (minga_sdk v0.1.0)

Copy Markdown View Source

Registers model routes that run inside Minga's agent loop.

Call register/2 from your extension's init/1 and keep the returned reporter. report_status/2 works from any process.

This is a compile-time stub. At runtime, the real module in Minga's BEAM VM provides the implementation.

Summary

Types

register_error()

@type register_error() ::
  :no_extension_context
  | {:duplicate_route_id, String.t(), term(), term()}
  | {:invalid_spec, atom()}
  | {:invalid_route_module, module()}
  | {:invalid_models, term()}

report_error()

@type report_error() :: :unknown_route | :stale_reporter | :invalid_status

Functions

register(attrs, opts \\ [])

@spec register(map() | keyword(), keyword()) ::
  {:ok, MingaAgent.InferenceRoute.Reporter.t()} | {:error, register_error()}

report_status(reporter, availability, opts \\ [])

@spec report_status(MingaAgent.InferenceRoute.Reporter.t(), term(), keyword()) ::
  :ok | {:error, report_error()}

report_usage(reporter, windows, opts \\ [])

@spec report_usage(
  MingaAgent.InferenceRoute.Reporter.t(),
  [MingaAgent.InferenceRoute.PlanWindow.t() | map()],
  keyword()
) :: :ok | {:error, report_error() | {:invalid_plan_window, atom()}}