Initializing help system before first use

xpressinsight.ExecMode.__init__

Purpose
Constructor for the execution mode decorator for user-defined execution modes.
Synopsis
xpressinsight.ExecMode.__init__(self, name: str, descr: str = '', clear_input: bool = False, preferred_service: str = '', threads: int = 0, *, send_progress: bool = False, exec_resource_group_name: str = None)
Arguments
name 
User-defined execution mode name. Must be a valid identifier (alphanumeric characters only, starting with a letter).
descr 
A description of the execution mode.
clear_input 
Whether this execution mode causes data to be loaded directly by the model, rather than from the Insight server. If True, then this execution behaves like the default load mode, otherwise it behaves like the default run mode.
preferred_service 
Preferred service for this execution mode.
threads 
The maximum number of threads that the model should consume when running in this mode. Defaults to no limit specified (value 0). For more detailed information on thread based capacity scheduling please see the section "Scenario execution and job scheduling" in the Insight Developer Guide. DEPRECATED - threads is deprecated, use exec_resource_group_name to associate an ExecResourceGroup.
send_progress 
Whether this execution mode can send progress during execution. If True, calling send_progress_update will cause the values of the annotated progress entities to be written back to the Insight repository. If False, calling send_progress_update will do nothing.
exec_resource_group_name 
The user-defined name of an existing ExecResourceGroup.
exec_resource_group 
An existing ExecResourceGroup specifying the min/default threads, min/default memory for scheduling.
Further information
Parameters before send_progress can be specified positionally for reasons of backwards compatibility, but it's recommended that you always use named arguments if you're specifying parameters other than name and descr.
Related topics

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.