Skip to content
This repository was archived by the owner on Nov 17, 2023. It is now read-only.

[doc] new sphnix plugin #6105

Merged
merged 16 commits into from
May 8, 2017
Merged

[doc] new sphnix plugin #6105

merged 16 commits into from
May 8, 2017

Conversation

mli
Copy link
Contributor

@mli mli commented May 4, 2017 •
edited
Loading

Updated our doc build pipeline

  1. moved functions in sphnix_utils into a sphnix plugin located in mxdoc.py

  2. be able to convert markdown files into jupyter notebooks if placed

    <!-- INSERT SOURCE DOWNLOAD BUTTONS --> on some where

    a demo is at http://ec2-52-88-111-46.us-west-2.compute.amazonaws.com/tutorials/basic/ndarray.html

  3. removed the dependency to the mxnet-notebooks repo, instead i converted several notebooks into markdowns and placed at docs/

  4. mac users can use tests/ci_build/ci_build.sh doc make -C docs/ html now if docker is installed.

piiswrong
piiswrong reviewed May 4, 2017
View reviewed changes
docs/architecture/overview.md
@@ -715,98 +715,6 @@ The gradient, which can be found in `src/operator/smooth_l1_unary-inl.h`, is sim
The new unified API is designed to fulfill the fundamentals of an operation. For operators with more than two inputs,
more than one output, or that need more features, see the original [Operator API](http://mxnet.io/architecture/overview.html#operators-in-mxnet).

## KVStore: Multiple Devices and Multiple Computers
Copy link
Contributor

Choose a reason for hiding this comment

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

why delete all this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

out-of-date and duplicated with another doc

@zackchase
Copy link
Contributor

What's the status on this? When do we expect it to make it into master? @mli @piiswrong

@mli
Copy link
Contributor Author

mli commented May 5, 2017

tested on both linux and mac, should be ok to merge. but not all notebooks converted from mxnet-notebooks are carefully examined. we need to either fix them after merged, or fix them first before merging, which means working on the doc4 branch for several days.

@mli mli merged commit ba8b4c5 into master May 8, 2017
@mli mli added the Doc label May 8, 2017
bikestra pushed a commit to bikestra/mxnet that referenced this pull request May 10, 2017
@mli
[doc] new sphnix plugin (apache#6105)
08ee2e7 
* update doc

* rm

* update

* update ndarray

* update mds

* update

* update

* update

* update

* update

* update

* update image.md and others

* update
rishita pushed a commit to rishita/mxnet that referenced this pull request May 10, 2017
@mli
[doc] new sphnix plugin (apache#6105)
ed05a61 
* update doc

* rm

* update

* update ndarray

* update mds

* update

* update

* update

* update

* update

* update

* update image.md and others

* update
piiswrong pushed a commit that referenced this pull request May 11, 2017
@bikestra @piiswrong
updated docstring for set_lr_mult and set_wd_mult (#6120)
5ef672c 
* 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)
saurabh3949 pushed a commit to saurabh3949/mxnet that referenced this pull request May 23, 2017
@mli @saurabh3949
[doc] new sphnix plugin (apache#6105)
2082df8 
* update doc

* rm

* update

* update ndarray

* update mds

* update

* update

* update

* update

* update

* update

* update image.md and others

* update
saurabh3949 pushed a commit to saurabh3949/mxnet that referenced this pull request May 23, 2017
@bikestra @saurabh3949
updated docstring for set_lr_mult and set_wd_mult (apache#6120)
50ad40d 
* 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)
Guneet-Dhillon pushed a commit to Guneet-Dhillon/mxnet that referenced this pull request Sep 13, 2017
@mli
[doc] new sphnix plugin (apache#6105)
263a79d 
* update doc

* rm

* update

* update ndarray

* update mds

* update

* update

* update

* update

* update

* update

* update image.md and others

* update
Guneet-Dhillon pushed a commit to Guneet-Dhillon/mxnet that referenced this pull request Sep 13, 2017
@bikestra @piiswrong
updated docstring for set_lr_mult and set_wd_mult (apache#6120)
06d1a5b 
* 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)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@piiswrong piiswrong piiswrong left review comments

Assignees
No one assigned
Labels
Doc
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mli @zackchase @piiswrong