tests__vm#

Whether to spin up a separate VM to test the estimator.

Part of packaging metadata for the object, used only in sktime CI.

String name: "tests:vm"
Private tag, developer and framework facing
Values: boolean, True / False
Example: True
Default: False

sktime’s CI framework regularly tests estimators in pull requests, usually only estimators that have changed, via run_test_for_class.

The tests:vm tag of an object is a boolean, it specifies whether the estimator should be tested in a separate VM, with a fresh environment set up using the python_dependencies tag, with version/OS matrix defined by python_version and env_marker tags.

This tag should be set to True for estimators that have a complex dependency setup, or that are known to have issues with the default sktime CI environment. It can also be used for estimators with soft dependencies that occur only in one or few specific estimators. Otherwise, it should be used sparingly.

The tests:vm tag is not used in user facing checks, error messages, or recommended build processes otherwise.