Initializing help system before first use

xpressinsight.Param

Purpose
The configuration of a parameter entity. Parameters can be used to configure an Xpress Insight app. When parameters are declared, their name, data type, and default value must be specified. Parameters are typically read-only. Use the helper function xpressinsight.types.Param to declare a parameter entity in an app, rather than instantiating xpressinsight.Param directly.
Synopsis
class xpressinsight.Param(Entity)
Further information
In older versions of xpressinsight, it was possible to use the Param as the annotation for an entity. This syntax is now deprecated and should not be used in new apps; it will not be supported in Python 3.12 and above.
Related topics
Entity,
Param.__init__,
Param.alias,
Param.check_type,
Param.default,
Param.dtype,
Param.entity_name,
Param.format,
Param.hidden,
Param.is_managed,
Param.manage,
Param.name,
Param.read_only,
Param.transform_labels_entity,
Param.type_hint,
Param.update_after_execution,
Param.update_keep_result_data,
Param.update_progress,
Scalar,
types.Param

Parent Topic Entity Definition Container Classes

© 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.