Module aivis_engine_v2_cn_sdk_python.setup

Classes

class ConstraintNavigatorSetup

Class for creating and handling constraint navigator setup. This is your entry point for all setup operations.

This class cannot be instantiated.

Static methods

def init_api_key(cls, api_key: str)

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Set the licensing key to authenticate API calls with.

If the licensing key is not specified through this function, the engine will use the value in the environment variable AIVIS_ENGINE_V2_API_KEY.

Attention: This function can only be called once for this runtime. Additional calls will result in an exception.

Parameters

api_key : str

API license key

def init_thread_count(cls, count: int)

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Initialize library to use parallel computation up to given thread count. If count is set to 0 (default), the library will automatically use all available threads from MAX_CPU_THREADS.

Attention: This function can only be called once for this runtime. Additional calls will result in an exception.

Parameters

count : int

Maximum number of threads used for computation

def register_logger(cls, logger: EngineLogger)

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Initialize library to use given EngineLogger instance for logging. If no logger is set, the library will not log anything.

Parameters

logger : EngineLogger

Logger instance implementing log function