Skip to content
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

[Doc][Relay] Add VM doc #3188

Merged
merged 16 commits into from
May 27, 2019
Merged

[Doc][Relay] Add VM doc #3188

merged 16 commits into from
May 27, 2019

Conversation

wweic
Copy link
Contributor

@wweic wweic commented May 13, 2019

docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
@slyubomirsky
Copy link
Contributor

Will give this a review soon

docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
Copy link
Member

@zhiics zhiics left a comment

Choose a reason for hiding this comment

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

In the "Instruction Set" section, some of the variables are put in the code block, but others are not. Please keep them consistent.

docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@slyubomirsky slyubomirsky left a comment

Choose a reason for hiding this comment

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

I've left mostly grammar and style feedback. On a high level, I think this document does a good job of establishing the context for the Relay VM, but could stand to be more specific about what exactly the VM does to solve the problems that the interpreter and graph runtime have; I don't think that would require very large additions to the text.

docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
wweic and others added 6 commits May 16, 2019 10:09
Co-Authored-By: Steven S. Lyubomirsky <slyubomirsky@gmail.com>
Co-Authored-By: 雾雨魔理沙 <lolisa@marisa.moe>
Co-Authored-By: Logan Weber <36520469+weberlo@users.noreply.github.com>
Co-Authored-By: Zhi <5145158+zhiics@users.noreply.github.com>
@wweic
Copy link
Contributor Author

wweic commented May 16, 2019

Thanks everyone! Addressed all comments. Please take another look.

docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
Co-Authored-By: 雾雨魔理沙 <lolisa@marisa.moe>
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
wweic and others added 3 commits May 18, 2019 14:51
Co-Authored-By: Logan Weber <36520469+weberlo@users.noreply.github.com>
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
Co-Authored-By: Logan Weber <36520469+weberlo@users.noreply.github.com>
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
Co-Authored-By: Yong Wu <55wuyong@163.com>
@wweic
Copy link
Contributor Author

wweic commented May 23, 2019

ping reviewers(@jroesch @tqchen @zhiics @icemelon9 @MarisaKirisame @yongwww @joshpoll @weberlo @slyubomirsky @junrushao1994 @nhynes), please take another look at this PR. thanks!

Copy link
Contributor

@slyubomirsky slyubomirsky left a comment

Choose a reason for hiding this comment

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

One minor suggestion, but I think besides that suggestion (and besides the open TODO), this is a good overview

docs/dev/virtual_machine.rst Outdated Show resolved Hide resolved
@slyubomirsky
Copy link
Contributor

LGTM

@jroesch jroesch merged commit c0afc91 into apache:master May 27, 2019
wweic added a commit to wweic/tvm that referenced this pull request Jun 26, 2019
* [Doc][Relay] Add VM doc

* Add Apache header

* Apply suggestions from code review

Co-Authored-By: Steven S. Lyubomirsky <slyubomirsky@gmail.com>
Co-Authored-By: 雾雨魔理沙 <lolisa@marisa.moe>
Co-Authored-By: Logan Weber <36520469+weberlo@users.noreply.github.com>
Co-Authored-By: Zhi <5145158+zhiics@users.noreply.github.com>

* Junru's comment

* More fix

* More fix

* More fix

* last fix

* Apply suggestions from code review

Co-Authored-By: 雾雨魔理沙 <lolisa@marisa.moe>

* Apply suggestions from code review

Co-Authored-By: Logan Weber <36520469+weberlo@users.noreply.github.com>

* Add code links

* Remove unused bp

* Update docs/dev/virtual_machine.rst

Co-Authored-By: Logan Weber <36520469+weberlo@users.noreply.github.com>

* Explain TODO

* Yong's comment

Co-Authored-By: Yong Wu <55wuyong@163.com>

* Comment
wweic added a commit to neo-ai/tvm that referenced this pull request Jun 27, 2019
* [Doc][Relay] Add VM doc

* Add Apache header

* Apply suggestions from code review

Co-Authored-By: Steven S. Lyubomirsky <slyubomirsky@gmail.com>
Co-Authored-By: 雾雨魔理沙 <lolisa@marisa.moe>
Co-Authored-By: Logan Weber <36520469+weberlo@users.noreply.github.com>
Co-Authored-By: Zhi <5145158+zhiics@users.noreply.github.com>

* Junru's comment

* More fix

* More fix

* More fix

* last fix

* Apply suggestions from code review

Co-Authored-By: 雾雨魔理沙 <lolisa@marisa.moe>

* Apply suggestions from code review

Co-Authored-By: Logan Weber <36520469+weberlo@users.noreply.github.com>

* Add code links

* Remove unused bp

* Update docs/dev/virtual_machine.rst

Co-Authored-By: Logan Weber <36520469+weberlo@users.noreply.github.com>

* Explain TODO

* Yong's comment

Co-Authored-By: Yong Wu <55wuyong@163.com>

* Comment
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.

8 participants