From c7c6deab8621c71c1d88c9e9fd6c9b2b5f8b8554 Mon Sep 17 00:00:00 2001 From: Jeremy Reizenstein Date: Thu, 30 Sep 2021 10:48:52 -0700 Subject: [PATCH] compatibility statement in README Summary: Statement about compatibility. Reviewed By: nikhilaravi Differential Revision: D30697072 fbshipit-source-id: aeb5e3e0a08c1797033d8c00b24484c8a699cb02 --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 6da63322..18ee77e3 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,13 @@ We have created a short (~14 min) video tutorial providing an overview of the Py We welcome new contributions to PyTorch3D and we will be actively maintaining this library! Please refer to [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for full instructions on how to run the code, tests and linter, and submit your pull requests. +## Development and Compatibility + +- `main` branch: actively developed, without any guarantee, Anything can be broken at any time + - REMARK: this includes nightly builds which are built from `main` + - HINT: the commit history can help locate regressions or changes +- backward-compatibility between releases: no guarantee. Best efforts to communicate breaking changes and facilitate migration of code or data (incl. models). + ## Contributors PyTorch3D is written and maintained by the Facebook AI Research Computer Vision Team.