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

[DOCS][BUILD] Small improvements to documentation/build setup for first-time builds #7840

Merged
merged 1 commit into from Apr 14, 2021

Conversation

Lunderberg
Copy link
Contributor

  • 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.

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.

@jroesch
Copy link
Member

jroesch commented Apr 13, 2021

LGTM

Copy link
Contributor

@hogepodge hogepodge left a 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
Copy link
Contributor

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)

Copy link
Contributor Author

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.
@hogepodge
Copy link
Contributor

LGTM

@tqchen tqchen merged commit ced4cee into apache:main Apr 14, 2021
@tqchen
Copy link
Member

tqchen commented Apr 14, 2021

Thanks @Lunderberg @jroesch @hogepodge

@Lunderberg Lunderberg deleted the first_use_docs_update branch April 14, 2021 16:57
trevor-m pushed a commit to trevor-m/tvm that referenced this pull request May 6, 2021
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 <elunderberg@octoml.ai>
trevor-m pushed a commit to trevor-m/tvm that referenced this pull request May 6, 2021
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 <elunderberg@octoml.ai>
trevor-m pushed a commit to trevor-m/tvm that referenced this pull request May 6, 2021
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 <elunderberg@octoml.ai>
trevor-m pushed a commit to neo-ai/tvm that referenced this pull request May 11, 2021
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 <elunderberg@octoml.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants