• Stars
    star
    17,943
  • Rank 1,486 (Top 0.03 %)
  • Language
    Python
  • License
    MIT License
  • Created about 8 years ago
  • Updated 6 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Tool for producing high quality forecasts for time series data that has multiple seasonality with linear or non-linear growth.

Prophet: Automatic Forecasting Procedure

Build

PyPI Version PyPI Downloads Monthly PyPI Downloads All

CRAN Version CRAN Downloads Monthly CRAN Downloads All

Conda_Version


2023 Update: We discuss our plans for the future of Prophet in this blog post: facebook/prophet in 2023 and beyond


Prophet is a procedure for forecasting time series data based on an additive model where non-linear trends are fit with yearly, weekly, and daily seasonality, plus holiday effects. It works best with time series that have strong seasonal effects and several seasons of historical data. Prophet is robust to missing data and shifts in the trend, and typically handles outliers well.

Prophet is open source software released by Facebook's Core Data Science team. It is available for download on CRAN and PyPI.

Important links

Installation in R - CRAN

⚠️ The CRAN version of prophet is fairly outdated. To get the latest bug fixes and updated country holiday data, we suggest installing the latest release.

Prophet is a CRAN package so you can use install.packages.

install.packages('prophet')

After installation, you can get started!

Installation in R - Latest release

install.packages('remotes')
remotes::install_github('facebook/prophet@*release', subdir = 'R')

Experimental backend - cmdstanr

You can also choose an experimental alternative stan backend called cmdstanr. Once you've installed prophet, follow these instructions to use cmdstanr instead of rstan as the backend:

# R
# We recommend running this in a fresh R session or restarting your current session
install.packages(c("cmdstanr", "posterior"), repos = c("https://mc-stan.org/r-packages/", getOption("repos")))

# If you haven't installed cmdstan before, run:
cmdstanr::install_cmdstan()
# Otherwise, you can point cmdstanr to your cmdstan path:
cmdstanr::set_cmdstan_path(path = <your existing cmdstan>)

# Set the R_STAN_BACKEND environment variable
Sys.setenv(R_STAN_BACKEND = "CMDSTANR")

Windows

On Windows, R requires a compiler so you'll need to follow the instructions provided by rstan. The key step is installing Rtools before attempting to install the package.

If you have custom Stan compiler settings, install from source rather than the CRAN binary.

Installation in Python - PyPI release

Prophet is on PyPI, so you can use pip to install it.

python -m pip install prophet
  • From v0.6 onwards, Python 2 is no longer supported.
  • As of v1.0, the package name on PyPI is "prophet"; prior to v1.0 it was "fbprophet".
  • As of v1.1, the minimum supported Python version is 3.7.

After installation, you can get started!

Anaconda

Prophet can also be installed through conda-forge.

conda install -c conda-forge prophet

Installation in Python - Development version

To get the latest code changes as they are merged, you can clone this repo and build from source manually. This is not guaranteed to be stable.

git clone https://github.com/facebook/prophet.git
cd prophet/python
python -m pip install -e .

By default, Prophet will use a fixed version of cmdstan (downloading and installing it if necessary) to compile the model executables. If this is undesired and you would like to use your own existing cmdstan installation, you can set the environment variable PROPHET_REPACKAGE_CMDSTAN to False:

export PROPHET_REPACKAGE_CMDSTAN=False; python -m pip install -e .

Linux

Make sure compilers (gcc, g++, build-essential) and Python development tools (python-dev, python3-dev) are installed. In Red Hat systems, install the packages gcc64 and gcc64-c++. If you are using a VM, be aware that you will need at least 4GB of memory to install prophet, and at least 2GB of memory to use prophet.

Windows

Using cmdstanpy with Windows requires a Unix-compatible C compiler such as mingw-gcc. If cmdstanpy is installed first, one can be installed via the cmdstanpy.install_cxx_toolchain command.

Changelog

Version 1.1.5 (2023.10.10)

Python

  • Upgraded cmdstan version to 2.33.1, enabling Apple M2 support.
  • Added pre-built wheels for macOS arm64 architecture (M1, M2 chips)
  • Added argument scaling to the Prophet() instantiation. Allows minmax scaling on y instead of absmax scaling (dividing by the maximum value). scaling='absmax' by default, preserving the behaviour of previous versions.
  • Added argument holidays_mode to the Prophet() instantiation. Allows holidays regressors to have a different mode than seasonality regressors. holidays_mode takes the same value as seasonality_mode if not specified, preserving the behaviour of previous versions.
  • Added two methods to the Prophet object: preprocess() and calculate_initial_params(). These do not need to be called and will not change the model fitting process. Their purpose is to provide clarity on the pre-processing steps taken (y scaling, creating fourier series, regressor scaling, setting changepoints, etc.) before the data is passed to the stan model.
  • Added argument extra_output_columns to cross_validation(). The user can specify additional columns from predict() to include in the final output alongside ds and yhat, for example extra_output_columns=['trend'].
  • prophet's custom hdays module was deprecated last version and is now removed.

R

  • Updated holidays data based on holidays version 0.34.

Version 1.1.4 (2023.05.30)

Python

  • We now rely solely on holidays package for country holidays.
  • Upgraded cmdstan version to 2.31.0, enabling Apple M1 support.
  • Fixed bug with Windows installation caused by long paths.

R

  • Updated holidays data based on holidays version 0.25.

Version 1.1.2 (2023.01.20)

Python

  • Sped up .predict() by up to 10x by removing intermediate DataFrame creations.
  • Sped up fourier series generation, leading to at least 1.5x speed improvement for train() and predict() pipelines.
  • Fixed bug in how warm start values were being read.
  • Wheels are now version-agnostic.

R

  • Fixed a bug in construct_holiday_dataframe()
  • Updated holidays data based on holidays version 0.18.

Version 1.1.1 (2022.09.08)

  • (Python) Improved runtime (3-7x) of uncertainty predictions via vectorization.
  • Bugfixes relating to Python package versions and R holiday objects.

Version 1.1 (2022.06.25)

  • Replaced pystan2 dependency with cmdstan + cmdstanpy.
  • Pre-packaged model binaries for Python package, uploaded binary distributions to PyPI.
  • Improvements in the stan model code, cross-validation metric calculations, holidays.

Version 1.0 (2021.03.28)

  • Python package name changed from fbprophet to prophet
  • Fixed R Windows build issues to get latest version back on CRAN
  • Improvements in serialization, holidays, and R timezone handling
  • Plotting improvements

Version 0.7 (2020.09.05)

  • Built-in json serialization
  • Added "flat" growth option
  • Bugfixes related to holidays and pandas
  • Plotting improvements
  • Improvements in cross validation, such as parallelization and directly specifying cutoffs

Version 0.6 (2020.03.03)

  • Fix bugs related to upstream changes in holidays and pandas packages.
  • Compile model during first use, not during install (to comply with CRAN policy)
  • cmdstanpy backend now available in Python
  • Python 2 no longer supported

Version 0.5 (2019.05.14)

  • Conditional seasonalities
  • Improved cross validation estimates
  • Plotly plot in Python
  • Bugfixes

Version 0.4 (2018.12.18)

  • Added holidays functionality
  • Bugfixes

Version 0.3 (2018.06.01)

  • Multiplicative seasonality
  • Cross validation error metrics and visualizations
  • Parameter to set range of potential changepoints
  • Unified Stan model for both trend types
  • Improved future trend uncertainty for sub-daily data
  • Bugfixes

Version 0.2.1 (2017.11.08)

  • Bugfixes

Version 0.2 (2017.09.02)

  • Forecasting with sub-daily data
  • Daily seasonality, and custom seasonalities
  • Extra regressors
  • Access to posterior predictive samples
  • Cross-validation function
  • Saturating minimums
  • Bugfixes

Version 0.1.1 (2017.04.17)

  • Bugfixes
  • New options for detecting yearly and weekly seasonality (now the default)

Version 0.1 (2017.02.23)

  • Initial release

License

Prophet is licensed under the MIT license.

More Repositories

1

react

The library for web and native user interfaces.
JavaScript
227,971
star
2

react-native

A framework for building native applications using React
C++
118,682
star
3

create-react-app

Set up a modern web app by running one command.
JavaScript
101,913
star
4

docusaurus

Easy to maintain open source documentation websites.
TypeScript
56,059
star
5

jest

Delightful JavaScript Testing.
TypeScript
41,554
star
6

rocksdb

A library that provides an embeddable, persistent key-value store for fast storage.
C++
28,328
star
7

folly

An open-source C++ library developed and used at Facebook.
C++
27,122
star
8

zstd

Zstandard - Fast real-time compression algorithm
C
22,448
star
9

flow

Adds static typing to JavaScript to improve developer productivity and code quality.
OCaml
22,068
star
10

lexical

Lexical is an extensible text editor framework that provides excellent reliability, accessibility and performance.
TypeScript
19,616
star
11

relay

Relay is a JavaScript framework for building data-driven React applications.
Rust
18,191
star
12

hhvm

A virtual machine for executing programs written in Hack.
Hack
18,048
star
13

fresco

An Android library for managing images and the memory they use.
Java
17,041
star
14

yoga

Yoga is an embeddable layout engine targeting web standards.
C++
16,928
star
15

infer

A static analyzer for Java, C, C++, and Objective-C
OCaml
14,715
star
16

flipper

A desktop debugging platform for mobile developers.
TypeScript
13,221
star
17

watchman

Watches files and records, or triggers actions, when they change.
C++
12,294
star
18

react-devtools

An extension that allows inspection of React component hierarchy in the Chrome and Firefox Developer Tools.
11,030
star
19

hermes

A JavaScript engine optimized for running React Native.
C++
9,388
star
20

jscodeshift

A JavaScript codemod toolkit.
JavaScript
9,270
star
21

chisel

Chisel is a collection of LLDB commands to assist debugging iOS apps.
Python
9,090
star
22

buck

A fast build system that encourages the creation of small, reusable modules over a variety of platforms and languages.
Java
8,568
star
23

stylex

StyleX is the styling system for ambitious user interfaces.
JavaScript
8,333
star
24

proxygen

A collection of C++ HTTP libraries including an easy to use HTTP server.
C++
8,026
star
25

facebook-ios-sdk

Used to integrate the Facebook Platform with your iOS & tvOS apps.
Swift
7,720
star
26

litho

A declarative framework for building efficient UIs on Android.
Java
7,646
star
27

pyre-check

Performant type-checking for python.
OCaml
6,696
star
28

facebook-android-sdk

Used to integrate Android apps with Facebook Platform.
Kotlin
6,066
star
29

redex

A bytecode optimizer for Android apps
C++
5,991
star
30

sapling

A Scalable, User-Friendly Source Control System.
Rust
5,815
star
31

componentkit

A React-inspired view framework for iOS.
Objective-C++
5,746
star
32

fishhook

A library that enables dynamically rebinding symbols in Mach-O binaries running on iOS.
C
5,117
star
33

PathPicker

PathPicker accepts a wide range of input -- output from git commands, grep results, searches -- pretty much anything. After parsing the input, PathPicker presents you with a nice UI to select which files you're interested in. After that you can open them in your favorite editor or execute arbitrary commands.
Python
5,075
star
34

metro

πŸš‡ The JavaScript bundler for React Native
JavaScript
5,061
star
35

prop-types

Runtime type checking for React props and similar objects
JavaScript
4,446
star
36

idb

idb is a flexible command line interface for automating iOS simulators and devices
Objective-C
4,431
star
37

Haxl

A Haskell library that simplifies access to remote data, such as databases or web-based services.
Haskell
4,227
star
38

FBRetainCycleDetector

iOS library to help detecting retain cycles in runtime.
Objective-C++
4,190
star
39

memlab

A framework for finding JavaScript memory leaks and analyzing heap snapshots
TypeScript
4,187
star
40

duckling

Language, engine, and tooling for expressing, testing, and evaluating composable language rules on input strings.
Haskell
4,021
star
41

fbt

A JavaScript Internationalization Framework
JavaScript
3,849
star
42

regenerator

Source transformer enabling ECMAScript 6 generator functions in JavaScript-of-today.
JavaScript
3,817
star
43

buck2

Build system, successor to Buck
Rust
3,307
star
44

mcrouter

Mcrouter is a memcached protocol router for scaling memcached deployments.
C++
3,222
star
45

wangle

Wangle is a framework providing a set of common client/server abstractions for building services in a consistent, modular, and composable way.
C++
3,030
star
46

react-strict-dom

React Strict DOM (RSD) is a subset of React DOM, imperative DOM, and CSS that supports web and native targets
JavaScript
2,922
star
47

wdt

Warp speed Data Transfer (WDT) is an embeddedable library (and command line tool) aiming to transfer data between 2 systems as fast as possible over multiple TCP paths.
C++
2,836
star
48

igl

Intermediate Graphics Library (IGL) is a cross-platform library that commands the GPU. It provides a single low-level cross-platform interface on top of various graphics APIs (e.g. OpenGL, Metal and Vulkan).
C++
2,719
star
49

fbthrift

Facebook's branch of Apache Thrift, including a new C++ server.
C++
2,535
star
50

mysql-5.6

Facebook's branch of the Oracle MySQL database. This includes MyRocks.
C++
2,446
star
51

Ax

Adaptive Experimentation Platform
Python
2,272
star
52

fbjs

A collection of utility libraries used by other Meta JS projects.
JavaScript
1,953
star
53

jsx

The JSX specification is a XML-like syntax extension to ECMAScript.
HTML
1,945
star
54

react-native-website

The React Native website and docs
JavaScript
1,899
star
55

screenshot-tests-for-android

Generate fast deterministic screenshots during Android instrumentation tests
Java
1,733
star
56

idx

Library for accessing arbitrarily nested, possibly nullable properties on a JavaScript object.
JavaScript
1,686
star
57

TextLayoutBuilder

An Android library that allows you to build text layouts more easily.
Java
1,470
star
58

mvfst

An implementation of the QUIC transport protocol.
C++
1,433
star
59

SoLoader

Native code loader for Android
Java
1,300
star
60

facebook-python-business-sdk

Python SDK for Meta Marketing APIs
Python
1,240
star
61

ThreatExchange

Trust & Safety tools for working together to fight digital harms.
C++
1,170
star
62

CacheLib

Pluggable in-process caching engine to build and scale high performance services
C++
1,097
star
63

mariana-trench

A security focused static analysis tool for Android and Java applications.
C++
1,041
star
64

fatal

Fatal is a library for fast prototyping software in modern C++. It provides facilities to enhance the expressive power of C++. The library is heavily based on template meta-programming, while keeping the complexity under-the-hood.
C++
1,000
star
65

transform360

Transform360 is an equirectangular to cubemap transform for 360 video.
C
996
star
66

openr

Distributed platform for building autonomic network functions.
C++
883
star
67

fboss

Facebook Open Switching System Software for controlling network switches.
C++
851
star
68

ktfmt

A program that reformats Kotlin source code to comply with the common community standard for Kotlin code conventions.
Kotlin
818
star
69

facebook-php-business-sdk

PHP SDK for Meta Marketing API
PHP
810
star
70

winterfell

A STARK prover and verifier for arbitrary computations
Rust
728
star
71

pyre2

Python wrapper for RE2
C++
631
star
72

starlark-rust

A Rust implementation of the Starlark language
Rust
623
star
73

openbmc

OpenBMC is an open software framework to build a complete Linux image for a Board Management Controller (BMC).
C
615
star
74

SPARTA

SPARTA is a library of software components specially designed for building high-performance static analyzers based on the theory of Abstract Interpretation.
C++
609
star
75

time

Meta's Time libraries
Go
570
star
76

chef-cookbooks

Open source chef cookbooks.
Ruby
565
star
77

IT-CPE

Meta's Client Platform Engineering tools. Some of the tools we have written to help manage our fleet of client systems.
Ruby
554
star
78

dotslash

Simplified executable deployment
Rust
523
star
79

Rapid

The OpenStreetMap editor driven by open data, AI, and supercharged features
JavaScript
515
star
80

lexical-ios

Lexical iOS is an extensible text editor framework that integrates the APIs and philosophies from Lexical Web with a Swift API built on top of TextKit.
Swift
477
star
81

facebook-sdk-for-unity

The facebook sdk for unity.
C#
474
star
82

facebook-nodejs-business-sdk

Node.js SDK for Meta Marketing APIs
JavaScript
469
star
83

FAI-PEP

Facebook AI Performance Evaluation Platform
Python
384
star
84

facebook-java-business-sdk

Java SDK for Meta Marketing APIs
Java
379
star
85

chef-utils

Utilities related to Chef
Ruby
290
star
86

opaque-ke

An implementation of the OPAQUE password-authenticated key exchange protocol
Rust
275
star
87

dns

Collection of Meta's DNS Libraries
Go
257
star
88

facebook360_dep

Facebook360 Depth Estimation Pipeline - https://facebook.github.io/facebook360_dep
HTML
241
star
89

akd

An implementation of an auditable key directory
Rust
219
star
90

tac_plus

A Tacacs+ Daemon tested on Linux (CentOS) to run AAA via TACACS+ Protocol via IPv4 and IPv6.
C
207
star
91

facebook-ruby-business-sdk

Ruby SDK for Meta Marketing API
Ruby
204
star
92

usort

Safe, minimal import sorting for Python projects.
Python
171
star
93

grocery-delivery

The Grocery Delivery utility for managing cookbook uploads to distributed Chef backends.
Ruby
153
star
94

taste-tester

Software to manage a chef-zero instance and use it to test changes on production servers.
Ruby
146
star
95

TestSlide

A Python test framework
Python
143
star
96

sapp

Post Processor for Facebook Static Analysis Tools.
Python
127
star
97

homebrew-fb

OS X Homebrew formulas to install Meta open source software
Ruby
124
star
98

threat-research

Welcome to the Meta Threat Research Indicator Repository, a dedicated resource for the sharing of Indicators of Compromise (IOCs) and other threat indicators with the external research community
Python
124
star
99

ocamlrep

Sets of libraries and tools to write applications and libraries mixing OCaml and Rust. These libraries will help keeping your types and data structures synchronized, and enable seamless exchange between OCaml and Rust
Rust
121
star
100

squangle

SQuangLe is a C++ API for accessing MySQL servers
C++
121
star