docs: add notes for python version requirements

XuehaiPan · XuehaiPan · commit b0199745ce83 · 2022-09-25T16:17:27.000+08:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -55,7 +55,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.7 - 3.10"
+          python-version: "3.7 - 3.10" # sync with requires-python in pyproject.toml
           update-environment: true
 
       - name: Set __release__
@@ -95,7 +95,7 @@ jobs:
         id: py
         uses: actions/setup-python@v4
         with:
-          python-version: "3.7 - 3.10"
+          python-version: "3.7 - 3.10" # sync with requires-python in pyproject.toml
           update-environment: true
 
       - name: Set __release__
@@ -107,7 +107,7 @@ jobs:
         run: python setup.py --version
 
       - name: Build wheels
-        uses: pypa/cibuildwheel@v2.10.0
+        uses: pypa/cibuildwheel@v2.10.1
         with:
           package-dir: .
           output-dir: wheelhouse
@@ -138,7 +138,7 @@ jobs:
         uses: actions/setup-python@v4
         if: startsWith(github.ref, 'refs/tags/')
         with:
-          python-version: "3.7 - 3.10"
+          python-version: "3.7 - 3.10" # sync with requires-python in pyproject.toml
           update-environment: true
 
       - name: Check consistency between the package version and release tag
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -26,10 +26,10 @@ jobs:
           submodules: "recursive"
           fetch-depth: 1
 
-      - name: Set up Python 3.7 # the lowest version we support
+      - name: Set up Python 3.7
         uses: actions/setup-python@v4
         with:
-          python-version: "3.7"
+          python-version: "3.7" # the lowest version we support (sync with requires-python in pyproject.toml)
           update-environment: true
 
       - name: Setup CUDA Toolkit
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -37,10 +37,10 @@ jobs:
           submodules: "recursive"
           fetch-depth: 1
 
-      - name: Set up Python 3.7  # the lowest version we support
+      - name: Set up Python 3.7
         uses: actions/setup-python@v4
         with:
-          python-version: "3.7"
+          python-version: "3.7" # the lowest version we support (sync with requires-python in pyproject.toml)
           update-environment: true
 
       - name: Setup CUDA Toolkit
diff --git a/.pylintrc b/.pylintrc
@@ -53,7 +53,7 @@ persistent=yes
 
 # Minimum Python version to use for version dependent checks. Will default to
 # the version used to run pylint.
-py-version=3.7
+py-version=3.7  # the lowest version we support (sync with requires-python in pyproject.toml)
 
 # Discover python modules and packages in the file system subtree.
 recursive=no
diff --git a/conda-recipe.yaml b/conda-recipe.yaml
@@ -17,11 +17,11 @@ dependencies:
   - pip
 
   # Learning
-  - pytorch::pytorch >= 1.12
+  - pytorch::pytorch >= 1.12  # sync with project.dependencies
   - pytorch::torchvision
   - pytorch::pytorch-mutex = *=*cuda*
   - pip:
-      - functorch >= 0.2
+      - functorch >= 0.2     # sync with project.dependencies
       - torchviz
       - sphinxcontrib-katex  # for documentation
   - jax                      # for tutorials
diff --git a/docs/conda-recipe.yaml b/docs/conda-recipe.yaml
@@ -30,10 +30,10 @@ dependencies:
   - pip
 
   # Learning
-  - pytorch::pytorch >= 1.12
+  - pytorch::pytorch >= 1.12  # sync with project.dependencies
   - pytorch::pytorch-mutex = *=*cpu*
   - pip:
-      - functorch >= 0.2
+      - functorch >= 0.2  # sync with project.dependencies
       - torchviz
       - sphinxcontrib-katex  # for documentation
   - tensorboard
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,4 +1,5 @@
 --extra-index-url https://download.pytorch.org/whl/cpu
+# Sync with project.dependencies
 torch >= 1.12
 functorch >= 0.2
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,13 +1,16 @@
 # Package ######################################################################
 
 [build-system]
+# Sync with project.dependencies
 requires = ["setuptools", "torch >= 1.12", "numpy", "pybind11"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "torchopt"
 description = "A Jax-style optimizer for PyTorch."
 readme = "README.md"
+# Change this if wheels for `torch` is available
+# Search "requires-python" and update all corresponding items
 requires-python = ">= 3.7, < 3.11.0a0"
 authors = [
     { name = "TorchOpt Contributors" },
@@ -29,6 +32,7 @@ keywords = [
 classifiers = [
     "Development Status :: 4 - Beta",
     "License :: OSI Approved :: Apache Software License",
+    # Sync with requires-python
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.7",
     "Programming Language :: Python :: 3.8",
@@ -44,7 +48,7 @@ classifiers = [
     "Topic :: Scientific/Engineering :: Artificial Intelligence",
 ]
 dependencies = [
-    "torch >= 1.12",
+    "torch >= 1.12",     # see also build-system.requires and project.requires-python
     "functorch >= 0.2",
     "optree >= 0.2.0",
     "numpy",
@@ -163,6 +167,7 @@ repair-wheel-command = """
 safe = true
 line-length = 100
 skip-string-normalization = true
+# Sync with requires-python
 target-version = ["py37", "py38", "py39", "py310"]
 
 [tool.isort]
@@ -174,6 +179,7 @@ lines_after_imports = 2
 multi_line_output = 3
 
 [tool.mypy]
+# Sync with requires-python
 python_version = 3.7
 pretty = true
 show_error_codes = true
diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,4 @@
+# Sync with project.dependencies
 torch >= 1.12
 functorch >= 0.2
 optree >= 0.2.0
diff --git a/tutorials/requirements.txt b/tutorials/requirements.txt
@@ -1,4 +1,5 @@
 --extra-index-url https://download.pytorch.org/whl/cu116
+# Sync with project.dependencies
 torch >= 1.12
 torchvision
 functorch >= 0.2

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`--extra-index-url https://download.pytorch.org/whl/cpu`
	`2`	`+# Sync with project.dependencies`
`2`	`3`	`torch >= 1.12`
`3`	`4`	`functorch >= 0.2`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+# Sync with project.dependencies`
`1`	`2`	`torch >= 1.12`
`2`	`3`	`functorch >= 0.2`
`3`	`4`	`optree >= 0.2.0`