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

Update documentation for plot_graph. #6098

Merged
merged 3 commits into from
May 10, 2017
Merged

Update documentation for plot_graph. #6098

merged 3 commits into from
May 10, 2017

Conversation

indhub
Copy link
Contributor

@indhub indhub commented May 4, 2017

@mli, @zackchase, @madjam, @nswamy, @Roshrini, @jiajiechen
Please review and merge.

>>> net = mx.sym.Activation(data=net, name='relu1', act_type="relu")
>>> net = mx.sym.FullyConnected(data=net, name='fc2', num_hidden=10)
>>> net = mx.sym.SoftmaxOutput(data=net, name='out')
>>> mx.viz.plot_network(net, shape={'data':(100,200)}, node_attrs={"fixedsize":"false"})
Copy link
Contributor

Choose a reason for hiding this comment

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

explain how to used the returned object

``node_attrs={"shape":"oval","fixedsize":"false"}``
will use oval shape for nodes and allow variable sized nodes in the visualization.
hide_weights: bool, optional
Whether to hide inputs with names of the form `*_weight` in the visualization.
Copy link
Contributor

Choose a reason for hiding this comment

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

weight or bias.
also explain why they are hidden

A symbol from the computation graph. The generated digraph will visualize the part
of the computation graph required to compute `symbol`.
shape: dict, optional
Specifies the shape of the input tensors. If specified, the visualization will include
Copy link
Contributor

@piiswrong piiswrong May 4, 2017

Choose a reason for hiding this comment

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

the new description of symbol/shape/node_attr/hide_weight seems unnecessarily verbose and even harder to understand.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If you have specific suggestions on how to rewrite any of them, please let me know.

Copy link
Contributor

Choose a reason for hiding this comment

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

The new description appears to be inaccurate. *_weight and *_bias ARE required to compute the symbol. I'd revert this back to the original description with minor modification:

If True (default), then inputs with names of form *_weight (corresponding to weight tensors) or *_bias (corresponding to bias vectors) will be hidden.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure if I understand you. Does the current description say that *_weight and *_bias are not required to compute the symbol?

@madjam madjam added the Doc label May 4, 2017
A symbol from the computation graph. The generated digraph will visualize the part
of the computation graph required to compute `symbol`.
shape: dict, optional
Specifies the shape of the input tensors. If specified, the visualization will include
Copy link
Contributor

Choose a reason for hiding this comment

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

The new description appears to be inaccurate. *_weight and *_bias ARE required to compute the symbol. I'd revert this back to the original description with minor modification:

If True (default), then inputs with names of form *_weight (corresponding to weight tensors) or *_bias (corresponding to bias vectors) will be hidden.

@piiswrong piiswrong merged commit 5dfb461 into apache:master May 10, 2017
bikestra pushed a commit to bikestra/mxnet that referenced this pull request May 10, 2017
* Update documentation for plot_graph.

* Minor doc fix.
rishita pushed a commit to rishita/mxnet that referenced this pull request May 10, 2017
* Update documentation for plot_graph.

* Minor doc fix.
piiswrong pushed a commit that referenced this pull request May 11, 2017
* 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
* Update documentation for plot_graph.

* Minor doc fix.
saurabh3949 pushed a commit to saurabh3949/mxnet that referenced this pull request May 23, 2017
* 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)
@indhub indhub deleted the doc/plotgraph branch June 2, 2017 18:38
Guneet-Dhillon pushed a commit to Guneet-Dhillon/mxnet that referenced this pull request Sep 13, 2017
* Update documentation for plot_graph.

* Minor doc fix.
Guneet-Dhillon pushed a commit to Guneet-Dhillon/mxnet that referenced this pull request Sep 13, 2017
* 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.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants