Namespace Microsoft.ML.Probabilistic.Factors.Attributes

Classes

AllExceptIndexAttribute

When applied to a message function parameter, indicates that the function depends on all items in the message collection except the resultIndex. The default is all items.

BuffersAttribute

When applied to a message operator class, indicates that the message operators may use the named parameters as storage for holding algorithm state.

CancelsAttribute

When applied to a message function parameter, indicates that the argument's value is cancelled by another argument, thus there is no real dependency.

ConstantAttribute

When attached to a factor parameter, indicates that the parameter is constant - i.e. cannot be changed by observation or by inference

DiodeAttribute

When applied to a method argument, indicates that the argument should not participate in backward sequential loops.

FactorMethodAttribute

When applied to a class, indicates that the class provides message functions for a given factor.

FreshAttribute

When applied to a method argument, indicates that the argument must be up-to-date before invoking the method. When applied to a method, indicates that the method must be recomputed whenever any of its arguments change.

HasMessageFunctionsAttribute

When applied to an assembly, indicates that the assembly should be searched for message functions.

HasUnitDerivative

Marks a factor as having derivative wrt all inputs equal to 1 always (only applies to deterministic factors)

HiddenAttribute

Marks a factor as hidden

IgnoreDeclarationAttribute

When attached to a method parameter, indicates that the dependency and the declaration dependency should be ignored by the FactorManager.

IgnoreDependencyAttribute

When attached to a method parameter, indicates that the dependency should be ignored by the FactorManager. Only a declaration dependency will be retained.

IndexedAttribute

When applied to a message function parameter, indicates that the argument should be indexed by resultIndex.

InducedSourceAttribute

When applied to a message function parameter, causes the InducedTarget to depend on the parameter

InducedTargetAttribute

When applied to a message function parameter, causes the parameter to depend on the InducedSource

IsReturnedAttribute

When applied to a method argument, indicates that the argument will be returned unmodified as the result of the method. This automatically implies SkipIfUniform and Trigger.

IsReturnedInEveryElementAttribute

When applied to a method argument for methods that return lists, indicates that all elements of the returned list will be identical and equal to that argument. This automatically implies SkipIfUniform.

MatchingIndexAttribute

When applied to a message function parameter, indicates that the function depends on the one item in the message collection at resultIndex. The default is all items.

MatchingIndexTriggerAttribute

When applied to a method argument, indicates that the method's result is invalidated when the array element at resultIndex changes.

MultiplyAllAttribute

When applied to a message function, indicates that the function returns the product of its arguments.

NoInitAttribute

When applied to a method argument, indicates that the argument does not benefit from initialization (by default, initialization is assumed to be beneficial). This attribute is incompatible with SkipIfUniform or Required.

NoTriggersAttribute

When applied to a method, indicates that no default triggers should be assigned to its parameters. The method will explicitly mark its triggers using TriggerAttribute. A general rule is that a VMP operator that depends on the opposite message must not trigger on that message (i.e. non-conjugate operators).

NotSupportedAttribute

When applied to a method, indicates that the method will always throw a NotSupportedException.

ParameterNamesAttribute

When applied to a method, overrides the default choice of parameter names.

ProperAttribute

The distribution must be proper.

Quality

Attribute used to label Infer.NET components. They may be attached to algorithm classes, distribution classes, and operator classes. They may also be attached to any methods on these classes

RequiredArgumentAttribute

When applied to a method argument, indicates that argument is required to have been set before calling the method

ReturnsCompositeArrayAttribute

When applied to a factor, indicates that the factor returns a composite array.

SkipAttribute

The result is always uniform.

SkipIfAllExceptIndexAreUniformAttribute

The result is uniform (or an exception would be thrown) if all elements except at the result index are uniform, hence the function call can be skipped.

SkipIfAllUniformAttribute

The result is uniform (or an exception would be thrown) if all elements are uniform, hence the function call can be skipped.

SkipIfAnyExceptIndexIsUniformAttribute

The result is uniform (or an exception would be thrown) if any element except at the result index is uniform, hence the function call can be skipped.

SkipIfAnyUniformAttribute

The result is uniform (or an exception would be thrown) if any element is uniform, hence the function call can be skipped.

SkipIfMatchingIndexIsUniformAttribute

The result is uniform (or an exception would be thrown) if the element at the result index is uniform, hence the function call can be skipped.

SkipIfUniformAttribute

The result is uniform (or an exception would be thrown) whenever this parameter is uniform, hence the function call can be skipped.

Stochastic

When applied to a method, indicates that the method is non-deterministic.

TriggerAttribute

When applied to a method argument, indicates that the method's result is invalidated when a dependent item in that argument changes.

Enums

QualityBand

Quality bands for Infer.NET components - distributions, operators, factors