Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

πŸ“š Add action to check broken links #1838

Merged
merged 6 commits into from
Mar 25, 2024

Conversation

AlexanderDokuchaev
Copy link
Contributor

@AlexanderDokuchaev AlexanderDokuchaev commented Mar 10, 2024

πŸ“ Description

  • Added action https://github.com/AlexanderDokuchaev/md-dead-link-check to check broken links in repository
  • Added check to nightly action to check all external links.
  • Fixed broken links
  • Updated links to absolute path /docs instead of relative ../../../../docs/, it shortly and safety if move file.
  • Fixed link Code Review Checklist in PR template, currently Not Found.
  • Removed Benchmarking and Hyperparameter Optimization from notebooks, it is not exist.
  • Some links to the GitHub site replaced to local paths. This is debatable, but I believe it's more useful to be able to read the documentation within a editor and then easily switch to the corresponding file instead of having to open it in a browser.

✨ Changes

Select what type of change your PR is:

  • 🐞 Bug fix (non-breaking change which fixes an issue)
  • πŸ”¨ Refactor (non-breaking change which refactors the code base)
  • πŸš€ New feature (non-breaking change which adds functionality)
  • πŸ’₯ Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • πŸ“š Documentation update
  • πŸ”’ Security update

βœ… Checklist

Before you submit your pull request, please make sure you have completed the following steps:

  • πŸ“‹ I have summarized my changes in the CHANGELOG and followed the guidelines for my type of change (skip for minor changes, documentation updates, and test enhancements).
  • πŸ“š I have made the necessary updates to the documentation (if applicable).
  • πŸ§ͺ I have written tests that support my changes and prove that my fix is effective or my feature works (if applicable).

For more information about code review checklists, see the Code Review Checklist.

@AlexanderDokuchaev
Copy link
Contributor Author

Hi @samet-akcay
I used this tool for NNCF repository, hope it will useful for your too πŸ˜‰
It can be used as pre-commit hook (works less than 1 second), if need i can change it.

Example of output:

File: README.md:262 β€’ Link: https://github.com/openvinotoolkit/anomalib/tree/main/src/anomalib/models/patchcore#mvtec-ad-dataset β€’ Error: 404: Not Found
File: notebooks/100_datamodules/README.md:5 β€’ Link: 100_datamodules/101_btech.ipynb β€’ Error: Path does not exists in repository
File: notebooks/100_datamodules/README.md:6 β€’ Link: 100_datamodules/102_mvtec.ipynb β€’ Error: Path does not exists in repository
File: notebooks/100_datamodules/README.md:7 β€’ Link: 100_datamodules/103_folder.ipynb β€’ Error: Path does not exists in repository
File: notebooks/100_datamodules/README.md:8 β€’ Link: 100_datamodules/104_tiling.ipynb β€’ Error: Path does not exists in repository
File: notebooks/500_use_cases/501_dobot/README.md:57 β€’ Link: https://github.com/openvinotoolkit/anomalib/blob/main/notebooks/500_use_cases/501_dobot/501_dobot/501b_inference_with_a_robotic_arm.ipynb β€’ Error: 404: Not Found
File: notebooks/README.md:46 β€’ Link: 300_benchmarking/301_benchmarking.ipynb β€’ Error: Path does not exists in repository
File: notebooks/README.md:47 β€’ Link: 300_benchmarking/302_hpo_wandb.ipynb β€’ Error: Path does not exists in repository

Copy link
Contributor

@samet-akcay samet-akcay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for fixing these @AlexanderDokuchaev! I'm fine with the changes, but will also wait for @ashwinvaidya17's review

@AlexanderDokuchaev
Copy link
Contributor Author

Updated PR,

  • For pull_request action will check external links only in modified files.
  • All links will checked in nightly action.

@samet-akcay samet-akcay merged commit 7edb6af into openvinotoolkit:main Mar 25, 2024
8 checks passed
samet-akcay added a commit that referenced this pull request Mar 26, 2024
…1907)

* πŸ“š Add action to check broken links (#1838)

* Fix broken links

* Add link checker

* Fix link in template

* linter

* nightly check

---------

Co-authored-by: Samet Akcay <samet.akcay@intel.com>

* Use LabelName ENUM for label assignment (#1881)

* Use LabelName ENUM for label assignment

* Update src/anomalib/deploy/inferencers/torch_inferencer.py

Co-authored-by: Samet Akcay <samet.akcay@intel.com>

---------

Co-authored-by: Samet Akcay <samet.akcay@intel.com>

* Changed prediction label assignment for OpenVINO inferencer (#1872)

* Update openvino_inferencer.py

Fixed incorrect label assignment.
Was True/False, now it's "Anomalous/Normal" as for the PyTorch inferencer in torch_inferencer.py

* Fix ruff

---------

Co-authored-by: Samet <samet.akcay@intel.com>

* Bump onnx version as the previous version caused security issues

---------

Co-authored-by: Alexander Dokuchaev <alexander.dokuchaev@intel.com>
Co-authored-by: TurboJonte <turbojonte@gmail.com>
samet-akcay added a commit that referenced this pull request Mar 26, 2024
* πŸ“š Add action to check broken links (#1838)

* Fix broken links

* Add link checker

* Fix link in template

* linter

* nightly check

---------

Co-authored-by: Samet Akcay <samet.akcay@intel.com>

* Use LabelName ENUM for label assignment (#1881)

* Use LabelName ENUM for label assignment

* Update src/anomalib/deploy/inferencers/torch_inferencer.py

Co-authored-by: Samet Akcay <samet.akcay@intel.com>

---------

Co-authored-by: Samet Akcay <samet.akcay@intel.com>

* Changed prediction label assignment for OpenVINO inferencer (#1872)

* Update openvino_inferencer.py

Fixed incorrect label assignment.
Was True/False, now it's "Anomalous/Normal" as for the PyTorch inferencer in torch_inferencer.py

* Fix ruff

---------

Co-authored-by: Samet <samet.akcay@intel.com>

* Add: fix image transform to float

Signed-off-by: Bepitic <bepitic@gmail.com>

* upd: video dtpe transform from torchvision

Signed-off-by: Bepitic <bepitic@gmail.com>

* Added the scale.

Signed-off-by: Bepitic <bepitic@gmail.com>

* Update src/anomalib/data/base/video.py

Co-authored-by: Dick Ameln <amelndjd@gmail.com>

---------

Signed-off-by: Bepitic <bepitic@gmail.com>
Co-authored-by: Alexander Dokuchaev <alexander.dokuchaev@intel.com>
Co-authored-by: Samet Akcay <samet.akcay@intel.com>
Co-authored-by: TurboJonte <turbojonte@gmail.com>
Co-authored-by: Dick Ameln <amelndjd@gmail.com>
samet-akcay added a commit that referenced this pull request Mar 26, 2024
* πŸ“š Add action to check broken links (#1838)

* Fix broken links

* Add link checker

* Fix link in template

* linter

* nightly check

---------

Co-authored-by: Samet Akcay <samet.akcay@intel.com>

* squeeze temporal dimension when clip length is 1

* add unit test for video input tensor dtype

* add test for single frame clips

* update changelog

* add author

---------

Co-authored-by: Alexander Dokuchaev <alexander.dokuchaev@intel.com>
Co-authored-by: Samet Akcay <samet.akcay@intel.com>
samet-akcay added a commit that referenced this pull request Mar 27, 2024
* Update CHANGELOG.md (#1899)

* Update __init__.py

* Fix metric bug (#1900)

* check metrics by name instead of key

* remove prefix from temp metric collection

* πŸ”’ Bump onnx version as the previous version caused security issues (#1907)

* πŸ“š Add action to check broken links (#1838)

* Fix broken links

* Add link checker

* Fix link in template

* linter

* nightly check

---------

Co-authored-by: Samet Akcay <samet.akcay@intel.com>

* Use LabelName ENUM for label assignment (#1881)

* Use LabelName ENUM for label assignment

* Update src/anomalib/deploy/inferencers/torch_inferencer.py

Co-authored-by: Samet Akcay <samet.akcay@intel.com>

---------

Co-authored-by: Samet Akcay <samet.akcay@intel.com>

* Changed prediction label assignment for OpenVINO inferencer (#1872)

* Update openvino_inferencer.py

Fixed incorrect label assignment.
Was True/False, now it's "Anomalous/Normal" as for the PyTorch inferencer in torch_inferencer.py

* Fix ruff

---------

Co-authored-by: Samet <samet.akcay@intel.com>

* Bump onnx version as the previous version caused security issues

---------

Co-authored-by: Alexander Dokuchaev <alexander.dokuchaev@intel.com>
Co-authored-by: TurboJonte <turbojonte@gmail.com>

* Add: fix image transform to float (#1902)

* πŸ“š Add action to check broken links (#1838)

* Fix broken links

* Add link checker

* Fix link in template

* linter

* nightly check

---------

Co-authored-by: Samet Akcay <samet.akcay@intel.com>

* Use LabelName ENUM for label assignment (#1881)

* Use LabelName ENUM for label assignment

* Update src/anomalib/deploy/inferencers/torch_inferencer.py

Co-authored-by: Samet Akcay <samet.akcay@intel.com>

---------

Co-authored-by: Samet Akcay <samet.akcay@intel.com>

* Changed prediction label assignment for OpenVINO inferencer (#1872)

* Update openvino_inferencer.py

Fixed incorrect label assignment.
Was True/False, now it's "Anomalous/Normal" as for the PyTorch inferencer in torch_inferencer.py

* Fix ruff

---------

Co-authored-by: Samet <samet.akcay@intel.com>

* Add: fix image transform to float

Signed-off-by: Bepitic <bepitic@gmail.com>

* upd: video dtpe transform from torchvision

Signed-off-by: Bepitic <bepitic@gmail.com>

* Added the scale.

Signed-off-by: Bepitic <bepitic@gmail.com>

* Update src/anomalib/data/base/video.py

Co-authored-by: Dick Ameln <amelndjd@gmail.com>

---------

Signed-off-by: Bepitic <bepitic@gmail.com>
Co-authored-by: Alexander Dokuchaev <alexander.dokuchaev@intel.com>
Co-authored-by: Samet Akcay <samet.akcay@intel.com>
Co-authored-by: TurboJonte <turbojonte@gmail.com>
Co-authored-by: Dick Ameln <amelndjd@gmail.com>

* Fix video bug and add tests (#1910)

* πŸ“š Add action to check broken links (#1838)

* Fix broken links

* Add link checker

* Fix link in template

* linter

* nightly check

---------

Co-authored-by: Samet Akcay <samet.akcay@intel.com>

* squeeze temporal dimension when clip length is 1

* add unit test for video input tensor dtype

* add test for single frame clips

* update changelog

* add author

---------

Co-authored-by: Alexander Dokuchaev <alexander.dokuchaev@intel.com>
Co-authored-by: Samet Akcay <samet.akcay@intel.com>

* Temporarily set devices to 1

* 🐞 Add greyscale conversion (#1911)

Add greyscale conversion

Signed-off-by: Ashwin Vaidya <ashwinnitinvaidya@gmail.com>

* 🐞 Fix publish workflow (#1912)

Disable tty prompt for gpg import

Signed-off-by: Ashwin Vaidya <ashwinnitinvaidya@gmail.com>

---------

Signed-off-by: Bepitic <bepitic@gmail.com>
Signed-off-by: Ashwin Vaidya <ashwinnitinvaidya@gmail.com>
Co-authored-by: Dick Ameln <dick.ameln@intel.com>
Co-authored-by: Alexander Dokuchaev <alexander.dokuchaev@intel.com>
Co-authored-by: TurboJonte <turbojonte@gmail.com>
Co-authored-by: Paco <bepitic@gmail.com>
Co-authored-by: Dick Ameln <amelndjd@gmail.com>
Co-authored-by: Ashwin Vaidya <ashwin.vaidya@intel.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants