scico.flax.train.traversals

Functionality to traverse, select, and update model parameters.

Functions

clip_positive(params, traversal[, minval])	Clip parameters to positive range.
clip_range(params, traversal[, minval, maxval])	Clip parameters to specified range.
construct_traversal(prmname)	Construct utility to select model parameters using a name filter.

scico.flax.train.traversals.construct_traversal(prmname)

Construct utility to select model parameters using a name filter.

Parameters:

prmname (str) – Name of parameter to select.

Return type:

ModelParamTraversal

Returns:

Flax utility to traverse and select model parameters.

scico.flax.train.traversals.clip_positive(params, traversal, minval=0.0001)

Clip parameters to positive range.

Parameters:

• params (Any) – Current model parameters.

• traversal (ModelParamTraversal) – Utility to select model parameters.

• minval (float) – Minimum value to clip selected model parameters and keep them in a positive range. Default: 1e-4.

Return type:

Any

scico.flax.train.traversals.clip_range(params, traversal, minval=0.0001, maxval=1)

Clip parameters to specified range.

Parameters:

• params (Any) – Current model parameters.

• traversal (ModelParamTraversal) – Utility to select model parameters.

• minval (float) – Minimum value to clip selected model parameters. Default: 1e-4.

• maxval (float) – Maximum value to clip selected model parameters. Default: 1.

Return type:

Any