This repository has been archived by the owner on Nov 17, 2023. It is now read-only.
Update docs/README.md #20012
Open
Update docs/README.md #20012
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hey @leezu , Thanks for submitting the PR
CI supported jobs: [website, unix-gpu, windows-cpu, centos-gpu, sanity, edge, clang, windows-gpu, unix-cpu, centos-cpu, miscellaneous] Note: |
lanking520
added
pr-awaiting-testing
|
@mxnet-bot run ci [unix-cpu] |
|
Jenkins CI successfully triggered : [unix-cpu] |
|
@mxnet-bot run ci [unix-cpu] |
|
Jenkins CI successfully triggered : [unix-cpu] |
lanking520
added
pr-awaiting-testing
szha
reviewed
Apr 13, 2021
lanking520
added
pr-awaiting-testing
szha
approved these changes
Apr 13, 2021
docs/README.md
Outdated
| ### Ubuntu Setup | ||
|
|
||
| As this is maintained for CI, Ubuntu is recommended. Refer to [ubuntu_doc.sh](https://github.com/apache/incubator-mxnet/tree/master/ci/docker/install/ubuntu_docs.sh) for the latest install script. | ||
| If you only need to make changes to tutorials or other pages that are not generated from one of the API source code folders, then you can install a pre-build MXNet binary. But if you want edit the API source and have the reference API docs update, you also need to build MXNet from source. Refer to the [build from source instructions for this requirement](https://mxnet.apache.org/versions/master/get_started/build_from_source.html). |
There was a problem hiding this comment.
one more nitpick: there could be a link for "install a pre-build(t) MXNet binary" too
There was a problem hiding this comment.
Would https://mxnet.apache.org/versions/master/get_started or pypi be more helpful?
lanking520
added
pr-awaiting-merge
lanking520
added
pr-awaiting-testing
mseth10
added
pr-awaiting-testing
mseth10
added
pr-awaiting-testing
mseth10
added
pr-awaiting-testing
mseth10
added
pr-awaiting-testing
mseth10
added
pr-awaiting-testing
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update docs/README.md file following c789d02. That commit only updated docs/python_docs/README.md and missed the docs/README.md
Both files contained duplicate content. Resolve by linking in docs/README.md to docs/python_docs/README.md when Python docs are discussed.
Thanks @aaronmarkham for pointing out the problem