rics.ml.time_split.types#
Types related to splitting data.
Module Attributes
Types that may be cast to |
|
Iterable that may be cast to |
|
Types that may be cast to |
|
User schedule type. |
|
User span type. |
|
Flexibility frequency string for |
|
A list of bounds. |
Classes
Keyword arguments for creating a |
|
|
A 3-tuple which denotes two adjacent datetime ranges. |
|
Relative importance of data and future_data. |
- DatetimeTypes: TypeAlias = str | pandas._libs.tslibs.timestamps.Timestamp | datetime.datetime | datetime.date | numpy.datetime64#
Types that may be cast to
pandas.Timestamp
.
- DatetimeIterable#
Iterable that may be cast to
pandas.DatetimeIndex
.alias of
Iterable
[str
|Timestamp
|datetime
|date
|datetime64
]
- TimedeltaTypes: TypeAlias = str | pandas._libs.tslibs.timedeltas.Timedelta | datetime.timedelta | numpy.timedelta64#
Types that may be cast to
pandas.Timedelta
.
- Schedule#
User schedule type.
alias of
Union
[DatetimeIndex
,Iterable
[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
. PassFalse
to disable.
- class DatetimeSplitBounds(start: Timestamp, mid: Timestamp, end: Timestamp)[source]#
Bases:
NamedTuple
A 3-tuple which denotes two adjacent datetime ranges.
- DatetimeSplits#
A list of bounds.
alias of
list
[DatetimeSplitBounds
]
- class DatetimeSplitCounts(data: int, future_data: int)[source]#
Bases:
NamedTuple
Relative importance of data and future_data.
- class DatetimeIndexSplitterKwargs[source]#
Bases:
TypedDict
Keyword arguments for creating a
DatetimeIndexSplitter
.The
DatetimeIndexSplitter
is the backing type for all splitting logic. It is not exposed directly to users. Seesplit()
or one of the related functions for user-facing APIs.- schedule: DatetimeIndex | Iterable[str | Timestamp | datetime | date | datetime64] | str | Timedelta | timedelta | timedelta64#