You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mxnet.apache.org by GitBox <gi...@apache.org> on 2020/04/24 05:58:31 UTC
[GitHub] [incubator-mxnet] waytrue17 opened a new pull request #18161: Modify static site web pages
waytrue17 opened a new pull request #18161:
URL: https://github.com/apache/incubator-mxnet/pull/18161
## Description ##
Some modifications and improvements to the installation and setup guides based on my new-user experience.
## Checklist ##
### Essentials ###
Please feel free to remove inapplicable items for your PR.
- [ ] Changes are complete (i.e. I finished coding on this PR)
- [ ] To the best of my knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change
### Changes ###
- Fix broken links in get_started, ubuntu_setup and osx_setup pages.
- Add compiler version requirement in build from source pages.
- Update links for Clojure guide and Julia guide.
- Modify some contents in the build and setup pages.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] waytrue17 commented on a change in pull request #18161: Modify static site web pages
Posted by GitBox <gi...@apache.org>.
waytrue17 commented on a change in pull request #18161:
URL: https://github.com/apache/incubator-mxnet/pull/18161#discussion_r414915404
##########
File path: docs/static_site/src/_includes/get_started/linux/clojure/gpu.md
##########
@@ -1,7 +1,4 @@
-You can use the Maven packages defined in the following dependency to include MXNet in your Clojure
-project. To maximize leverage, the Clojure package has been built on the existing Scala package. Please
-refer to the [MXNet-Scala setup guide]({{'/get_started/scala_setup'|relative_url}}) for a detailed set of instructions
-to help you with the setup process that is required to use the Clojure dependency.
+Please refer to the [MXNet-Clojure setup guide](https://github.com/apache/incubator-mxnet/tree/master/contrib/clojure-package) for a detailed set of instructions to help you with the setup process that is required to use the Clojure dependency.
Review comment:
The only difference is the dependency tag, one for cpu and the other for gpu. It makes them not easy to merge.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] rondogency commented on pull request #18161: Modify static site web pages
Posted by GitBox <gi...@apache.org>.
rondogency commented on pull request #18161:
URL: https://github.com/apache/incubator-mxnet/pull/18161#issuecomment-619269255
I have a few suggestion and I will appreciate if you can fix it in this PR
1. looks like the "math library selection" list on the website is broken, can you fix it?
2. the "install gpu software" part, can you add one line like "After installing, run nvidia-smi to verify cuda is available on your machine"
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] rondogency commented on a change in pull request #18161: Modify static site web pages
Posted by GitBox <gi...@apache.org>.
rondogency commented on a change in pull request #18161:
URL: https://github.com/apache/incubator-mxnet/pull/18161#discussion_r414901369
##########
File path: docs/static_site/src/pages/get_started/build_from_source.md
##########
@@ -36,6 +35,7 @@ Building from source follows this general two-step flow of building the shared l
1. Build the MXNet shared library, `libmxnet.so`.
* [Clone the repository](#clone-the-mxnet-project)
* [Prerequisites](#prerequisites)
+ * [Compiler requirement](#compiler-requirement)
Review comment:
looks like the math library selection part is broken, can you take a look and fix it in this PR?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] apeforest commented on a change in pull request #18161: Modify static site web pages
Posted by GitBox <gi...@apache.org>.
apeforest commented on a change in pull request #18161:
URL: https://github.com/apache/incubator-mxnet/pull/18161#discussion_r414871794
##########
File path: docs/static_site/src/_includes/get_started/linux/clojure/gpu.md
##########
@@ -1,7 +1,4 @@
-You can use the Maven packages defined in the following dependency to include MXNet in your Clojure
-project. To maximize leverage, the Clojure package has been built on the existing Scala package. Please
-refer to the [MXNet-Scala setup guide]({{'/get_started/scala_setup'|relative_url}}) for a detailed set of instructions
-to help you with the setup process that is required to use the Clojure dependency.
+Please refer to the [MXNet-Clojure setup guide](https://github.com/apache/incubator-mxnet/tree/master/contrib/clojure-package) for a detailed set of instructions to help you with the setup process that is required to use the Clojure dependency.
Review comment:
Just curious is there any difference between this gpu.md and cpu.md? If not, could we just merge them into one doc?
##########
File path: docs/static_site/src/_includes/get_started/linux/scala/gpu.md
##########
@@ -1,6 +1,6 @@
You can use the Maven packages defined in the following dependency to include MXNet in
your Scala
-project. Please refer to the <a href="scala_setup.html">MXNet-Scala setup guide</a> for
+project. Please refer to the <a href="/get_started/scala_setup.html">MXNet-Scala setup guide</a> for
Review comment:
Why is this different from the cpu.md?
##########
File path: docs/static_site/src/_includes/get_started/macos/perl/perl.md
##########
@@ -1 +1 @@
-Refer to the [Perl section of installation guide](/get_started/osx_setup.html#install-the-mxnet-package-for-perl).
\ No newline at end of file
+Refer to the [Perl section of the MXNet macOS installation guide](/get_started/osx_setup.html#install-the-mxnet-package-for-perl).
Review comment:
MacOS?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] waytrue17 commented on a change in pull request #18161: Modify static site web pages
Posted by GitBox <gi...@apache.org>.
waytrue17 commented on a change in pull request #18161:
URL: https://github.com/apache/incubator-mxnet/pull/18161#discussion_r414915991
##########
File path: docs/static_site/src/_includes/get_started/linux/scala/gpu.md
##########
@@ -1,6 +1,6 @@
You can use the Maven packages defined in the following dependency to include MXNet in
your Scala
-project. Please refer to the <a href="scala_setup.html">MXNet-Scala setup guide</a> for
+project. Please refer to the <a href="/get_started/scala_setup.html">MXNet-Scala setup guide</a> for
Review comment:
The current Scala link is broken. I modify the path to correct it.
The only difference between cpu.md and gpu.md is the dependency tag, which makes them not easy to merge.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] waytrue17 commented on a change in pull request #18161: Modify static site web pages
Posted by GitBox <gi...@apache.org>.
waytrue17 commented on a change in pull request #18161:
URL: https://github.com/apache/incubator-mxnet/pull/18161#discussion_r414916489
##########
File path: docs/static_site/src/_includes/get_started/macos/perl/perl.md
##########
@@ -1 +1 @@
-Refer to the [Perl section of installation guide](/get_started/osx_setup.html#install-the-mxnet-package-for-perl).
\ No newline at end of file
+Refer to the [Perl section of the MXNet macOS installation guide](/get_started/osx_setup.html#install-the-mxnet-package-for-perl).
Review comment:
I was confused which to use too. In wiki it's macOS.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] connorgoggins commented on a change in pull request #18161: Modify static site web pages
Posted by GitBox <gi...@apache.org>.
connorgoggins commented on a change in pull request #18161:
URL: https://github.com/apache/incubator-mxnet/pull/18161#discussion_r414927954
##########
File path: docs/static_site/src/_includes/get_started/linux/julia/build-from-source.md
##########
@@ -1,2 +1,2 @@
-Refer to the [Julia section of the MXNet Ubuntu installation guide](/get_started/ubuntu_setup#install-the-mxnet-package-for-julia).
+Refer to the [Julia section of the MXNet Ubuntu installation guide](/get_started/ubuntu_setup.html#install-the-mxnet-package-for-julia).
Review comment:
These routes are actually valid - no need to add `.html`. To get them to work as they do in production, enable the `modrewrite` extension in your `httpd` configuration and run your webserver with `httpd`. [Here](https://www.digitalocean.com/community/tutorials/how-to-rewrite-urls-with-mod_rewrite-for-apache-on-ubuntu-16-04) is a good guide for doing this on Ubuntu.
##########
File path: docs/static_site/src/_includes/get_started/linux/python/cpu/docker.md
##########
@@ -40,4 +40,4 @@ REPOSITORY TAG IMAGE ID CREATED SIZE
mxnet/python 1.3.0_cpu_mkl deaf9bf61d29 4 days ago 678 MB
{% endhighlight %}
-**Step 4** <a href="get_started/validate_mxnet">Validate the installation</a>.
\ No newline at end of file
+**Step 4** <a href="/get_started/validate_mxnet.html">Validate the installation</a>.
Review comment:
Routing config also applies here.
##########
File path: docs/static_site/src/_includes/get_started/linux/python/gpu/build-from-source.md
##########
@@ -1 +1 @@
-To build from source, refer to the [MXNet Ubuntu installation guide]({{'/get_started/ubuntu_setup' | relative_url}}).
+To build from source, refer to the [MXNet Ubuntu installation guide](/get_started/ubuntu_setup.html).
Review comment:
Same here.
##########
File path: docs/static_site/src/_includes/get_started/windows/perl/perl.md
##########
@@ -1 +1 @@
-Refer to the [Perl section of the MXNet Windows installation guide](/get_started/windows_setup.html#install-the-mxnet-package-for-perl).
\ No newline at end of file
+MXNet-Perl for Windows is not yet available.
Review comment:
Should be `MXNet Perl API for Windows`.
##########
File path: docs/static_site/src/_includes/get_started/macos/clojure/cpu.md
##########
@@ -1,8 +1,4 @@
-
-You can use the Maven packages defined in the following dependency to include MXNet in
-your Clojure project. To maximize leverage, the Clojure package has been built on the existing Scala
-package. Please refer to the [MXNet-Scala setup guide](scala_setup.html) for a detailed set
-of instructions to help you with the setup process that is required to use the Clojure dependency.
+Please refer to the [MXNet-Clojure setup guide](https://github.com/apache/incubator-mxnet/tree/master/contrib/clojure-package) for a detailed set of instructions to help you with the setup process that is required to use the Clojure dependency.
Review comment:
Nice addition!
##########
File path: docs/static_site/src/_includes/get_started/windows/python/cpu/build-from-source.md
##########
@@ -1 +1 @@
-Refer to the [MXNet Windows installation guide](/get_started/windows_setup.html)
\ No newline at end of file
+To build from source, refer to the [MXNet Windows installation guide](/get_started/windows_setup.html).
Review comment:
Great addition :)
##########
File path: docs/static_site/src/_includes/get_started/linux/scala/cpu.md
##########
@@ -1,5 +1,5 @@
You can use the Maven packages defined in the following dependency to include MXNet in your Scala
-project. Please refer to the [MXNet-Scala setup guide]({{'/get_started/scala_setup'|relative_url}}) for
+project. Please refer to the [MXNet-Scala setup guide](/get_started/scala_setup.html) for
Review comment:
Same here.
##########
File path: docs/static_site/src/_includes/get_started/macos/python/cpu/docker.md
##########
@@ -32,4 +32,4 @@ REPOSITORY TAG IMAGE ID CREATED SIZE
mxnet/python 1.3.0_cpu_mkl deaf9bf61d29 4 days ago 678 MB
{% endhighlight %}
-**Step 4** <a href="get_started/validate_mxnet">Validate the installation</a>.
\ No newline at end of file
+**Step 4** <a href="/get_started/validate_mxnet.html">Validate the installation</a>.
Review comment:
Same here.
##########
File path: docs/static_site/src/pages/api/julia/index.md
##########
@@ -35,5 +35,6 @@ computing and the state-of-art deep learning to Julia.
and apply them to tasks such as image classification and data science challenges.
## Installation
-* [Ubuntu installation guide]({{'/get_started/ubuntu_setup' | relative_url}})
-* Mac / Windows guides are not available (contributions welcome!)
+* [Ubuntu installation guide]({{'/get_started/ubuntu_setup.html'|relative_url}})
Review comment:
Same here (+ several more on other files, wherever `.html` is added without changing the base route).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] waytrue17 commented on a change in pull request #18161: Modify static site web pages
Posted by GitBox <gi...@apache.org>.
waytrue17 commented on a change in pull request #18161:
URL: https://github.com/apache/incubator-mxnet/pull/18161#discussion_r414973199
##########
File path: docs/static_site/src/pages/get_started/build_from_source.md
##########
@@ -36,6 +35,7 @@ Building from source follows this general two-step flow of building the shared l
1. Build the MXNet shared library, `libmxnet.so`.
* [Clone the repository](#clone-the-mxnet-project)
* [Prerequisites](#prerequisites)
+ * [Compiler requirement](#compiler-requirement)
Review comment:
It's fixed now. Thanks for pointing it out!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] connorgoggins commented on a change in pull request #18161: Modify static site web pages
Posted by GitBox <gi...@apache.org>.
connorgoggins commented on a change in pull request #18161:
URL: https://github.com/apache/incubator-mxnet/pull/18161#discussion_r415556302
##########
File path: docs/static_site/src/_includes/get_started/linux/julia/build-from-source.md
##########
@@ -1,2 +1,2 @@
-Refer to the [Julia section of the MXNet Ubuntu installation guide](/get_started/ubuntu_setup#install-the-mxnet-package-for-julia).
+Refer to the [Julia section of the MXNet Ubuntu installation guide](/get_started/ubuntu_setup.html#install-the-mxnet-package-for-julia).
Review comment:
Although either way will technically get the users to the right page, not using the extension is cleaner (we don't want to show `.html` in the URL bar when users are navigating the site because it looks messy). Better practice to use routing whenever possible.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] waytrue17 commented on pull request #18161: Modify static site web pages
Posted by GitBox <gi...@apache.org>.
waytrue17 commented on pull request #18161:
URL: https://github.com/apache/incubator-mxnet/pull/18161#issuecomment-619317064
> It appears you updated the 3rdparty/dmlctcore and 3rdparty/mkldnn submodules by mistake
Thanks for pointing it out
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] mxnet-bot commented on pull request #18161: Modify static site web pages
Posted by GitBox <gi...@apache.org>.
mxnet-bot commented on pull request #18161:
URL: https://github.com/apache/incubator-mxnet/pull/18161#issuecomment-618817498
Hey @waytrue17 , Thanks for submitting the PR
All tests are already queued to run once. If tests fail, you can trigger one or more tests again with the following commands:
- To trigger all jobs: @mxnet-bot run ci [all]
- To trigger specific jobs: @mxnet-bot run ci [job1, job2]
***
**CI supported jobs**: [website, windows-gpu, miscellaneous, windows-cpu, unix-cpu, centos-gpu, unix-gpu, centos-cpu, edge, clang, sanity]
***
_Note_:
Only following 3 categories can trigger CI :PR Author, MXNet Committer, Jenkins Admin.
All CI tests must pass before the PR can be merged.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-mxnet] waytrue17 commented on a change in pull request #18161: Modify static site web pages
Posted by GitBox <gi...@apache.org>.
waytrue17 commented on a change in pull request #18161:
URL: https://github.com/apache/incubator-mxnet/pull/18161#discussion_r414969253
##########
File path: docs/static_site/src/_includes/get_started/linux/julia/build-from-source.md
##########
@@ -1,2 +1,2 @@
-Refer to the [Julia section of the MXNet Ubuntu installation guide](/get_started/ubuntu_setup#install-the-mxnet-package-for-julia).
+Refer to the [Julia section of the MXNet Ubuntu installation guide](/get_started/ubuntu_setup.html#install-the-mxnet-package-for-julia).
Review comment:
> These routes are actually valid - no need to add `.html`. To get them to work as they do in production, enable the `modrewrite` extension in your `httpd` configuration and run your webserver with `httpd`. [Here](https://www.digitalocean.com/community/tutorials/how-to-rewrite-urls-with-mod_rewrite-for-apache-on-ubuntu-16-04) is a good guide for doing this on Ubuntu.
Thanks for commenting and sharing the useful guide! I've seen people sometimes use the .html extension and sometimes don't. Is there a particular reason behind it?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org