property__randomness#

property__randomness()[source]#

Property: Degree of randomness vs determinism of the estimator.

  • String name: "property:randomness"

  • Public property tag

  • Values: str, "stochastic", "deterministic", "derandomized"

  • Example: "deterministic"

  • Default: "deterministic"

  • If the tag is "stochastic", the estimator is stochastic and may produce different results on different runs.

  • If the tag is "deterministic", the estimator is deterministic and will produce the same results on every run, up to minimal numerical precision discrepancies (1e-5 relative error).

  • If the tag is "derandomized", the estimator can be derandomized using a random_state parameter. It behaves as "stochastic" if the random_state parameter is not set, and it behaves as "deterministic" if the random_state parameter is set.

This tag applies to instances with a given set of parameters, and all computational methods of the estimator.

If at least one of the methods has stochastic behaviour, the tag should be set to "stochastic", even if other methods are deterministic.

The tag may be inspected by the user to distinguish between estimators with deterministic and stochastic behaviour.

The tag is also used internally in tests of sktime to verify the behaviour of estimators.

On this page