mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-05-15 20:50:42 +00:00
d834ec895a
### Description `lintrunner` is a linter runner successfully used by pytorch, onnx and onnx-script. It provides a uniform experience running linters locally and in CI. It supports all major dev systems: Windows, Linux and MacOs. The checks are enforced by the `Python format` workflow. This PR adopts `lintrunner` to onnxruntime and fixed ~2000 flake8 errors in Python code. `lintrunner` now runs all required python lints including `ruff`(replacing `flake8`), `black` and `isort`. Future lints like `clang-format` can be added. Most errors are auto-fixed by `ruff` and the fixes should be considered robust. Lints that are more complicated to fix are applied `# noqa` for now and should be fixed in follow up PRs. ### Notable changes 1. This PR **removed some suboptimal patterns**: - `not xxx in` -> `xxx not in` membership checks - bare excepts (`except:` -> `except Exception`) - unused imports The follow up PR will remove: - `import *` - mutable values as default in function definitions (`def func(a=[])`) - more unused imports - unused local variables 2. Use `ruff` to replace `flake8`. `ruff` is much (40x) faster than flake8 and is more robust. We are using it successfully in onnx and onnx-script. It also supports auto-fixing many flake8 errors. 3. Removed the legacy flake8 ci flow and updated docs. 4. The added workflow supports SARIF code scanning reports on github, example snapshot:  5. Removed `onnxruntime-python-checks-ci-pipeline` as redundant ### Motivation and Context <!-- - Why is this change required? What problem does it solve? - If it fixes an open issue, please link to the issue here. --> Unified linting experience in CI and local. Replacing https://github.com/microsoft/onnxruntime/pull/14306 --------- Signed-off-by: Justin Chu <justinchu@microsoft.com>
101 lines
2.7 KiB
Python
101 lines
2.7 KiB
Python
# Copyright (c) Microsoft Corporation. All rights reserved.
|
|
# Licensed under the MIT License.
|
|
|
|
# -*- coding: utf-8 -*-
|
|
#
|
|
# Configuration file for the Sphinx documentation builder.
|
|
|
|
import os
|
|
import shutil # noqa: F401
|
|
import sys # noqa: F401
|
|
|
|
import onnxruntime
|
|
|
|
# import recommonmark
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = "ONNX Runtime"
|
|
copyright = "2018-2023, Microsoft"
|
|
author = "Microsoft"
|
|
version = onnxruntime.__version__
|
|
release = version
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
extensions = [
|
|
"alabaster",
|
|
"sphinx.ext.intersphinx",
|
|
"sphinx.ext.imgmath",
|
|
"sphinx.ext.ifconfig",
|
|
"sphinx.ext.viewcode",
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.githubpages",
|
|
"sphinx_gallery.gen_gallery",
|
|
"sphinx.ext.graphviz",
|
|
"pyquickhelper.sphinxext.sphinx_runpython_extension",
|
|
"sphinxcontrib.googleanalytics",
|
|
]
|
|
|
|
templates_path = ["_templates"]
|
|
|
|
source_parsers = {
|
|
".md": "recommonmark.parser.CommonMarkParser",
|
|
}
|
|
|
|
source_suffix = [".rst"] # , '.md']
|
|
|
|
master_doc = "index"
|
|
language = "en"
|
|
exclude_patterns = []
|
|
pygments_style = "default"
|
|
autoclass_content = "both"
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
html_theme = "alabaster"
|
|
html_logo = "ONNX_Runtime_icon.png"
|
|
html_static_path = ["_static"]
|
|
graphviz_output_format = "svg"
|
|
|
|
# -- Options for Google Analytics -------------------------------------------------
|
|
|
|
googleanalytics_id = "UA-156955408-1"
|
|
|
|
# -- Options for intersphinx extension ---------------------------------------
|
|
|
|
# Example configuration for intersphinx: refer to the Python standard library.
|
|
intersphinx_mapping = {"https://docs.python.org/": None}
|
|
|
|
# -- Options for Sphinx Gallery ----------------------------------------------
|
|
|
|
sphinx_gallery_conf = {
|
|
"examples_dirs": "examples",
|
|
"gallery_dirs": "auto_examples",
|
|
}
|
|
|
|
# -- markdown options -----------------------------------------------------------
|
|
|
|
md_image_dest = "media"
|
|
md_link_replace = {
|
|
"#onnxruntimesessionoptionsenable-profiling)": "#class-onnxruntimesessionoptions)",
|
|
}
|
|
|
|
# -- Setup actions -----------------------------------------------------------
|
|
|
|
|
|
def setup(app):
|
|
# download examples for the documentation
|
|
this = os.path.abspath(os.path.dirname(__file__))
|
|
dest = os.path.join(this, "model.onnx")
|
|
if not os.path.exists(dest):
|
|
import urllib.request
|
|
|
|
url = "https://raw.githubusercontent.com/onnx/onnx/master/onnx/backend/test/data/node/test_sigmoid/model.onnx"
|
|
urllib.request.urlretrieve(url, dest)
|
|
loc = os.path.split(dest)[-1]
|
|
if not os.path.exists(loc):
|
|
import shutil # noqa: F811
|
|
|
|
shutil.copy(dest, loc)
|
|
return app
|