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
[DOCS] Change some tutorial text #6514
Conversation
docs/install/from_source.rst
Outdated
@@ -205,7 +205,7 @@ like ``virtualenv``. | |||
|
|||
.. code:: bash | |||
|
|||
pip3 install --user numpy decorator attrs | |||
pip3 install --user numpy decorator attrs typed_ast pytest |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to python/setup.py
, the complete list should also include scipy
and psutil
, but not pytest
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was following the instructions literally on a new ubuntu 20.04 install and these are the changes I needed to make to get the example to work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see. Which example did you try? In general if users only want to use instead of developing TVM, we should not ask them to install unnecessary packages such as pytest
and mypy
.
IMHO, we could indicate an example at the end of this doc to make it clear. It might be better to also add descriptions about installing extra requirements for developments (e.g., testing).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps we can add a new section
- If you want to run unit tests
pip3 install --user ...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a good idea to me 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I reverted this change. To do this right I would need to start with a new clean linux install and go through the process to figure out what is needed for running unit tests.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, we should eventually fix this properly with an official requirements.txt
or setup.py
set of dependencies, so people don't have to roll their own lists.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rkimball would you prefer to add the unit test section in this PR or file a follow-up PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think follow up PR to do what @binarybana suggests
thanks @rkimball @comaniac @binarybana |
I had a few issues following the how to install from source on linux so I addressed them here.