onnxruntime/docs/python
Justin Chu d834ec895a
Adopt linrtunner as the linting tool - take 2 (#15085)
### 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:
	

![image](https://user-images.githubusercontent.com/11205048/212598953-d60ce8a9-f242-4fa8-8674-8696b704604a.png)

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>
2023-03-24 15:29:03 -07:00
..
inference Adopt linrtunner as the linting tool - take 2 (#15085) 2023-03-24 15:29:03 -07:00
training Format all python files under onnxruntime with black and isort (#11324) 2022-04-26 09:35:16 -07:00
README.rst Bump ORT version number (#14226) 2023-01-26 12:33:47 -08:00
ReadMeOV.rst Openvino ep 2022.3 v4.3 (#14210) 2023-01-11 16:31:26 -08:00
requirements.txt Pin sphinx to avoid broken link (#14383) 2023-01-21 09:50:56 -08:00

ONNX Runtime
============

ONNX Runtime is a performance-focused scoring engine for Open Neural Network Exchange (ONNX) models.
For more information on ONNX Runtime, please see `aka.ms/onnxruntime <https://aka.ms/onnxruntime/>`_ or the `Github project <https://github.com/microsoft/onnxruntime/>`_.


Changes
-------

1.15.0
^^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.15.0

1.14.0
^^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.14.0

1.13.0
^^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.13.0

1.12.0
^^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.12.0

1.11.0
^^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.11.0

1.10.0
^^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.10.0

1.9.0
^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.9.0

1.8.2
^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.8.2

1.8.1
^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.8.1

1.8.0
^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.8.0

1.7.0
^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.7.0

1.6.0
^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.6.0

1.5.3
^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.5.3

1.5.2
^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.5.2

1.5.1
^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.5.1


1.4.0
^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.4.0

1.3.1
^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.3.1

1.3.0
^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.3.0

1.2.0
^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.2.0

1.1.0
^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.1.0

1.0.0
^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v1.0.0

0.5.0
^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v0.5.0

0.4.0
^^^^^

Release Notes : https://github.com/Microsoft/onnxruntime/releases/tag/v0.4.0