-
Notifications
You must be signed in to change notification settings - Fork 400
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Documentation on Outlines Versioning and Releases
- Loading branch information
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
The Outlines project follows a structured versioning scheme designed to provide clarity and minimize risk for downstream dependents. | ||
|
||
Each part of the version number (`major.minor.patch`) conveys information about the nature and impact of the changes included in the release. | ||
|
||
- **Major Releases** includes compatibility-breaking changes to core interfaces, such as `LogitsProcessor`s and `Guides`. | ||
- **Minor Releases** introduce changes of substance to internal or unexposed functionality. These changes are well tested and intended to maintain compatability with existing use of core interfaces. | ||
- **Patch Releases** address bug fixes and incorporate low-risk changes to improve stability and performance. | ||
|
||
## Releases | ||
|
||
Releases along with release notes can be found on the [Outlines Releases GitHub Page](https://github.com/outlines-dev/outlines/releases). | ||
|
||
## Version Pinning Recommendations | ||
|
||
Here are our recommendations for managing dependencies on the Outlines package: | ||
|
||
**Small, Risk-Tolerant Projects:** Pin to a specific major version. | ||
|
||
**Large, Conservative Projects:** Pin to a specific minor version. |