Initializing help system before first use

xpressinsight.types.Series

Purpose
Creates an annotation for a Series entity, a declaration of a pandas Series datastructure. Every series must have at least one index.
Synopsis
Series(index: Union[str, List[str]], dtype: Type[xpressinsight.BasicType], alias: str = '', format: str = '', hidden: xpressinsight.Hidden = Hidden.FALSE, manage: xpressinsight.Manage = Manage.INPUT, read_only: bool = False, transform_labels_entity: str = '', update_after_execution: bool = False, *, update_progress: bool = False) -> type
Arguments
index 
The name of the index to use, or list of names for multiple indices. The same index may appear in the list multiple times.
dtype 
The data-type.
alias 
Used to provide an alternative name for an entity in the UI. The value is used in place of the entity name where appropriate in the UI.
format 
The formatting string used for displaying numeric values.
hidden 
Indicates whether the UI should hide the entity where appropriate.
manage 
How and whether Insight handles an entity. Defines how the system manages the entity data.
read_only 
Whether an entity is readonly. Specifies that the value(s) of the entity cannot be modified. See also hidden.
transform_labels_entity 
An entity in the schema to be used as a labels entity. The value is the name of the entity. The type of the index set of the labels entity must match the data type of this entity. The data type of the labels entity can be any primitive type.
update_after_execution 
Whether the value of the entity in the scenario is updated with the value of the corresponding model entity at the end of the scenario execution. If True the value of the entity is updated to correspond with the model entity after execution.
update_progress 
Whether the value of the entity in the scenario is sent on progress updates. If True the value of the entity will be written back to the Insight repository when insight.send_progress_update is called from an execution mode where the send_progress attribute is True.
Example
Example of creating a Result series containing floating-point values, and is managed by Insight as a result entity. It is indexed by Indices, which must have been declared previously. 
>>> Indices: xi.types.Index(...) # previous declaration
... Result: xi.types.Series(index=['Indices'], dtype=xi.real,
...                   manage=xi.Manage.RESULT, alias='Result Array')
Further information
1. This function returns an Annotated type containing the Series entity object; for example, xi.types.Series(index='idx', dtype=xi.integer) is equivalent to Annotated[pandas.Series, xi.Series(index='idx', dtype=xi.integer)].
2. Parameters before update_progress can be specified positionally for reasons of backwards compatibility, but it's recommended that you always use named arguments if you're specifying parameters other than dtype and alias.
Related topics
types.Index, Series

Parent Topic Data Model Functions

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