pytrendy 1.1.11.dev3__tar.gz → 1.1.11.dev4__tar.gz

{pytrendy-1.1.11.dev3 → pytrendy-1.1.11.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytrendy
-Version: 1.1.11.dev3
+Version: 1.1.11.dev4
 Summary: Trend Detection in Python. Applicable for real-world industry use cases in time series.
 License: MIT License
          
@@ -106,20 +106,21 @@ The best detected trend is Down between dates 2025-05-09 - 2025-06-17
 
 Full Results:
 -------------------------------------------------------------------------------
-            direction       start         end  days  total_change  change_rank
-time_index                                                                   
-1                 Up  2025-01-02  2025-01-24    22     14.013348            5
-2               Down  2025-01-25  2025-02-05    11    -13.564214            6
-3               Flat  2025-02-06  2025-02-09     3           NaN            7
-4                 Up  2025-02-10  2025-03-14    32     24.632035            3
-5               Flat  2025-03-15  2025-03-17     2           NaN            8
-6               Down  2025-03-18  2025-04-01    14    -22.721861            4
-7                 Up  2025-04-02  2025-05-08    36     72.611833            2
-8               Down  2025-05-09  2025-06-17    39    -73.253968            1
-9               Flat  2025-06-18  2025-06-30    12           NaN            9 
+            direction       start         end  days  total_change  change_rank trend_class
+time_index                                                                               
+1                 Up  2025-01-02  2025-01-24    22     14.013348            5     gradual
+2               Down  2025-01-25  2025-02-05    11    -13.564214            6     gradual
+3               Flat  2025-02-06  2025-02-09     3     -1.168831            9         NaN
+4                 Up  2025-02-10  2025-03-14    32     24.632035            3     gradual
+5               Flat  2025-03-15  2025-03-17     2      5.660173            7         NaN
+6               Down  2025-03-18  2025-04-01    14    -22.721861            4     gradual
+7                 Up  2025-04-02  2025-05-08    36     72.611833            2     gradual
+8               Down  2025-05-09  2025-06-17    39    -73.253968            1     gradual
+9               Flat  2025-06-18  2025-06-30    12      3.910534            8         NaN 
 -------------------------------------------------------------------------------
 ```
 
 ---
 
 **Read more in the full documentation:** [russellsb.github.io/pytrendy/main](https://russellsb.github.io/pytrendy/main/)
+

{pytrendy-1.1.11.dev3 → pytrendy-1.1.11.dev4}/README.md

@@ -49,20 +49,20 @@ The best detected trend is Down between dates 2025-05-09 - 2025-06-17
 
 Full Results:
 -------------------------------------------------------------------------------
-            direction       start         end  days  total_change  change_rank
-time_index                                                                   
-1                 Up  2025-01-02  2025-01-24    22     14.013348            5
-2               Down  2025-01-25  2025-02-05    11    -13.564214            6
-3               Flat  2025-02-06  2025-02-09     3           NaN            7
-4                 Up  2025-02-10  2025-03-14    32     24.632035            3
-5               Flat  2025-03-15  2025-03-17     2           NaN            8
-6               Down  2025-03-18  2025-04-01    14    -22.721861            4
-7                 Up  2025-04-02  2025-05-08    36     72.611833            2
-8               Down  2025-05-09  2025-06-17    39    -73.253968            1
-9               Flat  2025-06-18  2025-06-30    12           NaN            9 
+            direction       start         end  days  total_change  change_rank trend_class
+time_index                                                                               
+1                 Up  2025-01-02  2025-01-24    22     14.013348            5     gradual
+2               Down  2025-01-25  2025-02-05    11    -13.564214            6     gradual
+3               Flat  2025-02-06  2025-02-09     3     -1.168831            9         NaN
+4                 Up  2025-02-10  2025-03-14    32     24.632035            3     gradual
+5               Flat  2025-03-15  2025-03-17     2      5.660173            7         NaN
+6               Down  2025-03-18  2025-04-01    14    -22.721861            4     gradual
+7                 Up  2025-04-02  2025-05-08    36     72.611833            2     gradual
+8               Down  2025-05-09  2025-06-17    39    -73.253968            1     gradual
+9               Flat  2025-06-18  2025-06-30    12      3.910534            8         NaN 
 -------------------------------------------------------------------------------
 ```
 
 ---
 
-**Read more in the full documentation:** [russellsb.github.io/pytrendy/main](https://russellsb.github.io/pytrendy/main/)
+**Read more in the full documentation:** [russellsb.github.io/pytrendy/main](https://russellsb.github.io/pytrendy/main/)

{pytrendy-1.1.11.dev3 → pytrendy-1.1.11.dev4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pytrendy"
-version = "1.1.11.dev3"
+version = "1.1.11.dev4"
 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.1.11.dev3 → pytrendy-1.1.11.dev4}/pytrendy/io/plot_pytrendy.py

@@ -111,7 +111,7 @@ def plot_pytrendy(df: pd.DataFrame, value_col: str, segments_enhanced: list[dict
         ax.fill_between(df.index[mask], ymin, ymax, color=color, alpha=0.4)
         
         # Add ranking if up/down trend
-        if 'change_rank' in seg:
+        if 'change_rank' in seg and seg['direction'] in ['Up', 'Down']:
             mid_date = start + (end - start) / 2
             y_pos = ymax - (ymax - ymin) * 0.05
             ax.text(mid_date, y_pos, str(seg['change_rank']), fontsize=12,

{pytrendy-1.1.11.dev3 → pytrendy-1.1.11.dev4}/pytrendy/io/results_pytrendy.py

@@ -23,6 +23,8 @@ class PyTrendyResults:
                 List of dictionaries representing individual trend segments.
         """
         self.segments = segments
+        self.trend_segments = [seg for seg in self.segments if 'trend_class' in seg] # Get segments that are trends (exclude flats and noise)
+        
         self.set_best()
         self.set_df()
         self.set_summary()
@@ -35,10 +37,10 @@ class PyTrendyResults:
             - Identifies the best trend segment based on steepness and duration.
             - The segment with the lowest `change_rank` is selected as the best.
         """
-        if len(self.segments) == 0 or not any('change_rank' in segment for segment in self.segments):
+        if len(self.trend_segments) == 0:
             self.best = None
             return
-        self.best = min(self.segments, key=lambda x: x.get('change_rank', math.inf))
+        self.best = min(self.trend_segments, key=lambda x: x.get('change_rank', math.inf))
 
     def set_summary(self) -> None:
         """
@@ -54,19 +56,23 @@ class PyTrendyResults:
             summary['df'] = pd.DataFrame()
             return
 
+        # Count the number of segments per direction type (Up, Down, Flat, Noise)
         direction_counts = Counter(seg["direction"] for seg in self.segments)
         summary["direction_counts"] = dict(direction_counts)
         
-        trend_class_counts = Counter(seg["trend_class"] for seg in self.segments if "trend_class" in seg)
+        # Count number of segments per trend classs (abrupt, gradual)
+        trend_class_counts = Counter(seg["trend_class"] for seg in self.trend_segments)
         summary["trend_class_counts"] = dict(trend_class_counts)
 
-        changes = [seg.get("total_change", 0) for seg in self.segments if "total_change" in seg]
+        # Get array of total change from trends and get max (best) total change
+        changes = [seg.get("total_change", 0) for seg in self.trend_segments]
         summary['highest_total_change'] = np.max(changes) if len(changes) > 0 else None
 
         # Set summary df (without extra details)
         df = pd.DataFrame(self.segments)
-        cols = ['time_index', 'direction', 'start', 'end', 'days']
-        if len(changes) > 1: cols += ['total_change', 'change_rank', 'trend_class']
+        cols = ['time_index', 'direction', 'start', 'end', 'days', 'total_change', 'change_rank']
+        if len(changes) > 1:  #  only include trend_class if atleast one trend exists
+            cols += ['trend_class']
         df = df[cols]
 
         df = df.set_index('time_index')

{pytrendy-1.1.11.dev3 → pytrendy-1.1.11.dev4}/pytrendy/post_processing/segments_analyse.py

@@ -16,7 +16,7 @@ def analyse_segments(df: pd.DataFrame, value_col: str, segments: list[dict]) ->
 
     Metrics added include:
     
-    - Absolute and percent change (based on min/max values)
+    - Absolute and percent change (based on start/end values)
 
     - Duration in days
 
@@ -47,19 +47,10 @@ def analyse_segments(df: pd.DataFrame, value_col: str, segments: list[dict]) ->
         df_segment = df.loc[segment['start']:segment['end']]
 
         # Calculate absolute and relative change from first point to last point of trend.
-        # (Using min/max instead of first/last to be more robust to noise.)
-        val_min = df_segment[value_col].min()
-        val_max = df_segment[value_col].max()
-        if segment['direction'] == 'Up':  # max - min
-            segment_enhanced['change'] = float(val_max - val_min)
-            segment_enhanced['pct_change'] = (
-                float(val_max / val_min - 1) if val_min != 0 else np.nan
-            )
-        elif segment['direction'] == 'Down':  # min - max
-            segment_enhanced['change'] = float(val_min - val_max)
-            segment_enhanced['pct_change'] = (
-                float(val_min / val_max - 1) if val_max != 0 else np.nan
-            )
+        val_start = df_segment[value_col].iloc[0]
+        val_end = df_segment[value_col].iloc[-1]
+        segment_enhanced['change'] = float(val_end - val_start)
+        segment_enhanced['pct_change'] = (float(val_end / val_start - 1) if val_start != 0 else np.nan)
 
         # Calculate days & cumulative total change
         days = (pd.to_datetime(segment['end']) - pd.to_datetime(segment['start'])).days
@@ -68,8 +59,7 @@ def analyse_segments(df: pd.DataFrame, value_col: str, segments: list[dict]) ->
         segment_enhanced['days'] = days # set days
 
         # Calculate cumulative total change
-        if segment['direction'] in ['Up', 'Down']:
-            segment_enhanced['total_change'] = float(df_segment[value_col].diff().sum())
+        segment_enhanced['total_change'] = float(df_segment[value_col].diff().sum())
 
         # Calculate Signal to Noise Ratio
         signal_power = np.mean(df_segment['signal']**2)
@@ -83,8 +73,7 @@ def analyse_segments(df: pd.DataFrame, value_col: str, segments: list[dict]) ->
 
     # Rank change, by steepest to shallowest change
     sorted_segments = sorted(segments_enhanced, key=lambda x: abs(x.get('total_change', 0)), reverse=True)
-    sorted_trends = [seg for seg in sorted_segments if 'total_change' in seg and abs(seg['total_change']) > 0]
-    for i, seg in enumerate(sorted_trends):
+    for i, seg in enumerate(sorted_segments):
         j = seg['time_index'] - 1
         segments_enhanced[j]['change_rank'] = int(i+1)
 

{pytrendy-1.1.11.dev3 → pytrendy-1.1.11.dev4}/pytrendy/post_processing/segments_refine/artifact_cleanup.py

@@ -380,4 +380,4 @@ def fill_in_flats(df: pd.DataFrame, segments: list[dict]) -> list[dict]:
                 direction='Flat'
             ))
 
-    return segments_refined
+    return segments_refined

{pytrendy-1.1.11.dev3 → pytrendy-1.1.11.dev4}/pytrendy/post_processing/segments_refine/trend_classify.py

@@ -75,4 +75,4 @@ def classify_trends(df: pd.DataFrame, value_col: str, segments: list[dict]) -> l
         if segment_length < 3:
             segments_classified[i]['trend_class'] = 'abrupt'
 
-    return segments_classified
+    return segments_classified