Entity Definition Container Classes
xpressinsight.Entity
|
Abstract base class of all native Insight entities, excluding composed entities like DataFrames.
|
|
|
Alias to use for the entity in the UI.
|
|
|
The type of values in this entity.
|
|
|
Name of the entity.
|
|
|
Format string for entity values.
|
|
|
Whether the entity is hidden.
|
|
|
Check whether the entity is managed as the given management type: input/result.
|
|
|
How the entity is managed.
|
|
|
Name of the attribute representing the entity.
|
|
|
Whether the entity can be edited from the UI.
|
|
|
Name of labels transformation series for this entity.
|
|
|
The target Python type for values in this Insight entity - e.g. the Python target type of an xpressinsight.Series is a pandas.Series.
|
|
|
Whether this input entity is also saved with results.
|
|
|
Whether this is a 'progress' entity.
|
xpressinsight.EntityBase
|
Abstract base class of all Insight entities, including composed entities like DataFrames.
|
|
|
Query whether this entity would be managed as input / result.
|
|
|
Name of the attribute representing the entity.
|
|
|
The target Python type for values in this Insight entity - e.g. the Python target type of an xpressinsight.Series is a pandas.Series.
|
|
|
Whether this is a 'progress' entity.
|
xpressinsight.Scalar
|
The configuration of a scalar entity.
|
|
|
The constructor.
|
|
|
Alias to use for the entity in the UI.
|
|
|
Check if the type is correct and check the bounds.
|
|
|
Default value for this scalar.
|
|
|
The type of values in this entity.
|
|
|
Name of the entity.
|
|
|
Format string for entity values.
|
|
|
Whether the entity is hidden.
|
|
|
Check whether the entity is managed as the given management type: input/result.
|
|
|
How the entity is managed.
|
|
|
Name of the attribute representing the entity.
|
|
|
Whether the entity can be edited from the UI.
|
|
|
Name of labels transformation series for this entity.
|
|
|
The target Python type for values in this Insight entity - e.g. the Python target type of an xpressinsight.Series is a pandas.Series.
|
|
|
Whether this input entity is also saved with results.
|
|
|
Whether this is a 'progress' entity.
|
xpressinsight.Param
|
The configuration of a parameter entity.
|
|
|
Initializes Param with the data type or a default value (in which case data type is inferred).
|
|
|
Alias to use for the entity in the UI.
|
|
|
Check if the type is correct and check the bounds.
|
|
|
Default value for this scalar.
|
|
|
The type of values in this entity.
|
|
|
Name of the entity.
|
|
|
Format string for entity values.
|
|
|
Whether the entity is hidden.
|
|
|
Check whether the entity is managed as the given management type: input/result.
|
|
|
How the entity is managed.
|
|
|
Name of the attribute representing the entity.
|
|
|
Whether the entity can be edited from the UI.
|
|
|
Name of labels transformation series for this entity.
|
|
|
The target Python type for values in this Insight entity - e.g. the Python target type of an xpressinsight.Series is a pandas.Series.
|
|
|
Whether this input entity is also saved with results.
|
|
|
Whether this is a 'progress' entity.
|
xpressinsight.Index
|
The configuration of an index entity.
|
|
|
The constructor.
|
|
|
Alias to use for the entity in the UI.
|
|
|
Check type of given value is correct for this entity; 'name' argument is entity name to use in error message.
|
|
|
The type of values in this entity.
|
|
|
Name of the entity.
|
|
|
Format string for entity values.
|
|
|
Whether the entity is hidden.
|
|
|
Check whether the entity is managed as the given management type: input/result.
|
|
|
How the entity is managed.
|
|
|
Name of the attribute representing the entity.
|
|
|
Whether the entity can be edited from the UI.
|
|
|
Name of labels transformation series for this entity.
|
|
|
The target Python type for values in this Insight entity - e.g. the Python target type of an xpressinsight.Series is a pandas.Series.
|
|
|
Whether this input entity is also saved with results.
|
|
|
Whether this is a 'progress' entity.
|
xpressinsight.Series
|
The configuration of a Series entity, a declaration of a pandas Series data structure.
|
|
|
Initializes Series.
|
|
|
Alias to use for the entity in the UI.
|
|
|
The type of values in this entity.
|
|
|
Name of the entity.
|
|
|
Format string for entity values.
|
|
|
Whether the entity is hidden.
|
|
|
Index entities for this series.
|
|
|
Index names for this series.
|
|
|
Index types for this series.
|
|
|
Check whether the entity is managed as the given management type: input/result.
|
|
|
How the entity is managed.
|
|
|
Name of the attribute representing the entity.
|
|
|
Whether the entity can be edited from the UI.
|
|
|
Name to be used for this Pandas series.
|
|
|
Name of labels transformation series for this entity.
|
|
|
The target Python type for values in this Insight entity - e.g. the Python target type of an xpressinsight.Series is a pandas.Series.
|
|
|
Index names, modified so that each is unique.
|
|
|
Whether this input entity is also saved with results.
|
|
|
Whether this is a 'progress' entity.
|
xpressinsight.Column
|
Represent a single column within a DataFrame entity.
|
|
|
Initializes Column.
|
|
|
Alias to use for the entity in the UI.
|
|
|
The value used to fill empty cells in this column when the DataFrame is loaded from the Insight scenario.
|
|
|
The type of values in this entity.
|
|
|
Name of the entity.
|
|
|
Format string for entity values.
|
|
|
Whether the entity is hidden.
|
|
|
Check whether the entity is managed as the given management type: input/result.
|
|
|
How the entity is managed.
|
|
|
Name of the attribute representing the entity.
|
|
|
Whether the entity can be edited from the UI.
|
|
|
Name of labels transformation series for this entity.
|
|
|
The target Python type for values in this Insight entity - e.g. the Python target type of an xpressinsight.Series is a pandas.Series.
|
|
|
Whether this input entity is also saved with results.
|
|
|
Whether this is a 'progress' entity.
|
xpressinsight.DataFrame
|
The configuration of a DataFrame entity.
|
|
|
Initializes DataFrame.
|
|
|
Columns in this DataFrame.
|
|
|
Index entities for this DataFrame.
|
|
|
Names of index columns for this DataFrame.
|
|
|
Types of index columns for this DataFrame.
|
|
|
Check whether the DataFrame has a column that is managed as the given management type.
|
|
|
Name of the attribute representing the entity.
|
|
|
The target Python type for values in this Insight entity - e.g. the Python target type of an xpressinsight.Series is a pandas.Series.
|
|
|
Index names, modified so that each is unique.
|
|
|
Check whether DataFrame has any columns where the update_progress attribute is True.
|
© 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.