Initializing help system before first use

xpressinsight.PolarsDataFrame

Purpose
The configuration of a PolarsDataFrame entity, which is a group of columns with a shared index, represented as a Polars DataFrame. Use the helper function xpressinsight.types.PolarsDataFrame to declare a DataFrame entity in an app, rather than instantiating xpressinsight.PolarsDataFrame directly.
Synopsis
class xpressinsight.PolarsDataFrame(DataFrameBase)
Further information
1. As Polars frames are not indexed, indexes declared in the Insight schema are represented as additional columns of values in the Polars DataFrame. The uniqueness of the index values will be verified when the data is saved at the end of the scenario.
2. Polars-type entities will only be available if polars has been installed in your Python environment.
Related topics
Column,
DataFrameBase,
PolarsDataFrame.__init__,
PolarsDataFrame.check_type,
PolarsDataFrame.columns,
PolarsDataFrame.index,
PolarsDataFrame.index_names,
PolarsDataFrame.index_types,
PolarsDataFrame.is_managed,
PolarsDataFrame.name,
PolarsDataFrame.type_hint,
PolarsDataFrame.unique_index_names,
PolarsDataFrame.update_progress,
types.DataFrame,
types.Index

Parent Topic Entity Definition Container Classes

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