Tinkex.Types.OptimStepResponse (Tinkex v0.3.4)

View Source

Response from optimizer step request.

Mirrors Python tinker.types.OptimStepResponse.

Summary

Functions

Parse an optim step response from JSON.

Convenience helper to check if the step succeeded.

Types

t()

@type t() :: %Tinkex.Types.OptimStepResponse{
  metrics: %{required(String.t()) => float()} | nil
}

Functions

from_json(json)

@spec from_json(map()) :: t()

Parse an optim step response from JSON.

success?(response)

@spec success?(t()) :: boolean()

Convenience helper to check if the step succeeded.