requires_cython#

requires_cython()[source]#

Whether the object requires a C compiler present, such as libomp, gcc.

Part of packaging metadata for the object.

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

sktime manages objects and estimators like mini-packages, with their own dependencies and compatibility requirements. Dependencies are specified in the tags:

"python_version": Python version specifier (PEP 440) for the object,
"python_dependencies": list of required Python packages (PEP 440)
"python_dependencies_alias": alias for package names, if different from import names
"env_marker": environment marker for the object (PEP 508)
"requires_cython": whether the object requires a C compiler present

The requires_cython tag of an object is a boolean, specifying whether the object requires a C compiler present. True means that a C compiler is required, False means it is not required.

The tag is used in packaging metadata for the object, and primarily in the continuous integration and testing setup of the sktime package, which ensures that objects with this tag are tested in specific environments with a C compiler present.

It is not used in user facing checks, error messages, or recommended build processes otherwise.