Installation instructions for MacOS and Cloud #6012
Conversation
There was a problem hiding this comment.
generally i feel is that several sections do not contain much information. such as for the docker:
- download docker
- docker pull
- docker run
we'd better creatively place these contents nearby the get_started home page, rather than making all of them on a separate page
docs/get_started/install.md
Outdated
|
|
||
| The following installation instructions have been tested on OSX Sierra and El Capitan. | ||
|
|
||
|
|
There was a problem hiding this comment.
Fixed.
| ```bash | ||
| # Install Homebrew | ||
| $ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" | ||
| $ export PATH=/usr/local/bin:/usr/local/sbin:$PATH |
There was a problem hiding this comment.
is it necessary? homebrew home page doesn't contain it
There was a problem hiding this comment.
Yes. This is a transient issue with PATH + homebrew installed packages. Setting these paths at the start of PATH, will help to make it more deterministic and fool proof.
|
|
||
| **Step 5** Validate the installation by running simple *MXNet* code described [here](#validate-mxnet-installation). | ||
|
|
||
| **Note** You can read more about virtualenv [here](https://virtualenv.pypa.io/en/stable/userguide/). |
There was a problem hiding this comment.
should we use virtualenv. i don't think it is necessary given our light dependencies. we can just let user run pip install mxnet. that's, remove the virtualenv section to keep doc short
There was a problem hiding this comment.
I agree for now, we have only mxnet, but, I see other dependencies like jupyter, graphviz etc.. will be required. My idea is to evolve this to have a requirement file, which user can use in virtualenv to get complex mxnet environment setup in one command.
Also, for user, we are showing options in buttons, so should not complicate with length.
|
|
||
| **Step 1** Install Docker on your machine by following the [docker installation instructions](https://docs.docker.com/docker-for-mac/install/#install-and-run-docker-for-mac). | ||
|
|
||
| *Note* - You can install Community Edition (CE) to get started with *MXNet*. |
There was a problem hiding this comment.
There are 2 options in docker installation page - Community Edition & Enterprise Edition, I wanted to state - Community Edition is good to start with MXNet. Maybe I should reword it?
docs/get_started/install.md
Outdated
|
|
||
| ```bash | ||
| # Make the script executable | ||
| $ sudo chmod 744 install-mxnet-osx-python.sh |
There was a problem hiding this comment.
just chmod +x xxx.sh no sudo is required. suggest to make these two as a single line to make users easier to copy
chmod +x xx.sh && ./xx.sh
There was a problem hiding this comment.
Removed sudo.
I agree it reduces number of times users need to copy paste. But, I felt this is more clear for user on what is being done.
docs/get_started/install.md
Outdated
|
|
||
| </div> | ||
|
|
||
| </div> |
There was a problem hiding this comment.
change to </div> <!-- end of pip -->
There was a problem hiding this comment.
Done.
| </div> | ||
| </div> | ||
|
|
||
| <!-- END - Mac OS Python CPU Installation Instructions --> |
There was a problem hiding this comment.
not necessary if resolved the above comment
|
|
||
| <div class="macos"> | ||
| <div class="python"> | ||
| <div class="gpu"> |
There was a problem hiding this comment.
change to <div class="macos python gpu">. split it later if more staffs are added
There was a problem hiding this comment.
Right. Wanted to keep it more uniform across the page, so it is easier for new devs to modify and maintain. Also, above works like "macos && python && gpu", But, if I keep it all together it works like "macos || python || gpu", so even if some one selects linux/python or linux/gpu, this sections shows up.
| $ export PATH=/usr/local/bin:/usr/local/sbin:$PATH | ||
|
|
||
| # Install python development tools - python2.7, pip, python-setuptools | ||
| $ brew install python |
There was a problem hiding this comment.
Does this one command actually install all of python, pip, and setuptools?
|
|
||
| Docker images with *MXNet* are available at [Docker Hub](https://hub.docker.com/r/mxnet/). | ||
|
|
||
| **Step 1** Install Docker on your machine by following the [docker installation instructions](https://docs.docker.com/docker-for-mac/install/#install-and-run-docker-for-mac). |
There was a problem hiding this comment.
What do you think about installing docker with homebrew? That way we have one more requirement that we can give concrete commands for.
There was a problem hiding this comment.
Makes sense but I think with homebrew we get DockerToolbox. I felt, Docker installation page for mac is pretty simple - download and install dmg file. hence redirected users there.
|
Looks good to me. I like the way it's currently organized with docker/virtualenv/build from source. Though possibly the virtualenv & pip instructions are almost identical and I wonder if both are necessary. |
|
Thanks Mu and Ly. Fixed Comments by Mu and Ly. @mli - I agree Re-arranging helps to reduce the content size, but, for automated testing and maintaining this page would be harder. |
|
@mli if this looks good can you merge it? I am almost done with the test script for this and hope to add a Jenkins job by end of today or tomorrow. |
|
@zackchase @madjam - Can you please review this PR? |
|
This is too long. Its as simple as a We should keep the original one sentence instruction. You can put this in a trouble shooting page if necessary. |
|
I'll merge this first since I don't see it being linked to from any page. but we need to clean it up later. |
|
@piiswrong - I agree source is too long and I had same thoughts in my PR description. However, when it renders, I felt it is very easy and complete for readers to install required pre-requistes, mxnet and at the end test with a small code snippet. Can you please go through the instructions here - http://mxnet.io/get_started/install.html and let me know if you think it is complicated for readers to install and get started. I can take it up for simplification. We can have in home page just one line - pip install mxnet and one line docker image command. |
* updated docstring for set_lr_mult and set_wd_mult * updated docstring per review * Fixed imdecode crash bug when flag=0 (#6134) * Fix (#6131) * Docs for MXRecordIO, MXIndexedRecordIO modified (#6013) * docs for MXIndexedRecordIO modified * changes after review * recordIO doc modified * changes after review * lint error * minor change * minor change after review * empty commit to retrigger build * changes after review * Update documentation for mx.callback.Speedometer. (#6058) * Update documentation for mx.callback.Speedometer. * Minor doc changes. * Use module instead of model in example code. * update doc for Load (#6092) * Installation instructions for MacOS and Cloud (#6012) * Fix NDArray bool checking (#6130) * fix shape order bug (#6136) * TOC click unfold (#6133) * [doc] new sphnix plugin (#6105) * update doc * rm * update * update ndarray * update mds * update * update * update * update * update * update * update image.md and others * update * [doc] use debug mode to build (#6151) * move ctc loss to contrib (#6154) * Fix for invalid numpy float indexing (#6144) * Fix python3 compatibilities (#6143) * [doc] small changes to tutorials (#6164) * [doc] Fix left toc link (#6162) * [example]ADD practical functions and options for speech_recognition example (#6141) * ADD practical functions and options for speech_recognition example * add missing stt_bi_graphemes_util.py and deepspeech.cfg template * Added reflection padding (#6123) * Added reflection padding * Lint fix * Added 5d reflection padding * Added failure in forward/backward for input dimensions other than 4 of 5 * Improved sanity check readability * Fixing LICENSE file and adding NOTICE (#6172) * Creating NOTICE. When code moves to Apache, it will need adjusting to the Apache format. * Replacing source header with full license text * doc improvement - softmax, metrics, and initializer (#5945) * doc improvement, softmaxoutput, initializer-constant, minor fixes * doc improvement, metrics * fix softmax doc, fix metric lint * softmax more fixes * add doc change in initializer.py. some minor fix in softmax_cross_entropy * doc change in initializer.py * fix grammer * fix * fix * fix * minor fix * fix * minor fix * DataBatch and NDArrayIter doc modified (#6091) * DataBatch and NDArrayIter doc modified * fixes after review * fixes after review * wording changed * some more fixes * improvement * desc fix * Datadesc info added * minor addition * fix * fix * fix after review * [Scala] Change version to 0.9.5-SNAPSHOT (#6173) * [scala] change version to 0.9.5-SNAPSHOT * API doc improvement Dropout and SoftmaxActivation (#6088) * doc improve for dropout oper * doc improve for SoftmaxActivation oper * fix * fix * Update documentation for mx.callback.do_checkpoint (#6059) * Update documentation for mx.callback.do_checkpoint * Use module instead of model for example code. * Update documentation for plot_graph. (#6098) * Update documentation for plot_graph. * Minor doc fix. * Restruct get started (#6167) * Change get started page * Small fix * Improve * Update documentation of Initializer.dumps() (#6128) * Doc Improvement - RMSProp and RMSPropAlex (#6107) * rmsprop * rmsprop alex * add link in optimizer.py * fix * fix * missed fix.. * Docforcs,fft,ifft (#6145) * fft.cc * add all * changed the description of set_lr_mult and set_wd_mult * Explicitly specify quiet in R install_version (#6171)
* updated docstring for set_lr_mult and set_wd_mult * updated docstring per review * Fixed imdecode crash bug when flag=0 (apache#6134) * Fix (apache#6131) * Docs for MXRecordIO, MXIndexedRecordIO modified (apache#6013) * docs for MXIndexedRecordIO modified * changes after review * recordIO doc modified * changes after review * lint error * minor change * minor change after review * empty commit to retrigger build * changes after review * Update documentation for mx.callback.Speedometer. (apache#6058) * Update documentation for mx.callback.Speedometer. * Minor doc changes. * Use module instead of model in example code. * update doc for Load (apache#6092) * Installation instructions for MacOS and Cloud (apache#6012) * Fix NDArray bool checking (apache#6130) * fix shape order bug (apache#6136) * TOC click unfold (apache#6133) * [doc] new sphnix plugin (apache#6105) * update doc * rm * update * update ndarray * update mds * update * update * update * update * update * update * update image.md and others * update * [doc] use debug mode to build (apache#6151) * move ctc loss to contrib (apache#6154) * Fix for invalid numpy float indexing (apache#6144) * Fix python3 compatibilities (apache#6143) * [doc] small changes to tutorials (apache#6164) * [doc] Fix left toc link (apache#6162) * [example]ADD practical functions and options for speech_recognition example (apache#6141) * ADD practical functions and options for speech_recognition example * add missing stt_bi_graphemes_util.py and deepspeech.cfg template * Added reflection padding (apache#6123) * Added reflection padding * Lint fix * Added 5d reflection padding * Added failure in forward/backward for input dimensions other than 4 of 5 * Improved sanity check readability * Fixing LICENSE file and adding NOTICE (apache#6172) * Creating NOTICE. When code moves to Apache, it will need adjusting to the Apache format. * Replacing source header with full license text * doc improvement - softmax, metrics, and initializer (apache#5945) * doc improvement, softmaxoutput, initializer-constant, minor fixes * doc improvement, metrics * fix softmax doc, fix metric lint * softmax more fixes * add doc change in initializer.py. some minor fix in softmax_cross_entropy * doc change in initializer.py * fix grammer * fix * fix * fix * minor fix * fix * minor fix * DataBatch and NDArrayIter doc modified (apache#6091) * DataBatch and NDArrayIter doc modified * fixes after review * fixes after review * wording changed * some more fixes * improvement * desc fix * Datadesc info added * minor addition * fix * fix * fix after review * [Scala] Change version to 0.9.5-SNAPSHOT (apache#6173) * [scala] change version to 0.9.5-SNAPSHOT * API doc improvement Dropout and SoftmaxActivation (apache#6088) * doc improve for dropout oper * doc improve for SoftmaxActivation oper * fix * fix * Update documentation for mx.callback.do_checkpoint (apache#6059) * Update documentation for mx.callback.do_checkpoint * Use module instead of model for example code. * Update documentation for plot_graph. (apache#6098) * Update documentation for plot_graph. * Minor doc fix. * Restruct get started (apache#6167) * Change get started page * Small fix * Improve * Update documentation of Initializer.dumps() (apache#6128) * Doc Improvement - RMSProp and RMSPropAlex (apache#6107) * rmsprop * rmsprop alex * add link in optimizer.py * fix * fix * missed fix.. * Docforcs,fft,ifft (apache#6145) * fft.cc * add all * changed the description of set_lr_mult and set_wd_mult * Explicitly specify quiet in R install_version (apache#6171)
* updated docstring for set_lr_mult and set_wd_mult * updated docstring per review * Fixed imdecode crash bug when flag=0 (apache#6134) * Fix (apache#6131) * Docs for MXRecordIO, MXIndexedRecordIO modified (apache#6013) * docs for MXIndexedRecordIO modified * changes after review * recordIO doc modified * changes after review * lint error * minor change * minor change after review * empty commit to retrigger build * changes after review * Update documentation for mx.callback.Speedometer. (apache#6058) * Update documentation for mx.callback.Speedometer. * Minor doc changes. * Use module instead of model in example code. * update doc for Load (apache#6092) * Installation instructions for MacOS and Cloud (apache#6012) * Fix NDArray bool checking (apache#6130) * fix shape order bug (apache#6136) * TOC click unfold (apache#6133) * [doc] new sphnix plugin (apache#6105) * update doc * rm * update * update ndarray * update mds * update * update * update * update * update * update * update image.md and others * update * [doc] use debug mode to build (apache#6151) * move ctc loss to contrib (apache#6154) * Fix for invalid numpy float indexing (apache#6144) * Fix python3 compatibilities (apache#6143) * [doc] small changes to tutorials (apache#6164) * [doc] Fix left toc link (apache#6162) * [example]ADD practical functions and options for speech_recognition example (apache#6141) * ADD practical functions and options for speech_recognition example * add missing stt_bi_graphemes_util.py and deepspeech.cfg template * Added reflection padding (apache#6123) * Added reflection padding * Lint fix * Added 5d reflection padding * Added failure in forward/backward for input dimensions other than 4 of 5 * Improved sanity check readability * Fixing LICENSE file and adding NOTICE (apache#6172) * Creating NOTICE. When code moves to Apache, it will need adjusting to the Apache format. * Replacing source header with full license text * doc improvement - softmax, metrics, and initializer (apache#5945) * doc improvement, softmaxoutput, initializer-constant, minor fixes * doc improvement, metrics * fix softmax doc, fix metric lint * softmax more fixes * add doc change in initializer.py. some minor fix in softmax_cross_entropy * doc change in initializer.py * fix grammer * fix * fix * fix * minor fix * fix * minor fix * DataBatch and NDArrayIter doc modified (apache#6091) * DataBatch and NDArrayIter doc modified * fixes after review * fixes after review * wording changed * some more fixes * improvement * desc fix * Datadesc info added * minor addition * fix * fix * fix after review * [Scala] Change version to 0.9.5-SNAPSHOT (apache#6173) * [scala] change version to 0.9.5-SNAPSHOT * API doc improvement Dropout and SoftmaxActivation (apache#6088) * doc improve for dropout oper * doc improve for SoftmaxActivation oper * fix * fix * Update documentation for mx.callback.do_checkpoint (apache#6059) * Update documentation for mx.callback.do_checkpoint * Use module instead of model for example code. * Update documentation for plot_graph. (apache#6098) * Update documentation for plot_graph. * Minor doc fix. * Restruct get started (apache#6167) * Change get started page * Small fix * Improve * Update documentation of Initializer.dumps() (apache#6128) * Doc Improvement - RMSProp and RMSPropAlex (apache#6107) * rmsprop * rmsprop alex * add link in optimizer.py * fix * fix * missed fix.. * Docforcs,fft,ifft (apache#6145) * fft.cc * add all * changed the description of set_lr_mult and set_wd_mult * Explicitly specify quiet in R install_version (apache#6171)
Note: I am not fully happy with the size/structure of this file getting bigger and it becomes more complex to manage when we add other Programming language installation guide. I will create an issue and assign it to myself to simplify this post v0.10 doc release.
@madjam @zackchase @lxn2 - Can you please review this changes?