pytrendy 1.2.0.dev1__tar.gz → 1.2.0.dev3__tar.gz

{pytrendy-1.2.0.dev1 → pytrendy-1.2.0.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytrendy
-Version: 1.2.0.dev1
+Version: 1.2.0.dev3
 Summary: Trend Detection in Python. Applicable for real-world industry use cases in time series.
 License: MIT License
          
@@ -73,6 +73,8 @@ Description-Content-Type: text/markdown
 
 PyTrendy is a robust solution for identifying and analyzing trends in time series. Unlike other trend detection packages, it is robust to noisy & flat segments, and handles for gradual & abrupt trend cases with a high precision. It aims to be the best package for trend detection in python.
 
+**Read more in the documentation:** [russellsb.github.io/pytrendy/main](https://russellsb.github.io/pytrendy/main/)
+
 ## Features
 
 ![](https://raw.githubusercontent.com/RussellSB/pytrendy/refs/heads/develop/plots/Gradual-Cropped.gif)
@@ -120,7 +122,4 @@ time_index
 -------------------------------------------------------------------------------
 ```
 
----
-
-**Read more in the full documentation:** [russellsb.github.io/pytrendy/main](https://russellsb.github.io/pytrendy/main/)
 

{pytrendy-1.2.0.dev1 → pytrendy-1.2.0.dev3}/README.md

@@ -16,6 +16,8 @@
 
 PyTrendy is a robust solution for identifying and analyzing trends in time series. Unlike other trend detection packages, it is robust to noisy & flat segments, and handles for gradual & abrupt trend cases with a high precision. It aims to be the best package for trend detection in python.
 
+**Read more in the documentation:** [russellsb.github.io/pytrendy/main](https://russellsb.github.io/pytrendy/main/)
+
 ## Features
 
 ![](https://raw.githubusercontent.com/RussellSB/pytrendy/refs/heads/develop/plots/Gradual-Cropped.gif)
@@ -63,6 +65,3 @@ time_index
 -------------------------------------------------------------------------------
 ```
 
----
-
-**Read more in the full documentation:** [russellsb.github.io/pytrendy/main](https://russellsb.github.io/pytrendy/main/)

{pytrendy-1.2.0.dev1 → pytrendy-1.2.0.dev3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pytrendy"
-version = "1.2.0.dev1"
+version = "1.2.0.dev3"
 description = "Trend Detection in Python. Applicable for real-world industry use cases in time series."
 authors = [
     { name = "Russell Sammut Bonnici", email = "r.sammutbonnici@gmail.com" },

{pytrendy-1.2.0.dev1 → pytrendy-1.2.0.dev3}/pytrendy/detect_trends.py

@@ -1,5 +1,6 @@
 """**End-to-End Trend Detection**"""
 
+import warnings
 import pandas as pd
 from .process_signals import process_signals
 from .post_processing.segments_get import get_segments
@@ -39,8 +40,7 @@ def detect_trends(df: pd.DataFrame, date_col: str, value_col: str, plot=True, me
         method_params (dict, optional):
             Optional parameters to customize detection heuristics. Supported keys:
 
-            - **is_abrupt_padded** (`bool`): Whether to pad abrupt transitions between segments. Defaults to `False`.
-            - **abrupt_padding** (`int`): Number of days to pad around abrupt transitions. Only referenced when `is_abrupt_padded` is `True`. Defaults to `28`.
+            - **abrupt_padding** (`int`): Number of days to pad around abrupt transitions. Defaults to `0`.
             - **avoid_noise** (`bool`): Whether to avoid noisy segments in trend detection. Defaults to `True`.
         debug (bool, optional):
             If `True` will run in debug mode, outputting various additional plots and print statements. Only recommended for developers of pytrendy.
@@ -55,14 +55,22 @@ def detect_trends(df: pd.DataFrame, date_col: str, value_col: str, plot=True, me
     df[date_col] = pd.to_datetime(df[date_col])
     df.set_index(date_col, inplace=True)
     df = df[[value_col]]
+    
+    if method_params is None:
+        method_params = {} # Avoid mutable default argument by accepting None and constructing a new dict here
+
+    # Trigger deprecation warning if old parameter is used    
+    if 'is_abrupt_padded' in method_params:
+        warnings.warn(
+            "'is_abrupt_padded' in method_params is deprecated. "
+            "Use 'abrupt_padding' only instead, which is 0 by default. Set to the number of days to pad by (e.g. 28).",
+            DeprecationWarning,
+            stacklevel=2,
+        )
 
     # Configures trend detection heuristics
-    # Avoid mutable default argument by accepting None and constructing a new dict here
-    if method_params is None:
-        method_params = {}
     method_params = {
-        'is_abrupt_padded': method_params.get('is_abrupt_padded', False),
-        'abrupt_padding': method_params.get('abrupt_padding', 28),
+        'abrupt_padding': method_params.get('abrupt_padding', 0),
         'avoid_noise': method_params.get('avoid_noise', True),
     }
 

{pytrendy-1.2.0.dev1 → pytrendy-1.2.0.dev3}/pytrendy/post_processing/segments_refine/__init__.py

@@ -29,8 +29,7 @@ def refine_segments(df: pd.DataFrame, value_col: str, segments: list[dict], meth
         segments (list): Initial segment list from detection.
         method_params (dict): Optional parameters for abrupt padding and control. Supported keys:
 
-            - **is_abrupt_padded** (`bool`): Whether to pad abrupt segments. Defaults to `False`.
-            - **abrupt_padding** (`int`): Number of days to pad. Defaults to `28`.
+            - **abrupt_padding** (`int`): Number of days to pad. Defaults to `0`.
 
     Returns:
         list: Final refined segment list.

{pytrendy-1.2.0.dev1 → pytrendy-1.2.0.dev3}/pytrendy/post_processing/segments_refine/abrupt_shaving.py

@@ -22,8 +22,7 @@ def shave_abrupt_trends(df: pd.DataFrame, value_col: str, segments: list[dict],
         segments (list): List of segment dictionaries with `'trend_class': 'abrupt'`.
         method_params (dict): Optional parameters for padding and control. Supported keys:
 
-            - **is_abrupt_padded** (`bool`): Whether to pad abrupt segments. Defaults to `False`.
-            - **abrupt_padding** (`int`): Number of days to pad. Defaults to `28`.
+            - **abrupt_padding** (`int`): Number of days to pad. Defaults to `0`.
 
     Returns:
         list: Refined segment list with adjusted abrupt boundaries.
@@ -124,7 +123,7 @@ def shave_abrupt_trends(df: pd.DataFrame, value_col: str, segments: list[dict],
 
     # Second pass to pad segments if specified
     segments_padded = deepcopy(segments_refined)
-    if method_params.get('is_abrupt_padded', False) == True:
+    if method_params.get('abrupt_padding', 0) >= 0:
 
         meta_df = pd.DataFrame(segments_refined) # metadata df, to filter by datetime easily
         meta_df['start'] = pd.to_datetime(meta_df['start'])

{pytrendy-1.2.0.dev1 → pytrendy-1.2.0.dev3}/pytrendy/post_processing/segments_refine/artifact_cleanup.py

@@ -18,8 +18,7 @@ def clean_artifacts(df: pd.DataFrame, value_col: str, segments_refined: list[dic
         segments_refined (list): List of segment dictionaries potentially with artifacts from post-processing.
         method_params (dict): Optional parameters for cleanup behavior. Supported keys:
 
-            - **is_abrupt_padded** (`bool`): If `True`, skips neighboring-noise checks around abrupt segments. Defaults to `False`.
-            - **abrupt_padding** (`int`): Padding window in days used by abrupt refinement; included for pipeline consistency. Defaults to `28`.
+            - **abrupt_padding** (`int`): Padding window in days used by abrupt refinement; included for pipeline consistency. Defaults to `0`.
             - **avoid_noise** (`bool`): Whether to avoid noisy segments in trend detection. Defaults to `True`.
         inverse_only (bool): If True, only perform inverse checks and skip other artifact cleanups. Useful for final cleanup pass after flat fill ins.