Document all C# API pubic interfaces #5853
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yuslepukhin
commented
Nov 19, 2020
csharp/test/Microsoft.ML.OnnxRuntime.Tests/Microsoft.ML.OnnxRuntime.Tests.csproj
Outdated
Show resolved
Hide resolved
yuslepukhin
commented
Nov 19, 2020
csharp/tools/Microsoft.ML.OnnxRuntime.PerfTool/Microsoft.ML.OnnxRuntime.PerfTool.csproj
Outdated
Show resolved
Hide resolved
yuslepukhin
commented
Nov 19, 2020
pranavsharma
previously approved these changes
Nov 19, 2020
pranavsharma
previously approved these changes
Nov 20, 2020
pranavsharma
approved these changes
Nov 20, 2020
edgchen1
reviewed
Nov 20, 2020
| /// using either a explicit call to Dispose() method or | ||
| /// a pattern of using() block. If this is a member of another | ||
| /// class that class must also become IDisposable and it must | ||
| /// dispose of InferfenceSession in its Dispose() method. |
Contributor
There was a problem hiding this comment.
"InferfenceSession" -> "InferenceSession"
| /// This property queries model metadata, constructs | ||
| /// an instance of ModelMetadata and caches it | ||
| /// </summary> | ||
| /// <returns>Instance of ModelMetdata</returns> |
Contributor
There was a problem hiding this comment.
ModelMetdata -> ModelMetadata
|
|
||
| /// <summary> | ||
| /// Constructs an instance of NamedOnnxValue and represents | ||
| /// a model input to an inference session. It also represents a modle output |
| #region SafeHandle | ||
| /// <summary> | ||
| /// Overrides SafeHandle.ReleaseHandle() to properly dispose of | ||
| /// the native instance of OrtIoBidning |
Contributor
There was a problem hiding this comment.
OrtIoBidning -> OrtIoBinding
| /// </param> | ||
| /// <param name="elementType">discovered tensor element type</param> | ||
| /// <returns></returns> | ||
| /// <returns>And instance of OrtValue constructed on top of the object</returns> |
|
|
||
|
|
||
| /// <summary> | ||
| /// Default __ctor. Creates default RuntimeOptions |
| /// Log Verbosity Level for the session logs. Default = 0. Valid values are >=0. | ||
| /// This takes into effect only when the LogSeverityLevel is set to ORT_LOGGING_LEVEL_VERBOSE. | ||
| /// </summary> | ||
| /// <value>returns _logVerbosityLevel value</value> |
Contributor
There was a problem hiding this comment.
nit: a lot of these comments seem to not provide useful information, just implementation details
|
|
||
| private readonly Type _primitiveType; | ||
| /// <summary> | ||
| /// Constructs TensorBae |
| <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.2.0" /> | ||
| <PackageReference Include="xunit" Version="2.4.1" /> | ||
| <PackageReference Include="xunit.runner.visualstudio" Version="2.4.1" /> | ||
| <PackageReference Include="xunit.runner.visualstudio" Version="2.4.1" /> |
Contributor
There was a problem hiding this comment.
nit: general comment, trailing whitespace
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Supply missing documentation pieces. Prepare to generate doc pages.