Blame: docs/api/python/index.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			`# MXNet - Python API`
[docs] add package documents 2016-03-19 20:37:09 -04:00
Added brief intro to Python API (#6350) * Intro to Python API * updates * more fixes * fix jupyter note * cleanup 2017-05-19 13:05:12 -07:00			`MXNet provides a rich Python API to serve a broad community of Python developers.`
Fix minor issues with api pages. (#6410) 1. In the notes section for ndarray, references did not seem clear enough to be referring to mxnet.ndarray or numpy.ndarray. Added the package names as prefixes to make it more obvious. 2. "share the same C++ operator source codes" => "share the same code". Since we don't really need to throw in more details than required. 3. Other relatively minor language changes which will be obvious from the diff. Note that I'm relatively not sure about the need for 1/ since it makes things more verbose. Let me know if it unnecessary and I'll remove it. 2017-05-25 12:47:16 -07:00			`In this section, we provide an in-depth discussion of the functionality provided by`
Added brief intro to Python API (#6350) * Intro to Python API * updates * more fixes * fix jupyter note * cleanup 2017-05-19 13:05:12 -07:00			`various MXNet Python packages. We have included code samples for most of the APIs`
			`for improved clarity. These code samples will run as-is as long as MXNet is first`
			`imported by running:`
[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
			`>>> import mxnet as mx`
			```

			```eval_rst

			.. note:: A convenient way to execute examples is the ``%doctest_mode`` mode of
Added brief intro to Python API (#6350) * Intro to Python API * updates * more fixes * fix jupyter note * cleanup 2017-05-19 13:05:12 -07:00			`Jupyter notebook, which allows for pasting multi-line examples containing`
			``>>>`` while preserving indentation. Run ``%doctest_mode?`` in Jupyter notebook
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			`for more details.`

			```

Refactor api table of contents (#7840) * Fix API table of contents * Add back model 2017-09-10 22:21:15 -07:00			`## NDArray API`
[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
Python symbol/ndarray api re-org (#7712) * add ndarray folder * add sparse.md draft * update sparse.md * add contrib, linalg, random to ndarray.md * add contrib, linalg random to symbol * add sparse.md * update notes and op docs for sparse * remove unused files * add back random & la * fix inherited methods for sparse ndarray * remove speical members * fix lint * add contrib * add random.md 2017-09-07 13:45:21 -07:00			`.. toctree::`
Refactor api table of contents (#7840) * Fix API table of contents * Add back model 2017-09-10 22:21:15 -07:00			`:maxdepth: 1`
Python symbol/ndarray api re-org (#7712) * add ndarray folder * add sparse.md draft * update sparse.md * add contrib, linalg, random to ndarray.md * add contrib, linalg random to symbol * add sparse.md * update notes and op docs for sparse * remove unused files * add back random & la * fix inherited methods for sparse ndarray * remove speical members * fix lint * add contrib * add random.md 2017-09-07 13:45:21 -07:00
Refactor api table of contents (#7840) * Fix API table of contents * Add back model 2017-09-10 22:21:15 -07:00			`ndarray/ndarray.md`
			`ndarray/random.md`
			`ndarray/linalg.md`
			`ndarray/sparse.md`
			`ndarray/contrib.md`
			```

			`## Symbol API`

			```eval_rst
			`.. toctree::`
			`:maxdepth: 1`

Fix Symbol Index (#7902) 2017-09-14 23:57:06 -07:00			`symbol/symbol.md`
Refactor api table of contents (#7840) * Fix API table of contents * Add back model 2017-09-10 22:21:15 -07:00			`symbol/random.md`
			`symbol/linalg.md`
			`symbol/sparse.md`
			`symbol/contrib.md`
doc update (#8088) * doc update * keep blocks in nn namespace 2017-09-30 11:18:19 -07:00			`symbol/rnn.md`
Refactor api table of contents (#7840) * Fix API table of contents * Add back model 2017-09-10 22:21:15 -07:00			```

			`## Module API`

			```eval_rst
			`.. toctree::`
			`:maxdepth: 1`

			`module/module.md`
doc update (#8088) * doc update * keep blocks in nn namespace 2017-09-30 11:18:19 -07:00			`executor/executor.md`
Refactor api table of contents (#7840) * Fix API table of contents * Add back model 2017-09-10 22:21:15 -07:00			```

			`## Autograd API`

			```eval_rst
			`.. toctree::`
			`:maxdepth: 1`

			`autograd/autograd.md`
			```

			`## Gluon API`

			```eval_rst
			`.. toctree::`
			`:maxdepth: 1`

			`gluon/gluon.md`
doc update (#8088) * doc update * keep blocks in nn namespace 2017-09-30 11:18:19 -07:00			`gluon/nn.md`
			`gluon/rnn.md`
			`gluon/loss.md`
			`gluon/data.md`
			`gluon/model_zoo.md`
			`gluon/contrib.md`
Refactor api table of contents (#7840) * Fix API table of contents * Add back model 2017-09-10 22:21:15 -07:00			```

			`## KVStore API`
Python symbol/ndarray api re-org (#7712) * add ndarray folder * add sparse.md draft * update sparse.md * add contrib, linalg, random to ndarray.md * add contrib, linalg random to symbol * add sparse.md * update notes and op docs for sparse * remove unused files * add back random & la * fix inherited methods for sparse ndarray * remove speical members * fix lint * add contrib * add random.md 2017-09-07 13:45:21 -07:00
Refactor api table of contents (#7840) * Fix API table of contents * Add back model 2017-09-10 22:21:15 -07:00			```eval_rst
			`.. toctree::`
			`:maxdepth: 1`

			`kvstore/kvstore.md`
			```

			`## IO API`

			```eval_rst
			`.. toctree::`
			`:maxdepth: 1`

			`io/io.md`
			```

			`## Image API`

			```eval_rst
			`.. toctree::`
			`:maxdepth: 1`

			`image/image.md`
			```

			`## Optimization API`

			```eval_rst
			`.. toctree::`
			`:maxdepth: 1`

			`optimization/optimization.md`
			```

			`## Callback API`

			```eval_rst
			`.. toctree::`
			`:maxdepth: 1`

			`callback/callback.md`
			```

			`## Metric API`

			```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			`.. toctree::`
Refactor api table of contents (#7840) * Fix API table of contents * Add back model 2017-09-10 22:21:15 -07:00			`:maxdepth: 1`
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00
Refactor api table of contents (#7840) * Fix API table of contents * Add back model 2017-09-10 22:21:15 -07:00			`metric/metric.md`
[doc] refactored api/python/module.py (#5265) * update navbar, toc, and python api index * update module 2017-03-06 11:36:12 -08:00			```
Add cuda rtc module (#8017) * Add cuda rtc module * add to docs * commit fix * fix * fix * Update Jenkinsfile 2017-09-26 12:10:26 -07:00
			`## Run-Time Compilation API`

			```eval_rst
			`.. toctree::`
			`:maxdepth 1`

			`rtc/rtc.md`
			```
Text APIs: interface re-design with name changes (#9534) * revise text api names * update * Add test cases * remove unused copy * update docstrings * Add API doc * rebuild * Fix broken links, shorten func name * remove redundant underscore * move api docs to contrib * naming: contrib package 2018-01-24 15:20:30 -08:00
			`## Contrib Package`

			```eval_rst
			`.. toctree::`
			`:maxdepth: 1`

			`contrib/contrib.md`
			`contrib/text.md`
			```