time-split 0.2.0__tar.gz → 0.2.1__tar.gz

{time_split-0.2.0 → time_split-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: time-split
-Version: 0.2.0
+Version: 0.2.1
 Summary: Time-based k-fold validation splits for heterogeneous data.
 Home-page: https://github.com/rsundqvist/time-split
 Author: Richard Sundqvist

{time_split-0.2.0 → time_split-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "time-split"
-version = "0.2.0"
+version = "0.2.1"
 description = "Time-based k-fold validation splits for heterogeneous data."
 authors = ["Richard Sundqvist <richard.sundqvist@live.se>"]
 

{time_split-0.2.0 → time_split-0.2.1}/src/time_split/__init__.py

@@ -11,6 +11,6 @@ __all__ = [
     "__version__",  # Make MyPy happy
 ]
 
-__version__ = "0.2.0"
+__version__ = "0.2.1"
 
 _logging.getLogger(__name__).addHandler(_logging.NullHandler())

{time_split-0.2.0 → time_split-0.2.1}/src/time_split/_backend/_limits.py

@@ -21,7 +21,7 @@ def expand_limits(limits: LimitsTuple, *, flex: Flex | LevelTuple | Iterable[Lev
     """Derive the `"real"` bounds of `limits`.
 
     Args:
-        limits: A tuple ``(lo, hi)`` of timestamps.
+        limits: A tuple ``(min, max)`` of timestamps.
         flex: Flex arguments as described in the :ref:`User guide`. Also supports level-tuples
             ``[(start_at, round_to, tolerance)...]``. Passing ``flex=[settings.auto_flex.day, settings.auto_flex.hour]``
             is equivalent to ``flex='auto'``.

{time_split-0.2.0 → time_split-0.2.1}/src/time_split/integration/pandas/_impl.py

@@ -24,12 +24,12 @@ def split_pandas(
 ) -> Iterable[DatetimeSplit[PandasT]]:
     """Split a pandas type.
 
-    This function splits indexed data (i.e. ``Series`` and ``DataFrame``, not the index itself. Use
-    :func:`time_split.split <time_split.split>` for pandas ``Index`` types, setting ``available=data.index``.
+    This function splits indexed data (i.e. ``Series`` and ``DataFrame``), not the index itself. Use
+    :func:`time_split.split` for pandas ``Index`` types, setting ``available=data.index``.
 
     Args:
         data: A pandas data container type to split; either ``Series`` or a ``DataFrame``.
-        time_column: A column in `data` to split on. Use ``data`.index`` if ``None``.
+        time_column: A column in `data` to split on. Use ``data.index`` if ``None``.
         log_progress: {log_progress}
         **kwargs: {DatetimeIndexSplitterKwargs}
 
@@ -39,7 +39,7 @@ def split_pandas(
         Tuples ``(data, future_data, bounds)``.
 
     Raises:
-        TypeError: If `time_column` does not denote a datetime index-like field.
+        TypeError: If `time_column` is not datetime-like.
 
     """
     indexer = _Indexer(time_column)

{time_split-0.2.0 → time_split-0.2.1}/src/time_split/integration/polars/_impl.py

@@ -33,7 +33,7 @@ def split_polars(
         Tuples ``(data, future_data, bounds)``.
 
     Raises:
-        TypeError: If `time_column` does not denote a datetime index-like field.
+        TypeError: If `time_column` is not datetime-like.
 
     """
     indexer = _Indexer(time_column)

{time_split-0.2.0 → time_split-0.2.1}/src/time_split/settings.py

@@ -8,7 +8,7 @@ from . import types as _tst
 class auto_flex:  # noqa: N801
     """Configuration for the `'auto'` :attr:`~time_split.types.Flex` logic.
 
-    This class determines how ``(lo, hi)``-tuples are expanded when flexible bounds are enabled.
+    This class determines how ``(min, max)``-tuples are expanded when flexible bounds are enabled.
     """
 
     SANITY_CHECK: bool = True

{time_split-0.2.0 → time_split-0.2.1}/src/time_split/types.py

@@ -27,7 +27,7 @@ class DatetimeSplitBounds(_t.NamedTuple):
     start: _pd.Timestamp
     """Left (inclusive) limit of the `data` range."""
     mid: _pd.Timestamp
-    """Schedule timestamp.
+    """Schedule timestamp; simulated :attr:`~.DatetimeSplit.training_date`.
 
     Right (exclusive) limit of the `data` range, left (inclusive) limit of the `future_data` range.
 
@@ -50,10 +50,10 @@ class DatetimeSplitCounts(_t.NamedTuple):
 
 
 class DatetimeIndexSplitterKwargs(_t.TypedDict, total=False):
-    """Keyword arguments for creating a ``DatetimeIndexSplitter``.
+    """Keyword arguments for :class:`~time_split.support.DatetimeIndexSplitter`.
 
-    The :class:`time_split.support.DatetimeIndexSplitter` is the backend implementation for the splitting logic. In most
-    cases, it should not be used directly. See func:`.split` or one of the related functions for user-facing APIs.
+    The ``DatetimeIndexSplitter`` is a backend implementation. In most cases, it should not be used directly. See
+    :func:`time_split.split` or one of the related functions for user-facing APIs.
     """
 
     schedule: _t.Required[Schedule]