prophet-rb 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fd9d15984092c132cd6f13fa633e76e989de29ddd38f3f467803f7f76036466
-  data.tar.gz: 79b66208c4473e18a2da9fe8676d806d1e993f8f2723739f6ba4592d94b2b2f4
+  metadata.gz: 455967bcdd71332715b83a6095dd9068fdcfbe5c29064315458faa31ef9f37bb
+  data.tar.gz: 7492995c53307c1c37eb8b169e32fdaac474e91e8398e41c8c7d2c9e40ea5cfb
 SHA512:
-  metadata.gz: de7a1a66e44a5846eebbdfc3fe77f7b43032e30562c276fb4e4422086887f689699046c683e4bc55b5291ac2cc80c28a9b8cdd5a2bddb218162a9c5fde6ebd30
-  data.tar.gz: 5ab4054e4e4f77a6b3255ee1f9fcb70b5e3aa02d74912960f2c2817c2b4e730d9c896959cd2e8dcaa0dc66338cece5e0130d967a3cdcc2b7c913f9a8fffb524b
+  metadata.gz: 2627962cf86a8eaa3b7018aa82157b6b53837817ab642782078372368199e8a80417ec93dc7e0bb8f44a5b8f32a9ba3492e18433579c13e24215dea84f9aa961
+  data.tar.gz: 118b13c8aefe85854f64d84a4bbcd0b72bf5fd77e46bc0c99902c0651c7530ca413c1a388820a894c4ed08f779db7cf4027bc5682dbe9dcb6081ad1d6ce1ee97

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.5.2 (2024-10-26)
+
+- Fixed warning with `plot` method
+
+## 0.5.1 (2024-05-06)
+
+- Added `scaling` option
+- Fixed issue with yearly seasonality being enabled without enough data
+- Fixed issue with internal columns in `predict` output (`col`, `col_lower`, and `col_upper`)
+
 ## 0.5.0 (2023-09-05)
 
 - Added support for Polars

data/LICENSE.txt

@@ -1,7 +1,7 @@
 MIT License
 
 Copyright (c) Facebook, Inc. and its affiliates.
-Copyright (c) 2020-2023 Andrew Kane
+Copyright (c) 2020-2024 Andrew Kane
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -10,7 +10,7 @@ Supports:
 
 And gracefully handles missing data
 
-[![Build Status](https://github.com/ankane/prophet-ruby/workflows/build/badge.svg?branch=master)](https://github.com/ankane/prophet-ruby/actions)
+[![Build Status](https://github.com/ankane/prophet-ruby/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/prophet-ruby/actions)
 
 ## Installation
 
@@ -454,15 +454,6 @@ m2 = Prophet.new.fit(df, init: stan_init(m1)) # Adding the last day, warm-starti
 
 - [Forecasting at Scale](https://peerj.com/preprints/3190.pdf)
 
-## Upgrading
-
-### 0.2.0
-
-Prophet now uses [Rover](https://github.com/ankane/rover) instead of Daru. Two changes you may need to make are:
-
-- `Rover.read_csv` instead of `Daru::DataFrame.from_csv`
-- `df[["ds", "yhat"]]` instead of `df["ds", "yhat"]`
-
 ## Credits
 
 This library was ported from the [Prophet Python library](https://github.com/facebook/prophet) and is available under the same license.

data/lib/prophet/forecaster.rb

@@ -27,7 +27,8 @@ module Prophet
       changepoint_prior_scale: 0.05,
       mcmc_samples: 0,
       interval_width: 0.80,
-      uncertainty_samples: 1000
+      uncertainty_samples: 1000,
+      scaling: "absmax"
     )
       @growth = growth
 
@@ -54,6 +55,10 @@ module Prophet
       @mcmc_samples = mcmc_samples
       @interval_width = interval_width
       @uncertainty_samples = uncertainty_samples
+      if !["absmax", "minmax"].include?(scaling)
+        raise ArgumentError, "scaling must be one of \"absmax\" or \"minmax\""
+      end
+      @scaling = scaling
 
       # Set during fitting or by other methods
       @start = nil
@@ -124,7 +129,7 @@ module Prophet
       reserved_names = [
         "trend", "additive_terms", "daily", "weekly", "yearly",
         "holidays", "zeros", "extra_regressors_additive", "yhat",
-        "extra_regressors_multiplicative", "multiplicative_terms",
+        "extra_regressors_multiplicative", "multiplicative_terms"
       ]
       rn_l = reserved_names.map { |n| "#{n}_lower" }
       rn_u = reserved_names.map { |n| "#{n}_upper" }
@@ -189,7 +194,11 @@ module Prophet
           raise ArgumentError, "Expected column \"floor\"."
         end
       else
-        df["floor"] = 0
+        if @scaling == "absmax"
+          df["floor"] = 0
+        elsif @scaling == "minmax"
+          df["floor"] = @y_min
+        end
       end
 
       if @growth == "logistic"
@@ -219,11 +228,22 @@ module Prophet
 
       if @growth == "logistic" && df.include?("floor")
         @logistic_floor = true
-        floor = df["floor"]
+        if @scaling == "absmax"
+          @y_min = (df["y"] - df["floor"]).abs.min.to_f
+          @y_scale = (df["y"] - df["floor"]).abs.max.to_f
+        elsif @scaling == "minmax"
+          @y_min = df["floor"].min
+          @y_scale = (df["cap"].max - @y_min).to_f
+        end
       else
-        floor = 0.0
+        if @scaling == "absmax"
+          @y_min = 0.0
+          @y_scale = df["y"].abs.max.to_f
+        elsif @scaling == "minmax"
+          @y_min = df["y"].min
+          @y_scale =  (df["y"].max - @y_min).to_f
+        end
       end
-      @y_scale = (df["y"] - floor).abs.max
       @y_scale = 1 if @y_scale == 0
       @start = df["ds"].min
       @t_scale = df["ds"].max - @start
@@ -547,7 +567,7 @@ module Prophet
       days = 86400
 
       # Yearly seasonality
-      yearly_disable = last - first < 370 * days
+      yearly_disable = last - first < 730 * days
       fourier_order = parse_seasonality_args("yearly", @yearly_seasonality, yearly_disable, 10)
       if fourier_order > 0
         @seasonalities["yearly"] = {
@@ -807,7 +827,7 @@ module Prophet
 
       x = seasonal_features.to_numo
       data = {}
-      component_cols.vector_names.each do |component|
+      (component_cols.vector_names - ["col"]).each do |component|
         beta_c =  @params["beta"] * component_cols[component].to_numo
 
         comp = x.dot(beta_c.transpose)
@@ -1052,7 +1072,7 @@ module Prophet
       "yearly_seasonality", "weekly_seasonality", "daily_seasonality",
       "seasonality_mode", "seasonality_prior_scale", "changepoint_prior_scale",
       "holidays_prior_scale", "mcmc_samples", "interval_width", "uncertainty_samples",
-      "y_scale", "logistic_floor", "country_holidays", "component_modes"
+      "y_scale", "y_min", "scaling", "logistic_floor", "country_holidays", "component_modes"
     ]
 
     PD_SERIES = ["changepoints", "history_dates", "train_holiday_names"]
@@ -1169,6 +1189,12 @@ module Prophet
 
       model_dict = JSON.parse(model_json)
 
+      # handle_simple_attributes_backwards_compat
+      if !model_dict["scaling"]
+        model_dict["scaling"] = "absmax"
+        model_dict["y_min"] = 0.0
+      end
+
       # We will overwrite all attributes set in init anyway
       model = Prophet.new
       # Simple types

data/lib/prophet/plot.rb

@@ -259,7 +259,7 @@ module Prophet
       end
       ax.grid(true, which: "major", c: "gray", ls: "-", lw: 1, alpha: 0.2)
       months = dates.MonthLocator.new((1..12).to_a, bymonthday: 1, interval: 2)
-      ax.xaxis.set_major_formatter(ticker.FuncFormatter.new(lambda { |x, pos=nil| dates.num2date(x).strftime("%B %-e") }))
+      ax.xaxis.set_major_formatter(ticker.FuncFormatter.new(lambda { |x, pos = nil| dates.num2date(x).strftime("%B %-e") }))
       ax.xaxis.set_major_locator(months)
       ax.set_xlabel("Day of year")
       ax.set_ylabel(name)
@@ -301,7 +301,7 @@ module Prophet
       else
         fmt_str = "%m/%d"
       end
-      ax.xaxis.set_major_formatter(ticker.FuncFormatter.new(lambda { |x, pos=nil| dates.num2date(x).strftime(fmt_str) }))
+      ax.xaxis.set_major_formatter(ticker.FuncFormatter.new(lambda { |x, pos = nil| dates.num2date(x).strftime(fmt_str) }))
       ax.set_xlabel("ds")
       ax.set_ylabel(name)
       if @seasonalities[name][:mode] == "multiplicative"
@@ -313,6 +313,7 @@ module Prophet
     def set_y_as_percent(ax)
       yticks = 100 * ax.get_yticks
       yticklabels = yticks.tolist.map { |y| "%.4g%%" % y }
+      ax.set_yticks(ax.get_yticks.tolist)
       ax.set_yticklabels(yticklabels)
       ax
     end

data/lib/prophet/stan_backend.rb

@@ -148,14 +148,14 @@ module Prophet
     def platform
       if Gem.win_platform?
         "windows"
-      elsif RbConfig::CONFIG["host_os"] =~ /darwin/i
-        if RbConfig::CONFIG["host_cpu"] =~ /arm|aarch64/i
+      elsif RbConfig::CONFIG["host_os"].match?(/darwin/i)
+        if RbConfig::CONFIG["host_cpu"].match?(/arm|aarch64/i)
           "arm64-darwin"
         else
           "x86_64-darwin"
         end
       else
-        if RbConfig::CONFIG["host_cpu"] =~ /arm|aarch64/i
+        if RbConfig::CONFIG["host_cpu"].match?(/arm|aarch64/i)
           "aarch64-linux"
         else
           "x86_64-linux"

data/lib/prophet/version.rb

@@ -1,3 +1,3 @@
 module Prophet
-  VERSION = "0.5.0"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prophet-rb
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-05 00:00:00.000000000 Z
+date: 2024-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmdstan
@@ -166,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Time series forecasting for Ruby