README.md in prophet-rb-0.3.1 vs README.md in prophet-rb-0.3.2

- old
+ new

@@ -20,10 +20,12 @@ gem "prophet-rb" ``` ## Simple API +### Forecasting + Get future predictions for a time series ```ruby series = { Date.parse("2020-01-01") => 100, @@ -46,16 +48,36 @@ ```ruby series = User.group_by_day(:created_at).count Prophet.forecast(series) ``` +And supports [advanced API](#advanced-api) options + +```ruby +Prophet.forecast(series, growth: "logistic", weekly_seasonality: false) +``` + +### Anomaly Detection + Detect anomalies in a time series ```ruby Prophet.anomalies(series) ``` +Specify the width of uncertainty intervals (decrease for more anomalies) + +```ruby +Prophet.anomalies(series, interval_width: 0.99) +``` + +Also supports [advanced API](#advanced-api) options + +```ruby +Prophet.anomalies(series, growth: "logistic", weekly_seasonality: false) +``` + ## Advanced API Check out the [Prophet documentation](https://facebook.github.io/prophet/docs/quick_start.html) for a great explanation of all of the features. The advanced API follows the Python API and supports the same features. It uses [Rover](https://github.com/ankane/rover) for data frames. ## Advanced Quick Start @@ -204,10 +226,10 @@ Add country-specific holidays ```ruby m = Prophet.new -m.add_country_holidays(country_name: "US") +m.add_country_holidays("US") m.fit(df) ``` Specify custom seasonalities