SeriesXarray

SeriesXarray

class SeriesXarray(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]

Data type: xarray based specification of single time series.

Name: xr.DataArray

Short description:

An xarray.DataArray representing a single time series, where:

• Each row corresponds to a time point.

• Columns represent variables or features.

• Coordinates provide additional metadata for the time index and variables.

Long description:

The xr.DataArray :term:mtype is a concrete specification that implements the Series :term:scitype, i.e., the abstract type for time series data.

An object obj: xarray.DataArray follows the specification iff:

• structure convention:

  • obj is a 2D array-like structure with shape (n_timepoints, n_features).

  • obj.coords must include:

    • A time-like index (dim_0) which is either Int64Index, RangeIndex, DatetimeIndex, or PeriodIndex, and it must be monotonic.

    • A variable-like index (dim_1) for feature/variable names (optional).

• time index:

  • The dim_0 coordinate is interpreted as the time index.

• time points:

  • Each row of obj represents a single time point.

  • Rows with the same dim_0 value correspond to the same time point.

• variables:

  • Columns represent different variables (or features).

  • Column names are stored in dim_1 if present.

• variable names:

  • The variable names are the column names (dim_1), if present.

• metadata:

  • Additional metadata (e.g., attributes) may be included in obj.attrs.

Capabilities:

• can represent univariate or multivariate time series

• requires equally spaced time points (if time index is specified)

• supports missing values

• cannot represent series with differing sets of variables

Parameters:

is_univariate: bool

True iff series has one variable

is_equally_spaced: bool

True iff series index is equally spaced

is_empty: bool

True iff series has no variables or no instances

has_nans: bool

True iff the series contains NaN values

n_features: int

number of variables in series

feature_names: list of int or object

names of variables in series

dtypekind_dfip: list of DtypeKind enum

list of DtypeKind enum values for each feature in the panel, following the data frame interface protocol

feature_kind: list of str

list of feature kind strings for each feature in the panel, coerced to FLOAT or CATEGORICAL type

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.