Model<'In, 'Out> (dfx)

Model<'In, 'Out> Type

Namespace: Dfx.Model
Assembly: Dfx.Core.dll
Base Type: ModelBase

Represents a model, primarily a collection of named parameters and sub-models and a function governed by them.

Constructors

Constructor	Description
`Model(?f, ?parameters, ?buffers, ?models)` Full Usage: `Model(?f, ?parameters, ?buffers, ?models)` Parameters: ?f : `'In -> 'Out` ?parameters : `Parameter seq` ?buffers : `Parameter seq` ?models : `ModelBase seq` Returns: `Model<'In, 'Out>`	?f : `'In -> 'Out` ?parameters : `Parameter seq` ?buffers : `Parameter seq` ?models : `ModelBase seq` Returns: `Model<'In, 'Out>`

Instance members

Instance member	Description
`this.asFunction parameters input` Full Usage: `this.asFunction parameters input` Parameters: parameters : `Tensor` input : `'In` Returns: `'Out`	Use the model as a function of its parameters and input. The resulting function can be composed with a loss function and differentiated. During execution the parameters of the model are temporarily set to the supplied parameters. parameters : `Tensor` input : `'In` Returns: `'Out`
`this.clone ()` Full Usage: `this.clone ()` Returns: `Model<'In, 'Out>`	TBD Returns: `Model<'In, 'Out>`
`this.forward arg1` Full Usage: `this.forward arg1` Parameters: arg0 : `'In` Returns: `'Out` Modifiers: abstract	TBD arg0 : `'In` Returns: `'Out`

Static members

Static member	Description
`t --> model` Full Usage: `t --> model` Parameters: t : `'In` model : `Model<'In, 'Out>` Returns: `'Out`	TBD t : `'In` model : `Model<'In, 'Out>` Returns: `'Out`
`f --> model` Full Usage: `f --> model` Parameters: f : `'In -> 'Out` model : `Model<'Out, 'Out2>` Returns: `Model<'In, 'Out2>`	TBD f : `'In -> 'Out` model : `Model<'Out, 'Out2>` Returns: `Model<'In, 'Out2>`
`model --> f` Full Usage: `model --> f` Parameters: model : `Model<'In, 'Out>` f : `'Out -> 'Out2` Returns: `Model<'In, 'Out2>`	TBD model : `Model<'In, 'Out>` f : `'Out -> 'Out2` Returns: `Model<'In, 'Out2>`
`model1 --> model2` Full Usage: `model1 --> model2` Parameters: model1 : `Model<'In, 'Out>` model2 : `Model<'Out, 'Out2>` Returns: `Model<'In, 'Out2>`	TBD model1 : `Model<'In, 'Out>` model2 : `Model<'Out, 'Out2>` Returns: `Model<'In, 'Out2>`
`Model.compose model1 model2` Full Usage: `Model.compose model1 model2` Parameters: model1 : `Model<'In, 'Out>` model2 : `Model<'Out, 'Out2>` Returns: `Model<'In, 'Out2>`	TBD model1 : `Model<'In, 'Out>` model2 : `Model<'Out, 'Out2>` Returns: `Model<'In, 'Out2>`

Inherited members

Inherited from `ModelBase`

Instance members

Instance member	Description
`this.addBuffer (buffer, name)` Full Usage: `this.addBuffer (buffer, name)` Parameters: buffer : `Parameter` name : `string`	buffer : `Parameter` name : `string`
`this.addBuffer buffers` Full Usage: `this.addBuffer buffers` Parameters: buffers : `(Parameter * string)[]`	buffers : `(Parameter * string)[]`
`this.addBuffer buffers` Full Usage: `this.addBuffer buffers` Parameters: buffers : `Parameter[]`	buffers : `Parameter[]`
`this.addModel (model, name)` Full Usage: `this.addModel (model, name)` Parameters: model : `Model` name : `string`	model : `Model` name : `string`
`this.addModel models` Full Usage: `this.addModel models` Parameters: models : `(Model * string)[]`	models : `(Model * string)[]`
`this.addModel models` Full Usage: `this.addModel models` Parameters: models : `Model[]`	models : `Model[]`
`this.addModel (model, name)` Full Usage: `this.addModel (model, name)` Parameters: model : `ModelBase` name : `string`	model : `ModelBase` name : `string`
`this.addModel models` Full Usage: `this.addModel models` Parameters: models : `(ModelBase * string)[]`	models : `(ModelBase * string)[]`
`this.addModel models` Full Usage: `this.addModel models` Parameters: models : `ModelBase[]`	models : `ModelBase[]`
`this.addParameter (parameter, name)` Full Usage: `this.addParameter (parameter, name)` Parameters: parameter : `Parameter` name : `string`	parameter : `Parameter` name : `string`
`this.addParameter parameters` Full Usage: `this.addParameter parameters` Parameters: parameters : `(Parameter * string)[]`	parameters : `(Parameter * string)[]`
`this.addParameter parameters` Full Usage: `this.addParameter parameters` Parameters: parameters : `Parameter[]`	parameters : `Parameter[]`
`this.clone ()` Full Usage: `this.clone ()` Returns: `ModelBase`	TBD Returns: `ModelBase`
`this.eval ()` Full Usage: `this.eval ()`	TBD
`this.forwardDiff (derivatives, ?nestingTag)` Full Usage: `this.forwardDiff (derivatives, ?nestingTag)` Parameters: derivatives : `ParameterDict` - The derivatives of the parameters ?nestingTag : `uint32` - The level tag for nested differentiation. Defaults to the current global nesting level	Adjust the parameters of the model to initiate a new level of forward-mode automatic differentiation. After this call the current parameters of the model will have attached derivatives for forward mode differentiation. derivatives : `ParameterDict` The derivatives of the parameters ?nestingTag : `uint32` The level tag for nested differentiation. Defaults to the current global nesting level
`this.init f` Full Usage: `this.init f` Parameters: f : `string * Tensor -> Tensor`	TBD f : `string * Tensor -> Tensor`
`this.move (?device, ?dtype, ?backend)` Full Usage: `this.move (?device, ?dtype, ?backend)` Parameters: ?device : `Device` ?dtype : `Dtype` ?backend : `Backend`	Moves the state (parameters and buffers) of the model to the given configuration ?device : `Device` ?dtype : `Dtype` ?backend : `Backend`
`this.noDiff ()` Full Usage: `this.noDiff ()`	TBD
`this.reverseDiff ?nestingTag` Full Usage: `this.reverseDiff ?nestingTag` Parameters: ?nestingTag : `uint32` - The level tag for nested differentiation. Defaults to the current global nesting level	Adjust the parameters of the model to initiate a new level of reverse-mode automatic differentiation. After this call the current parameters of the model will support reverse-mode differentiation. After the completion of the corresponding `reverse` operation, the computed derivatives will be available. ?nestingTag : `uint32` The level tag for nested differentiation. Defaults to the current global nesting level
`this.summary ()` Full Usage: `this.summary ()` Returns: `string`	TBD Returns: `string`
`this.train ()` Full Usage: `this.train ()`	TBD
`this.backend` Full Usage: `this.backend` Returns: `Backend`	Returns: `Backend`
`this.state` Full Usage: `this.state` Returns: `ParameterDict`	TBD Returns: `ParameterDict`
`this.buffers` Full Usage: `this.buffers` Returns: `ParameterDict`	TBD Returns: `ParameterDict`
`this.hasOwnParameters` Full Usage: `this.hasOwnParameters` Returns: `bool`	TBD Returns: `bool`
`this.isNoDiff` Full Usage: `this.isNoDiff` Returns: `bool`	Returns: `bool`
`this.device` Full Usage: `this.device` Returns: `Device`	Returns: `Device`
`this.hasOwnBuffers` Full Usage: `this.hasOwnBuffers` Returns: `bool`	TBD Returns: `bool`
`this.parametersVector` Full Usage: `this.parametersVector` Returns: `Tensor`	TBD Returns: `Tensor`
`this.isReverseDiff` Full Usage: `this.isReverseDiff` Returns: `bool`	Returns: `bool`
`this.nstate` Full Usage: `this.nstate` Returns: `int`	TBD Returns: `int`
`this.nparameters` Full Usage: `this.nparameters` Returns: `int`	Gets the number of parameters of the Model Returns: `int`
`this.hasOwnState` Full Usage: `this.hasOwnState` Returns: `bool`	TBD Returns: `bool`
`this.children` Full Usage: `this.children` Returns: `ModelBase list`	TBD Returns: `ModelBase list`
`this.isForwardDiff` Full Usage: `this.isForwardDiff` Returns: `bool`	Returns: `bool`
`this.parameters` Full Usage: `this.parameters` Returns: `ParameterDict`	TBD Returns: `ParameterDict`
`this.descendants` Full Usage: `this.descendants` Returns: `ModelBase list`	TBD Returns: `ModelBase list`
`this.nbuffers` Full Usage: `this.nbuffers` Returns: `int`	TBD Returns: `int`
`this.buffersVector` Full Usage: `this.buffersVector` Returns: `Tensor`	TBD Returns: `Tensor`
`this.dtype` Full Usage: `this.dtype` Returns: `Dtype`	Returns: `Dtype`
`this.stateVector` Full Usage: `this.stateVector` Returns: `Tensor`	TBD Returns: `Tensor`

Model<'In, 'Out> Type

Constructors

Instance members

Static members

Inherited members

Inherited from ModelBase

Instance members

Inherited from `ModelBase`