ScitypeSeries

class ScitypeSeries(is_univariate=None, is_equally_spaced=None, is_empty=None, has_nans=None, n_features=None, feature_names=None, dtypekind_dfip=None, feature_kind=None)[source]

Series data type. Represents a single time series.

The Series data type is an abstract data type (= scitype).

It represents a single monotonously indexed sequence, including the sub-case of “time series” if the index is interpreted as time.

Formally, an abstract Series object has:

an index \(t_1, \dots, t_T\), with \(t_i\) being an integer or an orderable datetime-like type, representing the time point (or index)
values \(y_1, \dots, y_T\), with \(y_i\), taking values in an abstract typed data frame row domain \(\mathcal{Y}\), i.e., vectors with entries being numbers (float, integer) or categorical, always the same type at the same entry

The value \(y_i\) is interpreted to be “observed at time point” \(t_i\).

The indices are assumed distinct and ordered, i.e., \(t_{i-1} < t_i\) for all \(i\).

Concrete types implementing the Series data type must specify:

variables: how the dimensions of \(\mathcal{Y}\) are represented
variable names: optional, names of the variable dimensions
time points: how the value “observed at” a given time point is represented
time index: how the time index is represented

Concrete implementations may implement only sub-cases of the full abstract type.

Parameters:

is_univariate: bool: True iff the series has one variable, i.e., \(y_i\) is a scalar
is_equally_spacedbool: True iff the series index is equally spaced, i.e., \(t_{i} - t_{i-1}\) does not depend on \(i\)
is_empty: bool: True iff the series has no variables, or no instances
has_nans: bool: True iff the the series contains NaN values
n_features: int: number of variables in the series
feature_names: list of int or object: names of variables in the series
dtypekind_dfip: list of DtypeKind enum: list of DtypeKind enum values for each feature in the series, following the data frame interface protocol. In same order as feature_names.
feature_kind: list of str: list of feature-kind strings for each feature in the series, coerced to "FLOAT" or "CATEGORICAL" type string. In same order as feature_names.

Methods

`__call__`(obj[, return_metadata, var_name, ...])	Check if obj is of this data type.
`check`(obj[, return_metadata, var_name, ...])	Check if obj is of this data type.
`clone`()	Obtain a clone of the object with same hyper-parameters and config.
`clone_tags`(estimator[, tag_names])	Clone tags from another object as dynamic override.
`create_test_instance`([parameter_set])	Construct an instance of the class, using first test parameter set.
`create_test_instances_and_names`([parameter_set])	Create list of all test instances and a list of names for them.
`get`(key[, default])	Get attribute by key.
`get_class_tag`(tag_name[, tag_value_default])	Get class tag value from class, with tag level inheritance from parents.
`get_class_tags`()	Get class tags from class, with tag level inheritance from parent classes.
`get_config`()	Get config flags for self.
`get_param_defaults`()	Get object's parameter defaults.
`get_param_names`([sort])	Get object's parameter names.
`get_params`([deep])	Get a dict of parameters values for this object.
`get_tag`(tag_name[, tag_value_default, ...])	Get tag value from instance, with tag level inheritance and overrides.
`get_tags`()	Get tags from instance, with tag level inheritance and overrides.
`get_test_params`([parameter_set])	Return testing parameter settings for the skbase object.
`is_composite`()	Check if the object is composed of other BaseObjects.
`load_from_path`(serial)	Load object from file location.
`load_from_serial`(serial)	Load object from serialized memory container.
`reset`()	Reset the object to a clean post-init state.
`save`([path, serialization_format])	Save serialized self to bytes-like object or to (.zip) file.
`set_config`(**config_dict)	Set config flags to given values.
`set_params`(**params)	Set the parameters of this object.
`set_random_state`([random_state, deep, ...])	Set random_state pseudo-random seed parameters for self.
`set_tags`(**tag_dict)	Set instance level tag overrides to given values.