xpressinsight.data.PolarsIndex
Purpose
Creates an annotation for an
index entity to be fetched from another scenario and stored as a Polars Series.
Synopsis
xpressinsight.data.PolarsIndex(*, dtype: Type[BasicType] = None, entity_name: str = None) -> Type[polars.Series]
Arguments
|
dtype
|
The data type; one of
boolean,
integer or
string. If given,
:fct-ref:`insight.get_scenario_data will verify the data being fetched is of this type.
|
|
entity_name
|
The name of the entity to read. If not given, the name of the class attribute will be used as the entity name. |
Example
Example creating an index of integer values.
>>> MyIndex: xi.data.PolarsIndex(dtype=xi.integer, entity_name="indexSet")
Further information
1. The function
PolarsIndex is part of the package
xpressinsight.data.
2. This function returns an
Annotated type containing the
Index entity object; for example, if
xpressinsight has been imported as
xi, then
xi.data.Index(dtype=xi.integer) is equivalent to
Annotated[pandas.Index, xi.Index(dtype=xi.integer)].
3. Polars-type entities will only be available if
polars has been installed in your Python environment.
Related topics
© 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.