Initializing help system before first use

xpressinsight.data.Series

Purpose
Creates an annotation for a Series entity to be fetched from another scenario.
Synopsis
xpressinsight.data.Series(*, dtype: Type[BasicType] = None, entity_name: str = None, series_name: str = None, index_names: List[str] = None, index_types: List[Type[BasicType]] = None) -> Type[pandas.Series]
Arguments
dtype 
The data type; one of boolean, real, 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.
series_name 
The name to use for the values in the resultant series. If not given, the entity name will be used.
index_names 
The names of the columns to use for the index(es) in the resultant series. If not given, names derived from the index entities in the other scenario will be used. If given, the names must be unique and there must be one for each index column.
index_types 
The expected data-types for each of the index columns in the series. If given, you must specify a type for each index of this series and :fct-ref:`insight.get_scenario_data will verify the index values being fetched is of these types.
Example 
>>> Result: xi.data.Series(dtype=xi.real, series_name='Result Array',
...                        index_names=['IndexSet1', 'IndexSet2'],)
Further information
This function returns an Annotated type containing the Series entity object; for example, if xpressinsight has been imported as xi, then xi.data.Series(index_names=['idx1', 'idx2'], dtype=xi.integer) is equivalent to Annotated[pandas.Series, xi.Series(index=['idx1', 'idx2'], dtype=xi.integer)].
Related topics
AppInterface.get_scenario_data,
BasicType,
ScenarioData,
Series

Parent Topic Scenario Data Entity Definitions

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