-
Notifications
You must be signed in to change notification settings - Fork 3.5k
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][BUILD] Small improvements to documentation/build setup for first-time builds #7840
Conversation
LGTM |
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.
Looks good, one minor addition with respect to pinning dependencies. Thank you for catching those two errors in the getting started tutorials. I'm glad you had a chance to take them for a run!
@@ -3,7 +3,7 @@ TVM Documentations | |||
This folder contains the source of TVM documents | |||
|
|||
- A hosted version of doc is at https://tvm.apache.org/docs | |||
- pip install sphinx>=1.5.5 sphinx-gallery sphinx_rtd_theme matplotlib Image recommonmark "Pillow<7" autodocsumm tlcpack-sphinx-addon | |||
- pip install "sphinx>=1.5.5" sphinx-gallery sphinx_rtd_theme matplotlib Image recommonmark "Pillow<7" "autodocsumm<0.2.0" tlcpack-sphinx-addon |
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.
My only comment is a small one. When we pin, we need to document why, and under what conditions we can un-pin. I can't speak to sphinx or Pillow, but we should link to this and note we can remove the pin when the change is in upstream packages. Chilipp/autodocsumm#42 (comment)
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.
Good point, and that makes sense. I will add that to the README.txt shortly.
There's probably also room for the gen_requirements.py to be used more in the docs/examples in the future. From what I can tell, the list of dependencies in it would be a perfect spot to centralize all dependency listings. Right now, it looks like it is primarily used in the CI framework, but the tvm/python/requirements/*.txt
could be referred anywhere that currently has an explicit listing of the required packages.
- Makefile - Target "crttest" ignored OUTPUTDIR variable - .gitignore - Added ignores for download test data/models. - docs/README.txt - Missing quotes on sphinx dep, needs pinned autodocsumm version - docs/contribute/pull_request.rst - Use "ci_lint" docker image - Updated C++ test instructions to refer to the from_source installation for gtest. - Updated python test instructions with synr package dependency - docs/langref/relay_expr.rst - Updated reference for example usage of TempExpr. `src/relay/pass/alter_op_layout.cc` no longer exists, and `src/relay/transforms/alter_op_layout.cc` doesn't use TempExpr. Picked a different use case as example. - tests/scripts/task_cpp_unittest.sh - Updated "make crttest" to run only if "USE_MICRO" is enabled. While USE_MICRO is always enabled in the CI builds, task_cpp_unittest.sh is also recommended for use in docs/install/from_source.rst, which does not mandate USE_MICRO. - docs/install/from_source.rst - Added -DMAKE_SHARED_LIBS=ON to the google test cmake config. By default, only static libs are generated for gtest, while TVM's build preferentially selects the shared libs. - tutorials/get_started/auto_tuning_with_python.py - Changed norm_img_data to avoid loop, improve readability - tutorials/get_started/relay_quick_start.py - Previous version used different input data passed to the initial and deployed module, then asserts that the results should be the same. Modified so that the same input data are passed in both cases.
f106e30
to
0ea2dd9
Compare
LGTM |
Thanks @Lunderberg @jroesch @hogepodge |
apache#7840) - Makefile - Target "crttest" ignored OUTPUTDIR variable - .gitignore - Added ignores for download test data/models. - docs/README.txt - Missing quotes on sphinx dep, needs pinned autodocsumm version - docs/contribute/pull_request.rst - Use "ci_lint" docker image - Updated C++ test instructions to refer to the from_source installation for gtest. - Updated python test instructions with synr package dependency - docs/langref/relay_expr.rst - Updated reference for example usage of TempExpr. `src/relay/pass/alter_op_layout.cc` no longer exists, and `src/relay/transforms/alter_op_layout.cc` doesn't use TempExpr. Picked a different use case as example. - tests/scripts/task_cpp_unittest.sh - Updated "make crttest" to run only if "USE_MICRO" is enabled. While USE_MICRO is always enabled in the CI builds, task_cpp_unittest.sh is also recommended for use in docs/install/from_source.rst, which does not mandate USE_MICRO. - docs/install/from_source.rst - Added -DMAKE_SHARED_LIBS=ON to the google test cmake config. By default, only static libs are generated for gtest, while TVM's build preferentially selects the shared libs. - tutorials/get_started/auto_tuning_with_python.py - Changed norm_img_data to avoid loop, improve readability - tutorials/get_started/relay_quick_start.py - Previous version used different input data passed to the initial and deployed module, then asserts that the results should be the same. Modified so that the same input data are passed in both cases. Co-authored-by: Eric Lunderberg <[email protected]>
apache#7840) - Makefile - Target "crttest" ignored OUTPUTDIR variable - .gitignore - Added ignores for download test data/models. - docs/README.txt - Missing quotes on sphinx dep, needs pinned autodocsumm version - docs/contribute/pull_request.rst - Use "ci_lint" docker image - Updated C++ test instructions to refer to the from_source installation for gtest. - Updated python test instructions with synr package dependency - docs/langref/relay_expr.rst - Updated reference for example usage of TempExpr. `src/relay/pass/alter_op_layout.cc` no longer exists, and `src/relay/transforms/alter_op_layout.cc` doesn't use TempExpr. Picked a different use case as example. - tests/scripts/task_cpp_unittest.sh - Updated "make crttest" to run only if "USE_MICRO" is enabled. While USE_MICRO is always enabled in the CI builds, task_cpp_unittest.sh is also recommended for use in docs/install/from_source.rst, which does not mandate USE_MICRO. - docs/install/from_source.rst - Added -DMAKE_SHARED_LIBS=ON to the google test cmake config. By default, only static libs are generated for gtest, while TVM's build preferentially selects the shared libs. - tutorials/get_started/auto_tuning_with_python.py - Changed norm_img_data to avoid loop, improve readability - tutorials/get_started/relay_quick_start.py - Previous version used different input data passed to the initial and deployed module, then asserts that the results should be the same. Modified so that the same input data are passed in both cases. Co-authored-by: Eric Lunderberg <[email protected]>
apache#7840) - Makefile - Target "crttest" ignored OUTPUTDIR variable - .gitignore - Added ignores for download test data/models. - docs/README.txt - Missing quotes on sphinx dep, needs pinned autodocsumm version - docs/contribute/pull_request.rst - Use "ci_lint" docker image - Updated C++ test instructions to refer to the from_source installation for gtest. - Updated python test instructions with synr package dependency - docs/langref/relay_expr.rst - Updated reference for example usage of TempExpr. `src/relay/pass/alter_op_layout.cc` no longer exists, and `src/relay/transforms/alter_op_layout.cc` doesn't use TempExpr. Picked a different use case as example. - tests/scripts/task_cpp_unittest.sh - Updated "make crttest" to run only if "USE_MICRO" is enabled. While USE_MICRO is always enabled in the CI builds, task_cpp_unittest.sh is also recommended for use in docs/install/from_source.rst, which does not mandate USE_MICRO. - docs/install/from_source.rst - Added -DMAKE_SHARED_LIBS=ON to the google test cmake config. By default, only static libs are generated for gtest, while TVM's build preferentially selects the shared libs. - tutorials/get_started/auto_tuning_with_python.py - Changed norm_img_data to avoid loop, improve readability - tutorials/get_started/relay_quick_start.py - Previous version used different input data passed to the initial and deployed module, then asserts that the results should be the same. Modified so that the same input data are passed in both cases. Co-authored-by: Eric Lunderberg <[email protected]>
apache#7840) - Makefile - Target "crttest" ignored OUTPUTDIR variable - .gitignore - Added ignores for download test data/models. - docs/README.txt - Missing quotes on sphinx dep, needs pinned autodocsumm version - docs/contribute/pull_request.rst - Use "ci_lint" docker image - Updated C++ test instructions to refer to the from_source installation for gtest. - Updated python test instructions with synr package dependency - docs/langref/relay_expr.rst - Updated reference for example usage of TempExpr. `src/relay/pass/alter_op_layout.cc` no longer exists, and `src/relay/transforms/alter_op_layout.cc` doesn't use TempExpr. Picked a different use case as example. - tests/scripts/task_cpp_unittest.sh - Updated "make crttest" to run only if "USE_MICRO" is enabled. While USE_MICRO is always enabled in the CI builds, task_cpp_unittest.sh is also recommended for use in docs/install/from_source.rst, which does not mandate USE_MICRO. - docs/install/from_source.rst - Added -DMAKE_SHARED_LIBS=ON to the google test cmake config. By default, only static libs are generated for gtest, while TVM's build preferentially selects the shared libs. - tutorials/get_started/auto_tuning_with_python.py - Changed norm_img_data to avoid loop, improve readability - tutorials/get_started/relay_quick_start.py - Previous version used different input data passed to the initial and deployed module, then asserts that the results should be the same. Modified so that the same input data are passed in both cases. Co-authored-by: Eric Lunderberg <[email protected]>
Makefile
.gitignore
docs/README.txt
docs/contribute/pull_request.rst
docs/langref/relay_expr.rst
src/relay/pass/alter_op_layout.cc
no longer exists, and
src/relay/transforms/alter_op_layout.cc
doesn't use TempExpr.Picked a different use case as example.
tests/scripts/task_cpp_unittest.sh
in the CI builds, task_cpp_unittest.sh is also recommended for use in
docs/install/from_source.rst, which does not mandate USE_MICRO.
docs/install/from_source.rst
generated for gtest, while TVM's build preferentially selects the shared libs.
tutorials/get_started/auto_tuning_with_python.py
tutorials/get_started/relay_quick_start.py
asserts that the results should be the same. Modified so that the same input data are passed in
both cases.
Thanks for contributing to TVM! Please refer to guideline https://tvm.apache.org/docs/contribute/ for useful information and tips. After the pull request is submitted, please request code reviews from Reviewers by @ them in the pull request thread.