diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 97e4258f2d..706702042c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,20 +4,21 @@ We're always looking for your help to fix bugs and improve the product. Create a Start by reading the [Engineering Design](docs/HighLevelDesign.md). # Checkin procedure -``` -git clone --recursive https://github.com/Microsoft/onnxruntime -git checkout -b feature_branch -# make your changes -# write unit tests -# make sure it builds and all tests pass -git commit -m "my changes" -git push origin HEAD -``` -To request merge into master send a pull request from the web ui -https://github.com/Microsoft/onnxruntime and add 'Microsoft/onnxruntime' as a reviewer. +1. Fork the repo +2. git clone your fork +3. Create feature branch +4. Make and checkin your changes along with unit tests +5. git commit your changes +6. git push origin HEAD +7. To request merge into master send a pull request from the web ui +https://github.com/Microsoft/onnxruntime. +8. Add 'Microsoft/onnxruntime' as a reviewer. New code *must* be accompanied by unit tests. +*Note*: After creating a pull request, you might not see a build getting triggered right away. One of the +onnxruntime team members will trigger the build for you. + # Build [Build](BUILD.md) diff --git a/docs/HighLevelDesign.md b/docs/HighLevelDesign.md index 8e6b955934..f5766417fc 100644 --- a/docs/HighLevelDesign.md +++ b/docs/HighLevelDesign.md @@ -69,7 +69,7 @@ implying the kernels are stateless. * Implementations of the operators by execution providers are called kernels. Each execution provider supports a subset of the (ONNX) operators/kernels. -* The ONNXRuntime runtime guarantees that all operators are supported by the default +* The ONNX Runtime guarantees that all operators are supported by the default execution provider. * Tensor representation: ONNXRuntime will utilize a standard representation for the tensor runtime values. The execution providers can internally use a diff --git a/include/onnxruntime/core/framework/execution_provider.h b/include/onnxruntime/core/framework/execution_provider.h index 04e30f150b..bbbbde7799 100644 --- a/include/onnxruntime/core/framework/execution_provider.h +++ b/include/onnxruntime/core/framework/execution_provider.h @@ -65,7 +65,7 @@ class IExecutionProvider { with multiple sessions/models. 2. Adding an execution provider into ONNXRuntime does not need to touch ONNXRuntime frameowrk/session code. - 3. onnxruntime runtime (framework/session) does not depend on any specific + 3. onnxruntime (framework/session) does not depend on any specific execution provider lib. */ virtual std::shared_ptr GetKernelRegistry() const = 0; diff --git a/setup.py b/setup.py index 33a459efea..8cf65967cc 100644 --- a/setup.py +++ b/setup.py @@ -54,7 +54,7 @@ with open(README) as f: setup( name=package_name, version='0.1.5', - description='ONNX Runtime Runtime Python bindings', + description='ONNX Runtime Python bindings', long_description=long_description, author='Microsoft Corporation', author_email='onnx@microsoft.com',