Viewing: diffsharp.github.io

[diffsharp-logo-text.png]

ParameterDict Type

Namespace: DiffSharp.Model
Assembly: DiffSharp.Core.dll
Base Type: obj
All Interfaces: IEnumerable<string * Parameter> , IEnumerable

Represents a collection of named parameters.

Constructors

Constructor	Description
`ParameterDict()` Full Usage: `ParameterDict()` Returns: `ParameterDict`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] Returns: `ParameterDict`

Instance members

Instance member	Description
`this.[key]` Full Usage: `this.[key]` Returns: `string`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] TBD Returns: `string`
`this.add parameters` Full Usage: `this.add parameters` Parameters: parameters : `ParameterDict`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] TBD parameters : `ParameterDict`
`this.add parameters` Full Usage: `this.add parameters` Parameters: parameters : `(string * Parameter) list`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] TBD parameters : `(string * Parameter) list`
`this.add (name, parameter)` Full Usage: `this.add (name, parameter)` Parameters: name : `'a` parameter : `Parameter`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] TBD name : `'a` parameter : `Parameter`
`this.backend` Full Usage: `this.backend` Returns: `Backend`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] Returns: `Backend`
`this.clear ()` Full Usage: `this.clear ()`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] TBD
`this.copy ()` Full Usage: `this.copy ()` Returns: `ParameterDict`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] TBD This method discards differentiability and returns a ParameterDict containing parameters that are constant tensors. Returns: `ParameterDict`
`this.count` Full Usage: `this.count` Returns: `int`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] Returns: `int`
`this.device` Full Usage: `this.device` Returns: `Device`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] Returns: `Device`
`this.dtype` Full Usage: `this.dtype` Returns: `Dtype`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] Returns: `Dtype`
`this.flatten ?differentiable` Full Usage: `this.flatten ?differentiable` Parameters: ?differentiable : `bool` Returns: `Tensor`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] TBD ?differentiable : `bool` Returns: `Tensor`
`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	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] Adjust the parameters to include support for forward-mode automatic differentiation. After this call the current parameters in this dictionary 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.iter f` Full Usage: `this.iter f` Parameters: f : `string * Parameter -> unit`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] TBD f : `string * Parameter -> unit`
`this.map f` Full Usage: `this.map f` Parameters: f : `Parameter -> Parameter` Returns: `ParameterDict`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] TBD f : `Parameter -> Parameter` Returns: `ParameterDict`
`this.map f` Full Usage: `this.map f` Parameters: f : `string * Parameter -> string * Parameter` Returns: `ParameterDict`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] TBD f : `string * Parameter -> string * Parameter` Returns: `ParameterDict`
`this.move (?device, ?dtype, ?backend)` Full Usage: `this.move (?device, ?dtype, ?backend)` Parameters: ?device : `Device` ?dtype : `Dtype` ?backend : `Backend`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] TBD ?device : `Device` ?dtype : `Dtype` ?backend : `Backend`
`this.nelement` Full Usage: `this.nelement` Returns: `int`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] TBD Returns: `int`
`this.noDiff ()` Full Usage: `this.noDiff ()`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] 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	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] Adjust the parameters to include support for reverse-mode automatic differentiation. After this call the current parameters in this dictionary will support reverse-mode differentiation. After the completion of the corresponding `reverse` operation, the computed derivative will be available. ?nestingTag : `uint32` The level tag for nested differentiation. Defaults to the current global nesting level
`this.set (other, ?differentiable, ?strict)` Full Usage: `this.set (other, ?differentiable, ?strict)` Parameters: other : `ParameterDict` ?differentiable : `bool` ?strict : `bool`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] TBD other : `ParameterDict` ?differentiable : `bool` ?strict : `bool`
`this.unflatten (tensors, ?differentiable)` Full Usage: `this.unflatten (tensors, ?differentiable)` Parameters: tensors : `Tensor` ?differentiable : `bool`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] TBD tensors : `Tensor` ?differentiable : `bool`
`this.unflattenToNew tensors` Full Usage: `this.unflattenToNew tensors` Parameters: tensors : `Tensor` Returns: `ParameterDict`	[copy-md.png] [copy-md-hover.png] [copy-xml.png] [copy-xml-hover.png] [github.png] [github-hover.png] TBD tensors : `Tensor` Returns: `ParameterDict`