Blame: docs/api/python/module/module.md - apache/mxnet

apache / mxnet UNCLAIMED

Lightweight, Portable, Flexible Distributed/Mobile Deep Learning with Dynamic, Mutation-aware Dataflow Dep Scheduler; for Python, R, Julia, Scala, Go, Javascript and more

0 0 0 C++

Normal View History Raw

Making spelling and general grammar corrections (#4771) 2017-01-22 22:50:33 -08:00			`# Module API`
some docs for module API 2016-04-24 21:24:07 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			```eval_rst
			`.. currentmodule:: mxnet.module`
			```
some docs for module API 2016-04-24 21:24:07 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`## Overview`
some docs for module API 2016-04-24 21:24:07 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			The module API, defined in the `module` (or simply `mod`) package, provides an
			`intermediate and high-level interface for performing computation with a`
			`Symbol`. One can roughly think a module is a machine which can execute a
			program defined by a `Symbol`.
Grammar and language correction under API section. Restructuring Getting Started Page (#3887) * Making spell check, grammar correction and language correction across API section * Reorganize get started page. Remove mnist tutorial from getting started page 2016-11-19 00:54:29 +05:30
Cleanup Python API pages redundant content. (#6215) * howto, API page changes * add examples back * add note back 2017-05-20 18:20:43 -07:00			The `module.Module` accepts a `Symbol` as the input.
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			```python
Cleanup Python API pages redundant content. (#6215) * howto, API page changes * add examples back * add note back 2017-05-20 18:20:43 -07:00			`>>> data = mx.sym.Variable('data')`
			`>>> fc1 = mx.sym.FullyConnected(data, name='fc1', num_hidden=128)`
			`>>> act1 = mx.sym.Activation(fc1, name='relu1', act_type="relu")`
			`>>> fc2 = mx.sym.FullyConnected(act1, name='fc2', num_hidden=10)`
			`>>> out = mx.sym.SoftmaxOutput(fc2, name = 'softmax')`
			`>>> mod = mx.mod.Module(out) # create a module by given a Symbol`
some docs for module API 2016-04-24 21:24:07 -04:00			```

Cleanup Python API pages redundant content. (#6215) * howto, API page changes * add examples back * add note back 2017-05-20 18:20:43 -07:00			Assume there is a valid MXNet data iterator `nd_iter`. We can initialize the
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`module:`
some docs for module API 2016-04-24 21:24:07 -04:00			```python
Cleanup Python API pages redundant content. (#6215) * howto, API page changes * add examples back * add note back 2017-05-20 18:20:43 -07:00			`>>> mod.bind(data_shapes=nd_iter.provide_data,`
			`>>> label_shapes=nd_iter.provide_label) # create memory by given input shapes`
			`>>> mod.init_params() # initial parameters with the default random initializer`
some docs for module API 2016-04-24 21:24:07 -04:00			```

[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`Now the module is able to compute. We can call high-level API to train and`
			`predict:`
some docs for module API 2016-04-24 21:24:07 -04:00			```python
Cleanup Python API pages redundant content. (#6215) * howto, API page changes * add examples back * add note back 2017-05-20 18:20:43 -07:00			`>>> mod.fit(nd_iter, num_epoch=10, ...) # train`
			`>>> mod.predict(new_nd_iter) # predict on new data`
some docs for module API 2016-04-24 21:24:07 -04:00			```

[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`or use intermediate APIs to perform step-by-step computations`
some docs for module API 2016-04-24 21:24:07 -04:00			```python
Cleanup Python API pages redundant content. (#6215) * howto, API page changes * add examples back * add note back 2017-05-20 18:20:43 -07:00			`>>> mod.forward(data_batch) # forward on the provided data batch`
			`>>> mod.backward() # backward to calculate the gradients`
			`>>> mod.update() # update parameters using the default optimizer`
some docs for module API 2016-04-24 21:24:07 -04:00			```

Cleanup Python API pages redundant content. (#6215) * howto, API page changes * add examples back * add note back 2017-05-20 18:20:43 -07:00			`A detailed tutorial is available at`
			`[Module - Neural network training and inference](http://mxnet.io/tutorials/basic/module.html).`
some docs for module API 2016-04-24 21:24:07 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			The `module` package provides several modules:
some docs for module API 2016-04-24 21:24:07 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			```eval_rst
			`.. autosummary::`
			`:nosignatures:`

			`BaseModule`
			`Module`
			`SequentialModule`
			`BucketingModule`
			`PythonModule`
			`PythonLossModule`
some docs for module API 2016-04-24 21:24:07 -04:00			```

[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`We summarize the interface for each class in the following sections.`
some docs for module API 2016-04-24 21:24:07 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			## The `BaseModule` class
Revamped tutorials and API reference pages. Adding examples from mxnet repo to tutorials sections (#3545) * Fixing broken links and format issues in getting started and architecture pages * Fixing all broken links. Change all references from mxnet.readthedocs.org to mxnet.io. * Re-organized tutorials and api reference documents. Added tutorials from mxnet repo examples folder. 2016-10-18 00:41:30 +05:30
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			The `BaseModule` is the base class for all other module classes. It defines the
			`interface each module class should provide.`
some docs for module API 2016-04-24 21:24:07 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`### Initialize memory`
some docs for module API 2016-04-24 21:24:07 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			```eval_rst
			`.. autosummary::`
			`:nosignatures:`
some docs for module API 2016-04-24 21:24:07 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`BaseModule.bind`
			```
some docs for module API 2016-04-24 21:24:07 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`### Get and set parameters`
some docs for module API 2016-04-24 21:24:07 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			```eval_rst
			`.. autosummary::`
			`:nosignatures:`

			`BaseModule.init_params`
			`BaseModule.set_params`
			`BaseModule.get_params`
			`BaseModule.save_params`
			`BaseModule.load_params`
some docs for module API 2016-04-24 21:24:07 -04:00			```

[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`### Train and predict`
some docs for module API 2016-04-24 21:24:07 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			```eval_rst
			`.. autosummary::`
			`:nosignatures:`

			`BaseModule.fit`
			`BaseModule.score`
			`BaseModule.iter_predict`
			`BaseModule.predict`
some docs for module API 2016-04-24 21:24:07 -04:00			```

[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`### Forward and backward`
some docs for module API 2016-04-24 21:24:07 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			```eval_rst
			`.. autosummary::`
			`:nosignatures:`
some docs for module API 2016-04-24 21:24:07 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`BaseModule.forward`
			`BaseModule.backward`
			`BaseModule.forward_backward`
			```
Revamped tutorials and API reference pages. Adding examples from mxnet repo to tutorials sections (#3545) * Fixing broken links and format issues in getting started and architecture pages * Fixing all broken links. Change all references from mxnet.readthedocs.org to mxnet.io. * Re-organized tutorials and api reference documents. Added tutorials from mxnet repo examples folder. 2016-10-18 00:41:30 +05:30
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`### Update parameters`
add existing module docs 2016-04-21 10:10:09 -04:00
			```eval_rst
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`.. autosummary::`
			`:nosignatures:`
add existing module docs 2016-04-21 10:10:09 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`BaseModule.init_optimizer`
			`BaseModule.update`
			`BaseModule.update_metric`
add existing module docs 2016-04-21 10:10:09 -04:00			```

[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`### Input and output`
add existing module docs 2016-04-21 10:10:09 -04:00
			```eval_rst
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`.. autosummary::`
			`:nosignatures:`

			`BaseModule.data_names`
			`BaseModule.output_names`
			`BaseModule.data_shapes`
			`BaseModule.label_shapes`
			`BaseModule.output_shapes`
			`BaseModule.get_outputs`
			`BaseModule.get_input_grads`
			```
add existing module docs 2016-04-21 10:10:09 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`### Others`
add existing module docs 2016-04-21 10:10:09 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			```eval_rst
			`.. autosummary::`
			`:nosignatures:`

			`BaseModule.get_states`
			`BaseModule.set_states`
			`BaseModule.install_monitor`
			`BaseModule.symbol`
add existing module docs 2016-04-21 10:10:09 -04:00			```

Revamped tutorials and API reference pages. Adding examples from mxnet repo to tutorials sections (#3545) * Fixing broken links and format issues in getting started and architecture pages * Fixing all broken links. Change all references from mxnet.readthedocs.org to mxnet.io. * Re-organized tutorials and api reference documents. Added tutorials from mxnet repo examples folder. 2016-10-18 00:41:30 +05:30
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`## Other build-in modules`
add existing module docs 2016-04-21 10:10:09 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			Besides the basic interface defined in `BaseModule`, each module class supports
			`additional functionality. We summarize them in this section.`
add existing module docs 2016-04-21 10:10:09 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			### Class `Module`
add existing module docs 2016-04-21 10:10:09 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			```eval_rst
			`.. autosummary::`
			`:nosignatures:`

			`Module.load`
			`Module.save_checkpoint`
			`Module.reshape`
			`Module.borrow_optimizer`
			`Module.save_optimizer_states`
			`Module.load_optimizer_states`
add existing module docs 2016-04-21 10:10:09 -04:00			```

[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			### Class `BucketModule`
add existing module docs 2016-04-21 10:10:09 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			```eval_rst
			`.. autosummary::`
			`:nosignatures:`
add existing module docs 2016-04-21 10:10:09 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`BucketModule.switch_bucket`
add existing module docs 2016-04-21 10:10:09 -04:00			```

[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			### Class `SequentialModule`
add existing module docs 2016-04-21 10:10:09 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			```eval_rst
			`.. autosummary::`
			`:nosignatures:`
add existing module docs 2016-04-21 10:10:09 -04:00
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`SequentialModule.add`
add existing module docs 2016-04-21 10:10:09 -04:00			```

[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`## API Reference`
Revamped tutorials and API reference pages. Adding examples from mxnet repo to tutorials sections (#3545) * Fixing broken links and format issues in getting started and architecture pages * Fixing all broken links. Change all references from mxnet.readthedocs.org to mxnet.io. * Re-organized tutorials and api reference documents. Added tutorials from mxnet repo examples folder. 2016-10-18 00:41:30 +05:30
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`<script type="text/javascript" src='../../_static/js/auto_module_index.js'></script>`
add existing module docs 2016-04-21 10:10:09 -04:00
			```eval_rst
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`.. autoclass:: mxnet.module.BaseModule`
			`:members:`
			`.. autoclass:: mxnet.module.Module`
			`:members:`
			`.. autoclass:: mxnet.module.BucketingModule`
			`:members:`
			`.. autoclass:: mxnet.module.SequentialModule`
			`:members:`
			`.. autoclass:: mxnet.module.PythonModule`
			`:members:`
			`.. autoclass:: mxnet.module.PythonLossModule`
			`:members:`
add existing module docs 2016-04-21 10:10:09 -04:00			```
Revamped tutorials and API reference pages. Adding examples from mxnet repo to tutorials sections (#3545) * Fixing broken links and format issues in getting started and architecture pages * Fixing all broken links. Change all references from mxnet.readthedocs.org to mxnet.io. * Re-organized tutorials and api reference documents. Added tutorials from mxnet repo examples folder. 2016-10-18 00:41:30 +05:30
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`<script>auto_index("api-reference");</script>`