req: make extras protected based file name & freeze (#48)

Author: Borda

Diff for: .github/workflows/ci-checks.yml

@@ -28,7 +28,8 @@ jobs:
       actions-ref: main
       import-name: "lightning_graphcore"
       artifact-name: dist-packages-${{ github.sha }}
-      install-flags: '"pytorch-lightning>=2.0.0"'
+      # todo: new veersions shall have input flags whci would de-deuplictae this hidden adjustment
+      install-flags: '"pytorch-lightning>=2.0.0, <=2.0.6"'
       testing-matrix: |
         {
           "os": ["ubuntu-latest", "macos-latest", "windows-latest"],
@@ -38,4 +39,4 @@ jobs:
   check-docs:
     uses: Lightning-AI/utilities/.github/workflows/check-docs.yml@main
     with:
-      requirements-file: "_requirements/docs.txt"
+      requirements-file: "requirements/_docs.txt"

Diff for: .github/workflows/ci-dockers.yml renamed to .github/workflows/docker-build.yml

@@ -7,9 +7,9 @@ on:
     branches: [main, "release/*"]
     types: [opened, reopened, ready_for_review, synchronize]  # added `ready_for_review` since draft is skipped
     paths:
-      - ".github/workflows/ci-dockers.yml"
+      - ".github/workflows/docker-build.yml"
       - "dockers/**"
-      - "_requirements/*.txt"
+      - "requirements/*.txt"
       - "setup.py"
       - "!*.md"
       - "!**/*.md"

Diff for: .github/workflows/docs-deploy.yml

@@ -24,13 +24,13 @@ jobs:
       uses: actions/cache@v3
       with:
         path: ~/.cache/pip
-        key: pip-${{ hashFiles('_requirements/docs.txt') }}
+        key: pip-${{ hashFiles('requirements/_docs.txt') }}
         restore-keys: pip-
 
     - name: Install dependencies
       run: |
         pip --version
-        pip install . -U -q -r _requirements/docs.txt -f ${TORCH_URL}
+        pip install . -U -q -r requirements/_docs.txt -f ${TORCH_URL}
         # install Texlive, see https://linuxconfig.org/how-to-install-latex-on-ubuntu-20-04-focal-fossa-linux
         sudo apt-get update --fix-missing
         sudo apt-get install -y texlive-latex-extra dvipng texlive-pictures

Diff for: .readthedocs.yml

@@ -17,4 +17,4 @@ formats: all
 python:
   version: 3.7
   install:
-    - requirements: _requirements/docs.txt
+    - requirements: requirements/_docs.txt

Diff for: Makefile

@@ -7,14 +7,14 @@ export SPHINX_MOCK_REQUIREMENTS=0
 
 test: clean
 	pip install -q -r requirements.txt
-	pip install -q -r _requirements/test.txt
+	pip install -q -r requirements/_test.txt
 
 	# use this to run tests
 	python -m coverage run --source lightning_graphcore -m pytest src tests -v --flake8
 	python -m coverage report
 
 docs: clean
-	pip install . --quiet -r _requirements/docs.txt
+	pip install . --quiet -r requirements/_docs.txt
 	python -m sphinx -b html -W --keep-going docs/source docs/build
 
 clean:

Diff for: _requirements/lightning.txt

@@ -51,6 +51,14 @@ Accelerator: IPU training
     </div>
 
 
+.. toctree::
+   :maxdepth: 1
+   :name: start
+   :caption: Start here
+
+   readme
+
+
 Indices and tables
 ==================
 

Diff for: _requirements/pytorch-lightning.txt

@@ -0,0 +1,4 @@
+# this sets the requirements contains if you go with main lightning
+
+# in 2.0.7 we have removed lightning.pytorch.overrides.base._LightningPrecisionModuleWrapperBase
+lightning >=2.0.0, <=2.0.6

Diff for: docs/source/index.rst

@@ -0,0 +1,4 @@
+# this sets the requirements contains if you go with main lightning
+
+# in 2.0.7 we have removed pytorch_lightning.overrides.base._LightningPrecisionModuleWrapperBase
+pytorch-lightning >=2.0.0, <=2.0.6

Diff for: _requirements/docs.txt renamed to requirements/_docs.txt

@@ -9,7 +9,7 @@
 
 _PATH_ROOT = os.path.dirname(__file__)
 _PATH_SOURCE = os.path.join(_PATH_ROOT, "src")
-_PATH_REQUIRES = os.path.join(_PATH_ROOT, "_requirements")
+_PATH_REQUIRES = os.path.join(_PATH_ROOT, "requirements")
 
 
 def _load_py_module(fname, pkg="lightning_graphcore"):
@@ -29,7 +29,7 @@ def _load_requirements(path_dir: str = _PATH_ROOT, file_name: str = "requirement
     readme = fopen.read()
 
 
-def _prepare_extras(requirements_dir: str = _PATH_REQUIRES, skip_files: tuple = ("devel.txt", "docs.txt")) -> dict:
+def _prepare_extras(requirements_dir: str = _PATH_REQUIRES) -> dict:
     # https://setuptools.readthedocs.io/en/latest/setuptools.html#declaring-extras
     # Define package extras. These are only installed if you specify them.
     # From remote, use like `pip install pytorch-lightning[dev, docs]`
@@ -38,7 +38,7 @@ def _prepare_extras(requirements_dir: str = _PATH_REQUIRES, skip_files: tuple =
     extras = {
         p.stem: _load_requirements(file_name=p.name, path_dir=str(p.parent))
         for p in req_files
-        if p.name not in skip_files
+        if not p.name.startswith("_")
     }
     # todo: eventually add some custom aggregations such as `develop`
     extras = {name: sorted(set(reqs)) for name, reqs in extras.items()}