diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..8a6c241 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +# Preserve upstream document bytes and original whitespace on every platform. +upstream/** -text -whitespace diff --git a/LICENSE b/LICENSE index 48bc6bb..d645695 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,202 @@ -MIT License - -Copyright (c) Microsoft Corporation - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..6314b45 --- /dev/null +++ b/NOTICE @@ -0,0 +1,8 @@ +onnxruntime-m: C++ module wrapper +Copyright (c) 2026 mcpp-community contributors + +The wrapper contributions are licensed under the Apache License, Version 2.0. +Upstream code, copied interfaces, generated bindings and dependencies retain +their original licenses and copyright notices. Original upstream README and +license documents are retained in upstream/onnxruntime/; provenance and checksums +are recorded in upstream/documents.json. diff --git a/README.md b/README.md index 27e9798..7f55bcd 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ **English** · [简体中文](README.zh.md) · [Upstream](https://github.com/microsoft/onnxruntime) · [Releases](https://github.com/mcpplibs/onnxruntime-m/releases) · [mcpp](https://github.com/mcpp-community/mcpp) · [Index](https://github.com/mcpplibs/mcpp-index) [![C++23](https://img.shields.io/badge/C%2B%2B-23-blue.svg)](https://en.cppreference.com/w/cpp/23) -[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) +[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE) +[![mcpp-community](https://img.shields.io/badge/mcpp--community-mwrap-blue)](https://github.com/mcpp-community) [![CI](https://github.com/mcpplibs/onnxruntime-m/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/mcpplibs/onnxruntime-m/actions/workflows/ci.yml) ## Modules @@ -19,14 +20,14 @@ ## Quick start ```sh -mcpp new inference --template mcpplibs.mwrap.onnxruntime@1.25.1 +mcpp new inference --template mcpplibs.mwrap.onnxruntime@1.25.1.1 cd inference mcpp run ``` ```toml [dependencies] -mcpplibs.mwrap.onnxruntime = "1.25.1" +mcpplibs.mwrap.onnxruntime = "1.25.1.1" ``` ## Existing projects @@ -46,5 +47,7 @@ GPU, musl and MinGW need separate SDKs. The template executes an embedded Identi ## Documentation -[Usage and mixing limits](docs/usage.md) · [SDK provenance](upstream) · [Tests](tests) · [MIT](LICENSE) +[Usage and mixing limits](docs/usage.md) · [SDK provenance](upstream) · [Tests](tests) · [Apache-2.0](LICENSE) The SDK retains its MIT license and ThirdPartyNotices.txt. + +Wrapper: Apache-2.0, mcpp-community. [Original upstream README and licenses](upstream/onnxruntime/). Upstream licenses remain unchanged. diff --git a/README.zh.md b/README.zh.md index f1823cb..ac8afdc 100644 --- a/README.zh.md +++ b/README.zh.md @@ -5,7 +5,8 @@ [English](README.md) · **简体中文** · [Upstream](https://github.com/microsoft/onnxruntime) · [Releases](https://github.com/mcpplibs/onnxruntime-m/releases) · [mcpp](https://github.com/mcpp-community/mcpp) · [Index](https://github.com/mcpplibs/mcpp-index) [![C++23](https://img.shields.io/badge/C%2B%2B-23-blue.svg)](https://en.cppreference.com/w/cpp/23) -[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) +[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE) +[![mcpp-community](https://img.shields.io/badge/mcpp--community-mwrap-blue)](https://github.com/mcpp-community) [![CI](https://github.com/mcpplibs/onnxruntime-m/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/mcpplibs/onnxruntime-m/actions/workflows/ci.yml) ## 模块 @@ -19,14 +20,14 @@ ## 快速开始 ```sh -mcpp new inference --template mcpplibs.mwrap.onnxruntime@1.25.1 +mcpp new inference --template mcpplibs.mwrap.onnxruntime@1.25.1.1 cd inference mcpp run ``` ```toml [dependencies] -mcpplibs.mwrap.onnxruntime = "1.25.1" +mcpplibs.mwrap.onnxruntime = "1.25.1.1" ``` ## 已有项目 @@ -46,5 +47,7 @@ GPU、musl、MinGW 需要独立 SDK；模板实际执行内嵌 Identity 模型 ## 文档 -[使用与混用限制](docs/usage.md) · [SDK 来源](upstream) · [测试](tests) · [MIT](LICENSE) +[使用与混用限制](docs/usage.md) · [SDK 来源](upstream) · [测试](tests) · [Apache-2.0](LICENSE) SDK 保留 MIT 许可证与 ThirdPartyNotices.txt。 + +封装：Apache-2.0，mcpp-community。[上游原始 README 与许可证](upstream/onnxruntime/)，上游许可保持原样。 diff --git a/docs/usage.md b/docs/usage.md index 4c47eb2..5adc456 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -8,7 +8,7 @@ the C API retain their original namespaces and types. ```toml [dependencies."mcpplibs.mwrap"] -onnxruntime = "1.25.1" +onnxruntime = "1.25.1.1" [target.x86_64-linux-gnu] cxx_runtime = "toolchain-coupled" @@ -31,7 +31,7 @@ SDK builds and are not supplied by this version. ## Quickstart template ```sh -mcpp new inference --template mcpplibs.mwrap.onnxruntime@1.25.1 +mcpp new inference --template mcpplibs.mwrap.onnxruntime@1.25.1.1 cd inference mcpp run ``` diff --git a/mcpp.toml b/mcpp.toml index 4ecfad4..487c6f4 100644 --- a/mcpp.toml +++ b/mcpp.toml @@ -2,12 +2,14 @@ [package] namespace = "mcpplibs.mwrap" name = "onnxruntime" -version = "1.25.1" +version = "1.25.1.1" description = "ONNX Runtime 1.25.1 C/C++ APIs as C++ modules, with upstream names preserved" -license = "MIT" +license = "Apache-2.0" +authors = ["mcpp-community"] repo = "https://github.com/mcpplibs/onnxruntime-m" [package.metadata.mwrap] +wrapper-revision = 1 upstream-version = "1.25.1" upstream-repo = "https://github.com/microsoft/onnxruntime" @@ -25,3 +27,19 @@ kind = "lib" # executable must share that runtime rather than embed a second copy. [target.x86_64-linux-gnu] cxx_runtime = "toolchain-coupled" + +[[runtime.deploy]] +from = "LICENSE" +to = "licenses/onnxruntime" + +[[runtime.deploy]] +from = "NOTICE" +to = "licenses/onnxruntime" + +[[runtime.deploy]] +from = "upstream/onnxruntime/README.md" +to = "licenses/onnxruntime/upstream/onnxruntime" + +[[runtime.deploy]] +from = "upstream/onnxruntime/LICENSE" +to = "licenses/onnxruntime/upstream/onnxruntime" diff --git a/tools/check_mwrap_release.py b/tools/check_mwrap_release.py index 227fd8d..9bedddb 100644 --- a/tools/check_mwrap_release.py +++ b/tools/check_mwrap_release.py @@ -1,6 +1,8 @@ #!/usr/bin/env python3 """Check the immutable mwrap release coordinate and bilingual entry pages.""" import argparse +import hashlib +import json from pathlib import Path import re import tomllib @@ -19,6 +21,21 @@ def main(): assert version == upstream or re.fullmatch(re.escape(upstream) + r'\.[1-9][0-9]*', version), (version, upstream) if args.tag: assert args.tag == 'mwrap-' + version, (args.tag, version) + assert package['license'] == 'Apache-2.0', package['license'] + assert package['authors'] == ['mcpp-community'], package.get('authors') + license_text = (root / 'LICENSE').read_text(encoding='utf-8') + assert 'Apache License' in license_text and 'Version 2.0' in license_text + assert 'mcpp-community' in (root / 'NOTICE').read_text(encoding='utf-8') + documents = json.loads((root / 'upstream/documents.json').read_text(encoding='utf-8'))['documents'] + assert any(Path(d['path']).name.startswith('README') for d in documents) + assert any(Path(d['path']).name.startswith(('LICENSE', 'COPYING')) for d in documents) + deployed = {entry['from'] for entry in tomllib.loads((root / 'mcpp.toml').read_text(encoding='utf-8')).get('runtime', {}).get('deploy', [])} + assert {'LICENSE', 'NOTICE'} <= deployed + for document in documents: + path = Path(document['path']) + assert not path.is_absolute() and '..' not in path.parts and path.parts[0] == 'upstream' + assert hashlib.sha256((root / path).read_bytes()).hexdigest() == document['sha256'], path + assert document['source'] and path.as_posix() in deployed, path identity = package['namespace'] + '.' + package['name'] for name, other in [('README.md', 'README.zh.md'), ('README.zh.md', 'README.md')]: text = (root / name).read_text(encoding="utf-8") diff --git a/tools/test_template.py b/tools/test_template.py index 0de3abb..d041c2f 100644 --- a/tools/test_template.py +++ b/tools/test_template.py @@ -21,10 +21,11 @@ def run(command, cwd, env=None): parser.add_argument("--toolchain", default="llvm@23.1.3") args = parser.parse_args() root = Path(__file__).resolve().parents[1] + version = tomllib.loads((root / "mcpp.toml").read_text(encoding="utf-8"))["package"]["version"] with tempfile.TemporaryDirectory(prefix="mwrap-ort-template-") as directory: temporary = Path(directory) home = temporary / "home" - package = home / "registry/data/xpkgs/mcpplibs.mwrap-x-onnxruntime/1.25.1/onnxruntime-1.25.1" + package = home / f"registry/data/xpkgs/mcpplibs.mwrap-x-onnxruntime/{version}/onnxruntime-{version}" shutil.copytree(root, package, ignore=shutil.ignore_patterns( ".git", "target", ".mcpp", ".xlings", "__pycache__", "mcpp.lock", "compile_commands.json", "candidate-index", "mcpp-2026.*")) index = home / "indices/mcpplibs/pkgs/mwrap" @@ -32,22 +33,22 @@ def run(command, cwd, env=None): (index / "mcpplibs.mwrap.onnxruntime.lua").write_text('''package = { spec="1", namespace="mcpplibs.mwrap", name="onnxruntime", description="Local installed-package template fixture", type="package", -xpm={linux={["1.25.1"]={url="https://example.invalid/ort.tar.gz",sha256="fixture"}}, -macosx={["1.25.1"]={url="https://example.invalid/ort.tar.gz",sha256="fixture"}}, -windows={["1.25.1"]={url="https://example.invalid/ort.zip",sha256="fixture"}}}, +xpm={linux={["__WRAPPER_VERSION__"]={url="https://example.invalid/ort.tar.gz",sha256="fixture"}}, +macosx={["__WRAPPER_VERSION__"]={url="https://example.invalid/ort.tar.gz",sha256="fixture"}}, +windows={["__WRAPPER_VERSION__"]={url="https://example.invalid/ort.zip",sha256="fixture"}}}, mcpp="mcpp.toml"} -''') +'''.replace('__WRAPPER_VERSION__', version)) env = dict(os.environ, MCPP_HOME=str(home)) - run([args.mcpp, "new", "--list-templates", "mcpplibs.mwrap.onnxruntime@1.25.1"], temporary, env) - run([args.mcpp, "new", "inference-app", "--template", "mcpplibs.mwrap.onnxruntime@1.25.1"], temporary, env) + run([args.mcpp, "new", "--list-templates", f"mcpplibs.mwrap.onnxruntime@{version}"], temporary, env) + run([args.mcpp, "new", "inference-app", "--template", f"mcpplibs.mwrap.onnxruntime@{version}"], temporary, env) project = temporary / "inference-app" manifest = project / "mcpp.toml" parsed = tomllib.loads(manifest.read_text()) dependency = parsed["dependencies"]["mcpplibs.mwrap.onnxruntime"] - assert dependency == "1.25.1" or dependency.get("version") == "1.25.1", dependency + assert dependency == version or dependency.get("version") == version, dependency # Keep the rendered dependency's identity/version check above. For an # unpublished candidate, build that exact staged source via a local edge. - text = manifest.read_text().replace('"mcpplibs.mwrap.onnxruntime" = "1.25.1"', + text = manifest.read_text().replace(f'"mcpplibs.mwrap.onnxruntime" = "{version}"', '"mcpplibs.mwrap.onnxruntime" = { path = "' + package.as_posix() + '" }') if args.index: text += '\n[indices]\ncompat = { path = "' + args.index.resolve().as_posix() + '" }\n' diff --git a/upstream/documents.json b/upstream/documents.json new file mode 100644 index 0000000..d2523c9 --- /dev/null +++ b/upstream/documents.json @@ -0,0 +1,15 @@ +{ + "upstream": "https://github.com/microsoft/onnxruntime/tree/v1.25.1", + "documents": [ + { + "path": "upstream/onnxruntime/README.md", + "source": "https://github.com/microsoft/onnxruntime/tree/v1.25.1/README.md", + "sha256": "87f0387d38c0a5e3e448ab3ae3debc38024663ed8e4b2f55c625958764b01e4f" + }, + { + "path": "upstream/onnxruntime/LICENSE", + "source": "https://github.com/microsoft/onnxruntime/tree/v1.25.1/LICENSE", + "sha256": "2f07c72751aed99790b8a4869cf2311df85a860b22ded05fa22803587a48922c" + } + ] +} diff --git a/upstream/onnxruntime/LICENSE b/upstream/onnxruntime/LICENSE new file mode 100644 index 0000000..48bc6bb --- /dev/null +++ b/upstream/onnxruntime/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) Microsoft Corporation + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/upstream/onnxruntime/README.md b/upstream/onnxruntime/README.md new file mode 100644 index 0000000..019bc82 --- /dev/null +++ b/upstream/onnxruntime/README.md @@ -0,0 +1,49 @@ +

+ +**ONNX Runtime is a cross-platform inference and training machine-learning accelerator**. + +**ONNX Runtime inference** can enable faster customer experiences and lower costs, supporting models from deep learning frameworks such as PyTorch and TensorFlow/Keras as well as classical machine learning libraries such as scikit-learn, LightGBM, XGBoost, etc. ONNX Runtime is compatible with different hardware, drivers, and operating systems, and provides optimal performance by leveraging hardware accelerators where applicable alongside graph optimizations and transforms. [Learn more →](https://www.onnxruntime.ai/docs/#onnx-runtime-for-inferencing) + +**ONNX Runtime training** can accelerate the model training time on multi-node NVIDIA GPUs for transformer models with a one-line addition for existing PyTorch training scripts. [Learn more →](https://www.onnxruntime.ai/docs/#onnx-runtime-for-training) + +## Get Started & Resources + +* **General Information**: [onnxruntime.ai](https://onnxruntime.ai) + +* **Usage documentation and tutorials**: [onnxruntime.ai/docs](https://onnxruntime.ai/docs) + +* **YouTube video tutorials**: [youtube.com/@ONNXRuntime](https://www.youtube.com/@ONNXRuntime) + +* [**Upcoming Release Roadmap**](https://onnxruntime.ai/roadmap) + +* **Companion sample repositories**: + - ONNX Runtime Inferencing: [microsoft/onnxruntime-inference-examples](https://github.com/microsoft/onnxruntime-inference-examples) + - ONNX Runtime Training: [microsoft/onnxruntime-training-examples](https://github.com/microsoft/onnxruntime-training-examples) + +## Releases + +The current release and past releases can be found here: https://github.com/microsoft/onnxruntime/releases. + +For details on the upcoming release, including release dates, announcements, features, and guidance on submitting feature requests, please visit the release roadmap: https://onnxruntime.ai/roadmap. + +## Data/Telemetry + +Windows distributions of this project may collect usage data and send it to Microsoft to help improve our products and services. See the [privacy statement](docs/Privacy.md) for more details. + +## Contributions and Feedback + +We welcome contributions! Please see the [contribution guidelines](CONTRIBUTING.md). + +For feature requests or bug reports, please file a [GitHub Issue](https://github.com/Microsoft/onnxruntime/issues). + +For general discussion or questions, please use [GitHub Discussions](https://github.com/microsoft/onnxruntime/discussions). + +## Code of Conduct + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) +or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + +## License + +This project is licensed under the [MIT License](LICENSE).