Skip to content

Commit

Permalink
Minor documentation changes (microsoft#78)
Browse files Browse the repository at this point in the history
  • Loading branch information
pranavsharma authored Dec 3, 2018
1 parent 07253fd commit b7cc611
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 14 deletions.
23 changes: 12 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion docs/HighLevelDesign.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion include/onnxruntime/core/framework/execution_provider.h
Original file line number Diff line number Diff line change
Expand Up @@ -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<KernelRegistry> GetKernelRegistry() const = 0;
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ def finalize_options(self):
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='[email protected]',
Expand Down

0 comments on commit b7cc611

Please sign in to comment.