Fix/links and docs (#829)

Co-authored-by: otaj <[email protected]>
Co-authored-by: Jirka Borovec <[email protected]>

Author: 3 people

.github/workflows/docs-check.yml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@master
       - uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: 3.9
 
       # Note: This uses an internal pip API and may not always work
       # https://github.com/actions/cache/blob/master/examples.md#multiple-oss-in-a-workflow
@@ -29,7 +29,7 @@ jobs:
       - name: Install dependencies
         run: |
           # python -m pip install --upgrade --user pip
-          pip install --requirement requirements/devel.txt --upgrade --find-links https://download.pytorch.org/whl/cpu/torch_stable.html --quiet  # --upgrade-strategy only-if-needed
+          pip install --requirement requirements/devel.txt --upgrade --quiet --find-links https://download.pytorch.org/whl/cpu/torch_stable.html
           pip install --requirement docs/requirements.txt --upgrade-strategy only-if-needed
           python --version
           pip --version
@@ -52,7 +52,7 @@ jobs:
       - uses: actions/checkout@master
       - uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: 3.9
 
       # Note: This uses an internal pip API and may not always work
       # https://github.com/actions/cache/blob/master/examples.md#multiple-oss-in-a-workflow
@@ -66,7 +66,6 @@ jobs:
 
       - name: Install dependencies
         run: |
-          pip install --requirement requirements.txt --upgrade-strategy only-if-needed --find-links https://download.pytorch.org/whl/cpu/torch_stable.html --quiet
           pip install --requirement docs/requirements.txt
           # install Texlive, see https://linuxconfig.org/how-to-install-latex-on-ubuntu-20-04-focal-fossa-linux
           sudo apt-get update && sudo apt-get install -y texlive-latex-extra dvipng texlive-pictures

README.md

@@ -19,9 +19,8 @@ ______________________________________________________________________
 
 [![PyPI Status](https://badge.fury.io/py/lightning-bolts.svg)](https://badge.fury.io/py/lightning-bolts)
 [![PyPI Status](https://pepy.tech/badge/lightning-bolts)](https://pepy.tech/project/lightning-bolts)
-[![Build Status](https://dev.azure.com/PytorchLightning/lightning%20Bolts/_apis/build/status/PyTorchLightning.lightning-bolts?branchName=master)](https://dev.azure.com/PytorchLightning/lightning%20Bolts/_build/latest?definitionId=5&branchName=master)
+[![Build Status](https://dev.azure.com/Lightning-AI/lightning%20Bolts/_apis/build/status/Lightning-AI.lightning-bolts?branchName=master)](https://dev.azure.com/Lightning-AI/lightning%20Bolts/_build?definitionId=31&_a=summary&repositoryFilter=13&branchFilter=4923%2C4923)
 [![codecov](https://codecov.io/gh/PyTorchLightning/lightning-bolts/branch/master/graph/badge.svg)](https://codecov.io/gh/PyTorchLightning/lightning-bolts)
-[![CodeFactor](https://www.codefactor.io/repository/github/pytorchlightning/lightning-bolts/badge)](https://www.codefactor.io/repository/github/pytorchlightning/lightning-bolts)
 
 [![Documentation Status](https://readthedocs.org/projects/lightning-bolts/badge/?version=latest)](https://lightning-bolts.readthedocs.io/en/latest/)
 [![Slack](https://img.shields.io/badge/slack-chat-green.svg?logo=slack)](https://www.pytorchlightning.ai/community)

docs/Makefile

@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS    = -W
-SPHINXBUILD   = python $(shell which sphinx-build)
+SPHINXBUILD   = $(shell which sphinx-build)
 SOURCEDIR     = source
 BUILDDIR      = build
 

docs/source/conf.py

@@ -302,7 +302,7 @@ def package_list_from_file(file):
     mocked_packages = []
     with open(file) as fp:
         for ln in fp.readlines():
-            found = [ln.index(ch) for ch in list(",=<>#") if ch in ln]
+            found = [ln.index(ch) for ch in list(",=<>#[]") if ch in ln]
             pkg = ln[: min(found)] if found else ln
             if pkg.strip():
                 mocked_packages.append(pkg.strip())
@@ -319,12 +319,15 @@ def package_list_from_file(file):
 MOCK_PACKAGES = []
 if SPHINX_MOCK_REQUIREMENTS:
     # mock also base packages when we are on RTD since we don't install them there
+    MOCK_PACKAGES += ["numpy"]
     MOCK_PACKAGES += package_list_from_file(os.path.join(_PATH_ROOT, "requirements.txt"))
     MOCK_PACKAGES += package_list_from_file(os.path.join(_PATH_ROOT, "requirements", "models.txt"))
     MOCK_PACKAGES += package_list_from_file(os.path.join(_PATH_ROOT, "requirements", "loggers.txt"))
 # replace PyPI packages by importing ones
 MOCK_PACKAGES = [PACKAGE_MAPPING.get(pkg, pkg) for pkg in MOCK_PACKAGES]
 
+print(f"{MOCK_PACKAGES=}")
+
 autodoc_mock_imports = MOCK_PACKAGES
 
 

requirements/models.txt

@@ -1,5 +1,5 @@
 torchvision>=0.10.*
-scikit-learn>=0.23
+scikit-learn>=1.0.2
 Pillow
 opencv-python-headless
 gym[atari]>=0.17.2, <0.20.0  # needed for RL

requirements/test.txt

@@ -11,7 +11,7 @@ pre-commit>=1.0
 mypy>=0.790
 black
 atari-py==0.2.6  # needed for RL
-scikit-learn>=0.23
+scikit-learn>=1.0.2
 sparseml
 ale-py>=0.7
 jsonargparse[signatures]  # for LightningCLI