Skip to content

Commit

Permalink
Warn about the experimental nature of Probdiffeq in its readme, and e…
Browse files Browse the repository at this point in the history
…xplain versioning (#738)
  • Loading branch information
pnkraemer authored Dec 29, 2023
1 parent 9a7f0d3 commit 37f9bd2
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,18 @@ To install ProbDiffEq with `jax[cpu]`, run
pip install probdiffeq[cpu]
```

**WARNING:** This repository is experimental. Functionality may change frequently and without deprecation policies.

**WARNING:**
_**This is a research project. Expect rough edges and sudden API changes.**_

**VERSIONING:**
As long as Probdiffeq is in its initial development phase (version 0.MINOR.PATCH), version numbers are increased as follows:

* Bugfixes and new features increase the PATCH version.
* Breaking changes increase the MINOR version.

See also: [semantic versioning](https://semver.org/).


## What's next?

Expand Down

0 comments on commit 37f9bd2

Please sign in to comment.