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

update relay python api doc #2766

Merged
merged 2 commits into from
Mar 11, 2019
Merged

update relay python api doc #2766

merged 2 commits into from
Mar 11, 2019

Conversation

yongwww
Copy link
Member

@yongwww yongwww commented Mar 10, 2019

Fix for issue #2644

@yongwww
Copy link
Member Author

yongwww commented Mar 10, 2019

@tqchen @zhiics @wweic @yzhliu pls help take a look. Not sure if the code snippet below works (if not, pls suggest... sorry I am not familiar with Sphinx), trying to link to relay op list doc, it makes no sense to maintain two copies

  .. toctree::
  :maxdepth: 2

  langref/relay_op

@@ -1,7 +0,0 @@
tvm.relay.nn
Copy link
Member

Choose a reason for hiding this comment

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

We do need t make keep relay/nn.rst and relay/vision.rst

@tqchen
Copy link
Member

tqchen commented Mar 10, 2019

For now, let us not cross ref, let us keep the relay.nn and relay.vision namespace because they are what are used directly by the user. Let us not refer to relay_op for now, since that will result in a too deep nesting.

You can build the doc locally to verify

We can bring other changes.

@wweic
Copy link
Contributor

wweic commented Mar 10, 2019

@yongwww after you make the change, try following command to build docs locally(from Jenkins script). Then verify the docs in browser.

mkdir -p build
cd build
cp ../cmake/config.cmake .
echo 'set(USE_SORT' 'ON)' >> config.cmake
echo 'set(USE_GRAPH_RUNTIME_DEBUG' 'ON)' >> config.cmake
echo 'set(USE_LLVM' 'llvm-config-4.0)' >> config.cmake
echo 'set(USE_NNPACK' 'ON)' >> config.cmake
echo 'set(NNPACK_PATH' '/NNPACK/build/)' >> config.cmake
echo 'set(USE_ANTLR' 'ON)' >> config.cmake
echo 'set(CMAKE_CXX_COMPILER' 'g++)' >> config.cmake
echo 'set(CMAKE_CXX_FLAGS' '-Werror)' >> config.cmake
cd ..
docker/bash.sh tvmai/ci-cpu ./tests/scripts/task_build.sh build -j2
docker/bash.sh tvmai/ci-cpu ./tests/scripts/task_python_docs.sh

@tqchen tqchen merged commit 801068f into apache:master Mar 11, 2019
wweic pushed a commit to neo-ai/tvm that referenced this pull request Mar 12, 2019
wweic pushed a commit to neo-ai/tvm that referenced this pull request Mar 12, 2019
@yongwww yongwww deleted the relay_doc branch December 24, 2019 03:47
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.

3 participants