adding explain notes for requirements (#13872)

* adding explain notes for requirements
* Apply suggestions from code review

Co-authored-by: Rohit Gupta <[email protected]>

(cherry picked from commit e513638)

Author: Borda

requirements/README.md

@@ -0,0 +1,13 @@
+# Project Requirements
+
+This root requirements folder branches into sub-folders depending on the python package.
+Within the folder, we have grouped requirements files/lists per focus, which shall closely match package extra
+So, for example, when you install PL as `pip install pytorch-lightning[loggers]`, this list is stored in `requirements/pytorch/loggers.txt`.
+The only exceptional requirement file is `devel.txt`, which aggregated all the needed requirements for development.
+
+## CI/CD upper bounds
+
+For Ci stability, we have set for all package versions upper bounds (the latest version), so with any sudden release, we won't put our development on fire.
+The continues updated of these upper bounds are managed by dependabot.
+Note that these upper bounds are lifters when installing a package from the source or as a package.
+If you want to preserve/enforce restrictions on the latest compatible version, add "strict" as an in-line comment.

requirements/app/cloud.txt

@@ -1,5 +1,5 @@
 starsessions
 redis==4.1.0
 docker==5.0.3
-setuptools == 59.5.0
+setuptools==59.5.0
 s3fs==2022.1.0

requirements/pytorch/base.txt

@@ -1,3 +1,6 @@
+# NOTE: the upper bound for the package version is only set for CI stability, and it is dropped while installing this package
+#  in case you want to preserve/enforce restrictions on the latest compatible version, add "strict" as an in-line comment
+
 numpy>=1.17.2, <1.23.1
 torch>=1.9.*, <=1.12.0
 tqdm>=4.57.0, <=4.63.0

requirements/pytorch/examples.txt

@@ -1,3 +1,6 @@
+# NOTE: the upper bound for the package version is only set for CI stability, and it is dropped while installing this package
+#  in case you want to preserve/enforce restrictions on the latest compatible version, add "strict" as an in-line comment
+
 torchvision>=0.10.*, <=0.12.0
 gym[classic_control]>=0.17.0, <0.24.2
 ipython[all] <=8.1.1

requirements/pytorch/extra.txt

@@ -1,3 +1,6 @@
+# NOTE: the upper bound for the package version is only set for CI stability, and it is dropped while installing this package
+#  in case you want to preserve/enforce restrictions on the latest compatible version, add "strict" as an in-line comment
+
 # extended list of package dependencies to reach full functionality
 matplotlib>3.1, <3.5.3
 torchtext>=0.10.*, <=0.12.0

requirements/pytorch/loggers.txt

@@ -1,3 +1,6 @@
+# NOTE: the upper bound for the package version is only set for CI stability, and it is dropped while installing this package
+#  in case you want to preserve/enforce restrictions on the latest compatible version, add "strict" as an in-line comment
+
 # all supported loggers
 
 neptune-client>=0.10.0, <0.16.4

requirements/pytorch/strategies.txt

@@ -1,3 +1,6 @@
+# NOTE: the upper bound for the package version is only set for CI stability, and it is dropped while installing this package
+#  in case you want to preserve/enforce restrictions on the latest compatible version, add "strict" as an in-line comment
+
 fairscale>=0.4.5, <=0.4.6
 deepspeed<0.6.0
 # no need to install with [pytorch] as pytorch is already installed