Skip to content

Commit a3d8318

Browse files
authored
Hoist note about backwards compatibility in README (#45)
Also added preview label to indicate status of library instead of trying to describe the status.
1 parent 73b5d9c commit a3d8318

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Azure Storage Connector for PyTorch (`azstoragetorch`)
1+
# Azure Storage Connector for PyTorch (`azstoragetorch`) (Preview)
22

33
The Azure Storage Connector for PyTorch (`azstoragetorch`) is a library that provides
44
seamless, performance-optimized integrations between [Azure Storage] and [PyTorch].
@@ -15,6 +15,13 @@ For detailed documentation on `azstoragetorch`, we recommend visiting its
1515
for the project. Content in this README is scoped to a high-level overview of the
1616
project and its GitHub repository policies.
1717

18+
## Backwards compatibility
19+
While the project is major version `0` (i.e., version is `0.x.y`), public interfaces are not stable.
20+
21+
Backwards incompatible changes may be introduced between minor version bumps (e.g., upgrading from
22+
`0.1.0` to `0.2.0`). If backwards compatibility is needed while using the library,
23+
we recommend pinning to a minor version of the library (e.g., `azstoragetorch~=0.1.0`).
24+
1825
## Getting started
1926

2027
### Prerequisites
@@ -131,13 +138,6 @@ for batch in dataloader:
131138
print(batch["url"]) # Prints blob URLs for each 32 sample batch
132139
```
133140

134-
## Backwards compatibility
135-
136-
While the project is major version `0` (i.e., version is `0.x.y`), public interfaces are not stable.
137-
Backwards incompatible changes may be introduced between minor version bumps (e.g., upgrading from
138-
`0.1.0` to `0.2.0`). If backwards compatibility is needed while using the library,
139-
we recommend pinning to a specific minor version of the library (e.g., `azstoragetorch==0.1`).
140-
141141

142142
## Contributing
143143

0 commit comments

Comments
 (0)