KSLCore/ksl.simopt.evaluator/EvaluationRequest

EvaluationRequest

@Serializable

data class EvaluationRequest @JvmOverloads constructor(val modelIdentifier: String, val modelInputs: List<ModelInputs>, val crnOption: Boolean = false, val cachingAllowed: Boolean = true)(source)

An evaluation request is used to request simulation oracle execution on a model.

Parameters

modelIdentifier

the identifier for the model that will execute the requests

modelInputs

the request (input/output) for the model to use. There must not be duplicates in this list as defined by the equality of model inputs. All model inputs must be associated with the same model identifier.

crnOption

indicates if the requests should be executed by the model using common random numbers. The default is false. The CRN option cannot be true if there is only one model input to be evaluated. CRN only makes sense with 2 or more evaluations.

cachingAllowed

indicates if the request permits evaluation via a cache. The default is true. If the CRN option is true, caching must be false.

Constructors

EvaluationRequest

@JvmOverloads

constructor(modelIdentifier: String, modelInputs: ModelInputs, cachingAllowed: Boolean = true)

A convenience constructor for making an evaluation request that has a single request. The CRN option is false by default because it is a single request. CRN is applied across multiple evaluations.

@JvmOverloads

constructor(modelIdentifier: String, modelInputs: List<ModelInputs>, crnOption: Boolean = false, cachingAllowed: Boolean = true)

Properties

cachingAllowed

val cachingAllowed: Boolean = true

crnOption

val crnOption: Boolean = false

modelIdentifier

val modelIdentifier: String

modelInputs

val modelInputs: List<ModelInputs>

Functions

instance

fun instance(modelInputs: List<ModelInputs>): EvaluationRequest

Creates a new EvaluationRequest with the same model identifier, CRN option, and caching options as this instance, but with the supplied model inputs.

toString

open override fun toString(): String