rics.ml.time_split.types#

Types related to splitting data.

Module Attributes

`DatetimeTypes`	Types that may be cast to `pandas.Timestamp`.
`DatetimeIterable`	Iterable that may be cast to `pandas.DatetimeIndex`.
`TimedeltaTypes`	Types that may be cast to `pandas.Timedelta`.
`Schedule`	User schedule type.
`Span`	User span type.
`Flex`	Flexibility frequency string for `floor/ceil`.
`DatetimeSplits`	A list of bounds.

Classes

`DatetimeSplitBounds`(start, mid, end)	A 3-tuple which denotes two adjacent datetime ranges.
`DatetimeSplitCounts`(data, future_data)	Relative importance of data and future_data.

DatetimeTypes#

Types that may be cast to pandas.Timestamp.

alias of Union[str, Timestamp, datetime, date, datetime64]

DatetimeIterable#

Iterable that may be cast to pandas.DatetimeIndex.

alias of Iterable[Union[str, Timestamp, datetime, date, datetime64]]

TimedeltaTypes#

Types that may be cast to pandas.Timedelta.

alias of Union[str, Timedelta, timedelta, timedelta64]

Schedule#

User schedule type.

alias of Union[DatetimeIndex, Iterable[Union[str, Timestamp, datetime, date, datetime64]], str, Timedelta, timedelta, timedelta64]

Span#

User span type. Used to determine limits from the timestamps given by a Schedule.

alias of Union[int, Literal[‘all’], str, Timedelta, timedelta, timedelta64]

Flex#

Flexibility frequency string for floor/ceil. Pass False to disable.

Options ‘auto’ (default) and True are equivalent. Available data limits (start, end) are rounded using Timestamp.floor and Timestamp.ceil, respectively. In other words, the start of the range is always rounded down while the end is rounded up.

Auto flex:

When using flex='auto' (default), if and how bounds are expanded is determined by the size of the range and by distance between the actual and desired limits.

Use settings.auto_flex to modify auto-flex behaviour.

Manual flex:

Pass an offset alias specify how limits should be rounded. To specify by how much limits may be rounded, pass '<' follow by a valid pandas.Timedelta-string.

See expand_limits() for usage examples.

alias of Union[bool, Literal[‘auto’], str]

class DatetimeSplitBounds(start: Timestamp, mid: Timestamp, end: Timestamp)[source]#