Skip to content

[Doc] Update README.md regarding Protobuf update and fix typo in Slice-13 spec #5435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 21, 2023

Conversation

jcwchen
Copy link
Member

@jcwchen jcwchen commented Jul 20, 2023

Description

  • README.md
    • Mention Protobuf will be internally installed if there is not preinstalled Protobuf.
    • Upgrade recommended Protobuf version from 3.20.2 to 4.21.12, which is the same version as what release pipelines are using.
  • Potential Slice-13 typo: start[i] -> starts[i], end[i] -> ends[i], step[i] -> steps[i]. Not sure whether it is intended, but they seem misleading -- Users might mistake the correct attribute name steps for step. Thanks @satyajandhyala for catching this.

Motivation and Context

  • With Support protobuf v22.x in cmake #5196, now ONNX is able to install Protobuf internally if there is not preinstalled Protobuf. README.md should reflect that enhancement. Besides, currently release Pipelines are using Protobuf 21.12 (4.21.12) and so let's upgrade the recommended Protobuf version as 21.12 accordingly.
  • Possible typo in Slice-13 doc.

jcwchen added 2 commits July 20, 2023 08:00
Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
@jcwchen jcwchen added topic: operator Issues related to ONNX operators topic: build Issues related to ONNX builds and packages topic: documentation Issues related to ONNX documentation labels Jul 20, 2023
@jcwchen jcwchen requested review from a team as code owners July 20, 2023 15:47
@xadupre xadupre added this pull request to the merge queue Jul 21, 2023
Merged via the queue into onnx:main with commit ce6257a Jul 21, 2023
adityagoel4512 pushed a commit to adityagoel4512/onnx that referenced this pull request Jul 28, 2023
…e-13 spec (onnx#5435)

### Description
<!-- - Describe your changes. -->
- README.md
- Mention Protobuf will be internally installed if there is not
preinstalled Protobuf.
- Upgrade recommended Protobuf version from 3.20.2 to 4.21.12, which is
the same version as what release pipelines are using.
- Potential Slice-13 typo: `start[i]` -> `starts[i]`, `end[i]` ->
`ends[i]`, `step[i]` -> `steps[i]`. Not sure whether it is intended, but
they seem misleading -- Users might mistake the correct attribute name
`steps` for `step`. Thanks @satyajandhyala for catching this.

### Motivation and Context
<!-- - Why is this change required? What problem does it solve? -->
<!-- - If it fixes an open issue, please link to the issue here. -->
- With onnx#5196, now ONNX is able to
install Protobuf internally if there is not preinstalled Protobuf.
README.md should reflect that enhancement. Besides, currently release
Pipelines are using Protobuf 21.12 (4.21.12) and so let's upgrade the
recommended Protobuf version as 21.12 accordingly.
- Possible typo in Slice-13 doc.

---------

Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
Signed-off-by: Aditya Goel <agoel4512@gmail.com>
adityagoel4512 pushed a commit to adityagoel4512/onnx that referenced this pull request Jul 28, 2023
…e-13 spec (onnx#5435)

### Description
<!-- - Describe your changes. -->
- README.md
- Mention Protobuf will be internally installed if there is not
preinstalled Protobuf.
- Upgrade recommended Protobuf version from 3.20.2 to 4.21.12, which is
the same version as what release pipelines are using.
- Potential Slice-13 typo: `start[i]` -> `starts[i]`, `end[i]` ->
`ends[i]`, `step[i]` -> `steps[i]`. Not sure whether it is intended, but
they seem misleading -- Users might mistake the correct attribute name
`steps` for `step`. Thanks @satyajandhyala for catching this.

### Motivation and Context
<!-- - Why is this change required? What problem does it solve? -->
<!-- - If it fixes an open issue, please link to the issue here. -->
- With onnx#5196, now ONNX is able to
install Protobuf internally if there is not preinstalled Protobuf.
README.md should reflect that enhancement. Besides, currently release
Pipelines are using Protobuf 21.12 (4.21.12) and so let's upgrade the
recommended Protobuf version as 21.12 accordingly.
- Possible typo in Slice-13 doc.

---------

Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
Signed-off-by: Aditya Goel <agoel4512@gmail.com>
adityagoel4512 pushed a commit to adityagoel4512/onnx that referenced this pull request Jul 28, 2023
…e-13 spec (onnx#5435)

### Description
<!-- - Describe your changes. -->
- README.md
- Mention Protobuf will be internally installed if there is not
preinstalled Protobuf.
- Upgrade recommended Protobuf version from 3.20.2 to 4.21.12, which is
the same version as what release pipelines are using.
- Potential Slice-13 typo: `start[i]` -> `starts[i]`, `end[i]` ->
`ends[i]`, `step[i]` -> `steps[i]`. Not sure whether it is intended, but
they seem misleading -- Users might mistake the correct attribute name
`steps` for `step`. Thanks @satyajandhyala for catching this.

### Motivation and Context
<!-- - Why is this change required? What problem does it solve? -->
<!-- - If it fixes an open issue, please link to the issue here. -->
- With onnx#5196, now ONNX is able to
install Protobuf internally if there is not preinstalled Protobuf.
README.md should reflect that enhancement. Besides, currently release
Pipelines are using Protobuf 21.12 (4.21.12) and so let's upgrade the
recommended Protobuf version as 21.12 accordingly.
- Possible typo in Slice-13 doc.

---------

Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
Signed-off-by: Aditya Goel <agoel4512@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: build Issues related to ONNX builds and packages topic: documentation Issues related to ONNX documentation topic: operator Issues related to ONNX operators
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants