Complain about RFC2119 terms, and fix usage #796
Merged
Conversation
This file contains 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
inexorabletash
force-pushed
the
rfc2119
branch
from
2ee6825 to
b722192
Compare
inexorabletash
commented
Dec 3, 2024
| @@ -1446,7 +1453,7 @@ dictionary MLTensorDescriptor : MLOperandDescriptor { | |||
|
|
|||
| The {{MLTensor}} interface represents a tensor which may be used as an input or output to an {{MLGraph}}. The memory backing an {{MLTensor}} should be allocated in an [=implementation-defined=] fashion according to the requirements of the {{MLContext}} and the {{MLTensorDescriptor}} used to create it. Operations involving the {{MLTensor/[[data]]}} of an {{MLTensor}} occur on the {{MLContext/[[timeline]]}} of its associated {{MLContext}}. | |||
|
|
|||
| Note: The [=implementation-defined=] requirements of how an {{MLTensor}} is allocated may include constraints such as that the memory is allocated with a particular byte alignment or in a particular memory pool. | |||
| The [=implementation-defined=] requirements of how an {{MLTensor}} is allocated may include constraints such as that the memory is allocated with a particular byte alignment or in a particular memory pool. | |||
There was a problem hiding this comment.
I changed this from an informative note to a normative statement since it seems to exactly be in the spirit of normative RFC2119's "may".
|
@huningxin & @fdwr - could you please review? But this is low priority! |
|
Looks good. Ugh. Spec editing is becoming super standardized. Almost programming. Might be good one day for automating implementations by AI. :) |
fdwr
approved these changes
Dec 3, 2024
github-actions bot
added a commit
that referenced
this pull request
Dec 4, 2024
SHA: df555e1 Reason: push, by huningxin Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.
A local change I had that needed dusting off. It's probably worth reviewing/merging, but not urgently.
Preview | Diff