prophet README

The project's README from github.com/facebook/prophet. As one markdown file: README.md.

Prophet: Automatic Forecasting Procedure

Build

PyPI Version PyPI Downloads Monthly PyPI Downloads All

CRAN Version CRAN Downloads Monthly CRAN Downloads All

Conda_Version


2026 Update: Prophet is in maintenance mode as of v1.4.0. Only bug fixes, dependency bumps, and changes to the R package to meet parity with Python will be accepted. No new features are planned.


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.

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://stan-dev.r-universe.dev", 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

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

See Release Notes.

Version 1.4.0 (2026.08.01)

Python

Version 1.3.0 (2026.01.27)

Python

Version 1.2.2 (2026.01.25)

Python

R

Version 1.2.1 (2025.10.22)

Python

Version 1.2.0 (2025.05.30)

Python

Version 1.1.7 (2025.05.30)

Python

Version 1.1.6 (2024.09.29)

Python

R

Version 1.1.5 (2023.10.10)

Python

R

Version 1.1.4 (2023.05.30)

Python

R

Version 1.1.2 (2023.01.20)

Python

R

Version 1.1.1 (2022.09.08)

Version 1.1 (2022.06.25)

Version 1.0 (2021.03.28)

Version 0.7 (2020.09.05)

Version 0.6 (2020.03.03)

Version 0.5 (2019.05.14)

Version 0.4 (2018.12.18)

Version 0.3 (2018.06.01)

Version 0.2.1 (2017.11.08)

Version 0.2 (2017.09.02)

Version 0.1.1 (2017.04.17)

Version 0.1 (2017.02.23)

License

Prophet is licensed under the MIT license.

prophet (facebook/prophet)

time-series
Searching Database…

20.4K ·GitHub
What is this?Prophet is an open-source forecasting procedure for time series: an additive model fits non-linear trends with yearly, weekly and daily seasonality plus holiday effects. It is aimed at series with strong seasonal effects and several seasons of history, and handles missing data, trend shifts and outliers well.
Is this a library I call from my own code, or an app with an interface?It is a library, not an app: you call it from your own Python or R code. The Python package ships on PyPI and the R package on CRAN.
What do I need on my machine before it will run?Python 3.7 or newer (Python 2 was dropped in v0.6). Under the hood it compiles a Stan model via cmdstan/cmdstanpy — a fixed cmdstan version is downloaded automatically — and on Windows you need a Unix-compatible C compiler such as mingw-gcc.
Are there any install pitfalls I should know about?Building from source on Linux needs gcc/g++ and python-dev, and a VM needs at least 4GB of memory to install and 2GB to use; on Windows, R requires Rtools installed first. Pre-built wheels exist for macOS arm64 (M1/M2 chips).
What can the model capture besides trend and seasonality?Holiday effects, custom seasonalities and extra regressors (nested ones supported since v1.4). Growth can be linear, non-linear or a 'flat' option added in v0.7, and trend shifts are handled through changepoints.
How can I tell if my forecasts are any good?There is a built-in cross-validation function with error metrics and visualizations. It supports parallelization and directly specifying cutoffs, and since v1.1.7 you can create custom performance metrics.
Does it work with sub-daily data?Yes — forecasting with sub-daily data plus daily and custom seasonalities was added in v0.2, along with extra regressors and the cross-validation function.
Is there an academic paper behind it?Yes: Sean J. Taylor and Benjamin Letham, 'Forecasting at scale', The American Statistician 72(1):37-45, 2018. The tool is open source from Facebook's Core Data Science team.
Creator
facebook
Size
67.4 MB
Stars
20.4K
Age
9y
Commits · 90 Days