Skip to content

Commit b157e63

Browse files
committed
New versioning specification
1 parent ca9bfbf commit b157e63

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,13 @@ Supports Windows, Linux, and Mac.
2424

2525
Add the following definition to your `requirements.txt` or `pyproject.toml` file:
2626

27-
`torchruntime~=[version]`
27+
`torchruntime~=[major-ver].[minor-ver]`
2828

29-
Replace `[version]` with the desired version of Torchruntime. Using the [compatible release operator](https://packaging.python.org/en/latest/specifications/version-specifiers/#compatible-release) allows for updated device definitions to be made available to users without further changes. You will still need to manually change the version specification when breaking changes are introduced.
29+
Replace `[major-ver]` and `[minor-ver]` with the desired Torchruntime release series, for example:
30+
31+
`torchruntime~=1.20`
32+
33+
Using the [compatible release operator](https://packaging.python.org/en/latest/specifications/version-specifiers/#compatible-release) allows updated device definitions and non-breaking changes to be made available to users without manual intervention. You will still need to update the definition when breaking changes are introduced in new major versions.
3034

3135
### Manually
3236

0 commit comments

Comments
 (0)