Initializing help system before first use

xpressinsight.PolarsIndex

Purpose
The configuration of an index entity, to be represented as a Polars Series. Use the helper function xpressinsight.types.PolarsIndex to declare an index entity in an app, rather than instantiating xpressinsight.PolarsIndex directly.
Synopsis
class xpressinsight.PolarsIndex(IndexBase)
Further information
1. In an Insight app schema, an index is a sequence of unique values. As Polars does not have this concept, we represent the index as a Series. The uniqueness of values in the series will be checked when the data is saved at the end of the scenario execution.
2. Polars-type entities will only be available if polars has been installed in your Python environment.
Related topics
IndexBase,
PolarsDataFrame,
PolarsIndex.__init__,
PolarsIndex.alias,
PolarsIndex.check_type,
PolarsIndex.dtype,
PolarsIndex.entity_name,
PolarsIndex.format,
PolarsIndex.hidden,
PolarsIndex.is_managed,
PolarsIndex.manage,
PolarsIndex.name,
PolarsIndex.read_only,
PolarsIndex.transform_labels_entity,
PolarsIndex.type_hint,
PolarsIndex.update_after_execution,
PolarsIndex.update_keep_result_data,
PolarsIndex.update_progress,
types.PolarsIndex

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.