Skip to content

Commit

Permalink
Update README.rst (#297)
Browse files Browse the repository at this point in the history
* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst
  • Loading branch information
Edwin Ng authored Nov 24, 2020
1 parent 437e693 commit eb6ac25
Showing 1 changed file with 27 additions and 6 deletions.
33 changes: 27 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,22 @@

-------------------------------------------

**Disclaimer: Orbit requires PyStan as a system dependency. PyStan is
licensed under** `GPLv3 <https://www.gnu.org/licenses/gpl-3.0.html>`__ **,
which is a free, copyleft license for software.**
|pypi| |travis| |downloads|

Orbit is a Python package for time series modeling and inference
using Bayesian sampling methods for model estimation. It provides a
Disclaimer
==========

This project

- is stable and being incubated for long-term support. It may contain new experimental code, for which APIs are subject to change.
- requires PyStan as a system dependency. PyStan is licensed under** `GPLv3 <https://www.gnu.org/licenses/gpl-3.0.html>`__ **, which is a free, copyleft license for software.**

Orbit: A Python package for Bayesian forecasting models
====================

Orbit is a Python package for Bayesian forecasting models developed under object-oriented design. It provides a
familiar and intuitive initialize-fit-predict interface for working with
time series tasks, while utilizing probabilistic modeling under
time series tasks, while utilizing probabilistic modeling api under
the hood.

The initial release supports concrete implementation for the following
Expand Down Expand Up @@ -134,3 +142,16 @@ Related projects
- `Pyro <https://github.com/pyro-ppl/pyro>`__
- `Stan <https://github.com/stan-dev/stan>`__
- `Rlgt <https://cran.r-project.org/web/packages/Rlgt/index.html>`__


.. |pypi| image:: https://badge.fury.io/py/orbit-ml.svg
:target: https://badge.fury.io/py/orbit-ml
:alt: pypi

.. |travis| image:: https://travis-ci.com/uber/orbit.svg?branch=master
:target: https://travis-ci.com/uber/orbit
:alt: travis

.. |downloads| image:: https://static.pepy.tech/personalized-badge/orbit-ml?period=month&units=international_system&left_color=blue&right_color=grey&left_text=Downloads
:target: https://pepy.tech/project/orbit-ml
:alt: downloads

0 comments on commit eb6ac25

Please sign in to comment.