From f511d3bed795e0a74598d39b4a8554be7c6e83a7 Mon Sep 17 00:00:00 2001 From: Jirka Date: Wed, 27 Jul 2022 09:27:06 +0200 Subject: [PATCH 1/3] adding explain notes for requirements --- requirements/app/base.txt | 4 ++-- requirements/app/cloud.txt | 2 +- requirements/pytorch/base.txt | 3 +++ requirements/pytorch/examples.txt | 3 +++ requirements/pytorch/extra.txt | 3 +++ requirements/pytorch/loggers.txt | 3 +++ requirements/pytorch/strategies.txt | 3 +++ 7 files changed, 18 insertions(+), 3 deletions(-) diff --git a/requirements/app/base.txt b/requirements/app/base.txt index 506a4a8837d60..d5ab48b6f67fe 100644 --- a/requirements/app/base.txt +++ b/requirements/app/base.txt @@ -2,9 +2,9 @@ py jinja2==3.0.3 lightning-cloud==0.5.0 packaging -deepdiff >= 5.7.0 +deepdiff>=5.7.0 starsessions fsspec==2022.01.0 s3fs==2022.1.0 croniter # for now until we found something more robust. -traitlets < 5.2.0 # Traitlets 5.2.X fails: https://github.com/ipython/traitlets/issues/741 +traitlets<5.2.0 # Traitlets 5.2.X fails: https://github.com/ipython/traitlets/issues/741 diff --git a/requirements/app/cloud.txt b/requirements/app/cloud.txt index dc396d72c6cb3..8dac80ef23432 100644 --- a/requirements/app/cloud.txt +++ b/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 diff --git a/requirements/pytorch/base.txt b/requirements/pytorch/base.txt index a0c1786362390..fab834db05649 100644 --- a/requirements/pytorch/base.txt +++ b/requirements/pytorch/base.txt @@ -1,3 +1,6 @@ +# NOTE: the upper bound for package version is only set for CI stability and it is dropped while installing this package +# in case, you want to preserve/enforce restriction on latest compatible version, add "strict" as in-line comment + numpy>=1.17.2, <1.23.1 torch>=1.9.*, <=1.12.0 tqdm>=4.57.0, <=4.63.0 diff --git a/requirements/pytorch/examples.txt b/requirements/pytorch/examples.txt index 114c509ad72e3..7ebd824a33cbe 100644 --- a/requirements/pytorch/examples.txt +++ b/requirements/pytorch/examples.txt @@ -1,3 +1,6 @@ +# NOTE: the upper bound for package version is only set for CI stability and it is dropped while installing this package +# in case, you want to preserve/enforce restriction on latest compatible version, add "strict" as in-line comment + torchvision>=0.10.*, <=0.12.0 gym[classic_control]>=0.17.0, <0.24.2 ipython[all] <=8.1.1 diff --git a/requirements/pytorch/extra.txt b/requirements/pytorch/extra.txt index 90571dd8cab91..80c8090e15ea1 100644 --- a/requirements/pytorch/extra.txt +++ b/requirements/pytorch/extra.txt @@ -1,3 +1,6 @@ +# NOTE: the upper bound for package version is only set for CI stability and it is dropped while installing this package +# in case, you want to preserve/enforce restriction on latest compatible version, add "strict" as in-line comment + # extended list of package dependencies to reach full functionality matplotlib>3.1, <3.5.3 torchtext>=0.10.*, <=0.12.0 diff --git a/requirements/pytorch/loggers.txt b/requirements/pytorch/loggers.txt index a857ab5660d54..2c91b17031a37 100644 --- a/requirements/pytorch/loggers.txt +++ b/requirements/pytorch/loggers.txt @@ -1,3 +1,6 @@ +# NOTE: the upper bound for package version is only set for CI stability and it is dropped while installing this package +# in case, you want to preserve/enforce restriction on latest compatible version, add "strict" as in-line comment + # all supported loggers neptune-client>=0.10.0, <0.16.4 diff --git a/requirements/pytorch/strategies.txt b/requirements/pytorch/strategies.txt index 2b69c8ba76b81..a705be6fd6a92 100644 --- a/requirements/pytorch/strategies.txt +++ b/requirements/pytorch/strategies.txt @@ -1,3 +1,6 @@ +# NOTE: the upper bound for package version is only set for CI stability and it is dropped while installing this package +# in case, you want to preserve/enforce restriction on latest compatible version, add "strict" as 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 From 332005d8480ef0e244021d637923bdbf92798ef7 Mon Sep 17 00:00:00 2001 From: Jirka Date: Wed, 27 Jul 2022 23:00:53 +0200 Subject: [PATCH 2/3] readme --- requirements/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 requirements/README.md diff --git a/requirements/README.md b/requirements/README.md new file mode 100644 index 0000000000000..b2237b954d1bb --- /dev/null +++ b/requirements/README.md @@ -0,0 +1,13 @@ +# Project requirements + +This is the root requirements' folder which branches into sub-folders depending on 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 is aggregated al needed requirements for development. + +## CI/CD upper bounds + +For Ci stability we have set for all package version upper bounds (the latest version) so with any sudden release we won't put our development in fire. +The continues updated of these apper bounds is managed by dependabot. +Note that ll of these upper bounds are lifter when you install package either from source or as a package. +In case, you want to preserve/enforce restriction on latest compatible version, add "strict" as in-line comment. From 5c3119bb351c8556b4fada4a3c8f78fa1cef0e7a Mon Sep 17 00:00:00 2001 From: Jirka Borovec Date: Fri, 29 Jul 2022 12:23:39 +0200 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Rohit Gupta --- requirements/README.md | 18 +++++++++--------- requirements/pytorch/base.txt | 4 ++-- requirements/pytorch/examples.txt | 4 ++-- requirements/pytorch/extra.txt | 4 ++-- requirements/pytorch/loggers.txt | 4 ++-- requirements/pytorch/strategies.txt | 4 ++-- 6 files changed, 19 insertions(+), 19 deletions(-) diff --git a/requirements/README.md b/requirements/README.md index b2237b954d1bb..24ce0561689d9 100644 --- a/requirements/README.md +++ b/requirements/README.md @@ -1,13 +1,13 @@ -# Project requirements +# Project Requirements -This is the root requirements' folder which branches into sub-folders depending on 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 is aggregated al needed requirements for development. +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 version upper bounds (the latest version) so with any sudden release we won't put our development in fire. -The continues updated of these apper bounds is managed by dependabot. -Note that ll of these upper bounds are lifter when you install package either from source or as a package. -In case, you want to preserve/enforce restriction on latest compatible version, add "strict" as in-line comment. +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. diff --git a/requirements/pytorch/base.txt b/requirements/pytorch/base.txt index 103f09095ce82..e8743b18c73b0 100644 --- a/requirements/pytorch/base.txt +++ b/requirements/pytorch/base.txt @@ -1,5 +1,5 @@ -# NOTE: the upper bound for package version is only set for CI stability and it is dropped while installing this package -# in case, you want to preserve/enforce restriction on latest compatible version, add "strict" as in-line comment +# 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 diff --git a/requirements/pytorch/examples.txt b/requirements/pytorch/examples.txt index d7fd1ee5eb9f0..288e3a10889c3 100644 --- a/requirements/pytorch/examples.txt +++ b/requirements/pytorch/examples.txt @@ -1,5 +1,5 @@ -# NOTE: the upper bound for package version is only set for CI stability and it is dropped while installing this package -# in case, you want to preserve/enforce restriction on latest compatible version, add "strict" as in-line comment +# 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.13.0 gym[classic_control]>=0.17.0, <0.24.2 diff --git a/requirements/pytorch/extra.txt b/requirements/pytorch/extra.txt index 65c8e2a3edda0..c386c5581cc42 100644 --- a/requirements/pytorch/extra.txt +++ b/requirements/pytorch/extra.txt @@ -1,5 +1,5 @@ -# NOTE: the upper bound for package version is only set for CI stability and it is dropped while installing this package -# in case, you want to preserve/enforce restriction on latest compatible version, add "strict" as in-line comment +# 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 diff --git a/requirements/pytorch/loggers.txt b/requirements/pytorch/loggers.txt index 2c91b17031a37..7d89449318b28 100644 --- a/requirements/pytorch/loggers.txt +++ b/requirements/pytorch/loggers.txt @@ -1,5 +1,5 @@ -# NOTE: the upper bound for package version is only set for CI stability and it is dropped while installing this package -# in case, you want to preserve/enforce restriction on latest compatible version, add "strict" as in-line comment +# 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 diff --git a/requirements/pytorch/strategies.txt b/requirements/pytorch/strategies.txt index 20f5aaf003059..4e916fbc6c61f 100644 --- a/requirements/pytorch/strategies.txt +++ b/requirements/pytorch/strategies.txt @@ -1,5 +1,5 @@ -# NOTE: the upper bound for package version is only set for CI stability and it is dropped while installing this package -# in case, you want to preserve/enforce restriction on latest compatible version, add "strict" as in-line comment +# 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, <0.7.0