Skip to content

[Docs][Bug] Fix broken link to tvmc python#13499

Merged
gromero merged 1 commit into
apache:mainfrom
bkmgit:tutorial-link-fix
Nov 29, 2022
Merged

[Docs][Bug] Fix broken link to tvmc python#13499
gromero merged 1 commit into
apache:mainfrom
bkmgit:tutorial-link-fix

Conversation

@bkmgit
Copy link
Copy Markdown
Contributor

@bkmgit bkmgit commented Nov 28, 2022

Ensure correct link is generated to the next page in the documentation.

@tvm-bot
Copy link
Copy Markdown
Collaborator

tvm-bot commented Nov 28, 2022

Thanks for contributing to TVM! Please refer to the contributing guidelines https://tvm.apache.org/docs/contribute/ for useful information and tips. Please request code reviews from Reviewers by @-ing them in a comment.

  • No users to tag found in teams: docs, bug See #10317 for details
  • Built docs for commit d0a5146 can be found here.

Generated by tvm-bot

Copy link
Copy Markdown
Contributor

@leandron leandron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @bkmgit

@gromero
Copy link
Copy Markdown
Contributor

gromero commented Nov 28, 2022

@bkmgit
Copy link
Copy Markdown
Contributor Author

bkmgit commented Nov 28, 2022

@gromero Thanks for your feedback. That is not the next tutorial in the sequence obtained at the bottom of the page . The link you have suggested could be used but then it would be helpful to rephrase

In the next tutorial, Compiling and Optimizing a Model with the Python Interface,
we will cover the same compilation and optimization steps using the Python interface.

to

In the next tutorial, we introduce the Python interface to TVM, and in the tutorial after that,
Compiling and Optimizing a Model with the Python Interface, we will cover the same
compilation and optimization steps using the Python interface.

@gromero
Copy link
Copy Markdown
Contributor

gromero commented Nov 28, 2022

@gromero Thanks for your feedback. That is not the next tutorial in the sequence obtained at the bottom of the page . The link you have suggested could be used but then it would be helpful to rephrase

@bkmgit Got it!

In the next tutorial, we introduce the Python interface to TVM, and in the tutorial after that, Compiling and Optimizing a Model with the Python Interface, we will cover the same compilation and optimization steps using the Python interface.

yeah I'm ok with that version.

Another option would be to just adjusting the text in your change, i.e. in tvmc_command_line_driver.py, to match the new link, so (remove the wrong tutorial title text):

"In the next tutorial, Getting Starting using TVMC Python: a high-level API for TVM, we introduce the Python interface to TVM."

and move the second part to the bottom of tutorial tvmc_python.py.

"In the next tutorial, Compiling and Optimizing a Model with the Python Interface, we will cover the same compilation and optimization steps using the Python interface."

But either way works for me.

Copy link
Copy Markdown
Contributor

@gromero gromero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bkmgit The important thing here I think is to keep the text matching the fixed link, either by updating the text to match the tvmc_pyton.py tutorial title or by removing the stale text that became outdated by the new (fixed) link.

@bkmgit
Copy link
Copy Markdown
Contributor Author

bkmgit commented Nov 29, 2022

@gromero Thanks for the feedback. Done.

@bkmgit bkmgit requested a review from gromero November 29, 2022 12:19
Ensure correct link is generated to the next page in the documentation.
Update description to indicate next section introduces Python API, and
the section after that discusses the same material but using Python
rather than the command line interface.
Copy link
Copy Markdown
Contributor

@gromero gromero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bkmgit Thanks a lot for the new version, and specially for being careful updating the commit message accordingly , and also for taking care of the trailing spaces! ;-)

@gromero
Copy link
Copy Markdown
Contributor

gromero commented Nov 29, 2022

@leandron Since there are changes since your last review, would you like to take another look? Thanks!

Copy link
Copy Markdown
Contributor

@leandron leandron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@gromero gromero merged commit b9f89a2 into apache:main Nov 29, 2022
@bkmgit bkmgit deleted the tutorial-link-fix branch November 30, 2022 06:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants