2019-09-05 18:23:46 -07:00
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
Python API
==========
Overview
--------
This API section details functions, modules, and objects included in MXNet,
describing what they are and what they do. The APIs are grouped into the
following categories:
2019-10-10 16:48:13 -07:00
Imperative API
2020-10-12 14:18:30 -04:00
--------------
2019-09-05 18:23:46 -07:00
.. container :: cards
.. card ::
2020-08-14 17:35:34 -07:00
:title: mxnet.np
:link: np/index.html
2019-09-05 18:23:46 -07:00
2020-08-14 17:35:34 -07:00
MXNet NP module, an array library that provides NumPy-compatible API.
.. card ::
:title: mxnet.npx
:link: npx/index.html
MXNet NPX module, neural network extension to the NumPy-compatible API.
2019-09-05 18:23:46 -07:00
.. card ::
2019-10-10 16:48:13 -07:00
:title: mxnet.gluon
2019-09-05 18:23:46 -07:00
:link: gluon/index.html
Imperative APIs to load data, construct and train neural networks.
2019-10-10 16:48:13 -07:00
Gluon related modules
---------------------
.. container :: cards
.. card ::
:title: mxnet.autograd
:link: autograd/index.html
Functions for Automatic differentiation.
.. card ::
:title: mxnet.optimizer
:link: optimizer/index.html
Functions for applying an optimizer on weights.
.. card ::
:title: mxnet.initializer
:link: initializer/index.html
Default behaviors to initialize parameters.
.. card ::
:title: mxnet.lr_scheduler
:link: lr_scheduler/index.html
Scheduling the learning rate.
2019-09-05 18:23:46 -07:00
.. card ::
2019-10-10 16:48:13 -07:00
:title: mxnet.kvstore
:link: kvstore/index.html
2019-09-05 18:23:46 -07:00
2019-10-10 16:48:13 -07:00
Key value store interface of MXNet for parameter synchronization.
2019-09-05 18:23:46 -07:00
.. card ::
2019-10-10 16:48:13 -07:00
:title: mxnet.context
:link: mxnet/context/index.html
CPU and GPU context information.
.. card ::
:title: mxnet.profiler
:link: mxnet/profiler/index.html
Profiler setting methods.
.. card ::
:title: mxnet.random
:link: mxnet/random/index.html
Imperative random distribution generator functions.
2020-08-14 17:35:34 -07:00
Advanced modules
----------------
2019-10-10 16:48:13 -07:00
.. container :: cards
.. card ::
2020-08-14 17:35:34 -07:00
:title: mxnet.runtime
:link: runtime/index.html
2019-09-05 18:23:46 -07:00
2020-08-14 17:35:34 -07:00
API for querying MXNet enabled features.
2019-10-10 16:48:13 -07:00
.. card ::
2020-08-14 17:35:34 -07:00
:title: mxnet.context
:link: context/index.html
2019-10-10 16:48:13 -07:00
2020-08-14 17:35:34 -07:00
MXNet array context for specifying in-memory storage device.
2019-10-10 16:48:13 -07:00
2020-08-14 17:35:34 -07:00
.. card ::
:title: mxnet.profiler
:link: profiler/index.html
2019-10-10 16:48:13 -07:00
2020-08-14 17:35:34 -07:00
MXNet memory and performance profiler.
2019-10-10 16:48:13 -07:00
.. card ::
2020-08-14 17:35:34 -07:00
:title: mxnet.executor
:link: executor/index.html
2019-10-10 16:48:13 -07:00
2020-08-14 17:35:34 -07:00
Managing symbolic graph execution.
2019-10-10 16:48:13 -07:00
.. card ::
2020-08-14 17:35:34 -07:00
:title: mxnet.kvstore_server
:link: kvstore_server/index.html
2019-10-10 16:48:13 -07:00
2020-08-14 17:35:34 -07:00
Server node for the key value store.
2019-10-10 16:48:13 -07:00
.. card ::
2020-08-14 17:35:34 -07:00
:title: mxnet.engine
:link: engine/index.html
2019-10-10 16:48:13 -07:00
2020-08-14 17:35:34 -07:00
Engine properties management.
2019-10-10 16:48:13 -07:00
.. card ::
2020-08-14 17:35:34 -07:00
:title: mxnet.rtc
:link: rtc/index.html
2019-10-10 16:48:13 -07:00
2020-08-14 17:35:34 -07:00
Tools for compiling and running CUDA code from the python frontend.
2019-10-10 16:48:13 -07:00
.. card ::
2020-08-14 17:35:34 -07:00
:title: mxnet.test_utils
:link: test_utils/index.html
2019-10-10 16:48:13 -07:00
2020-08-14 17:35:34 -07:00
Tools for using and testing MXNet.
2019-10-10 16:48:13 -07:00
.. card ::
2020-08-14 17:35:34 -07:00
:title: mxnet.util
:link: util/index.html
2019-10-10 16:48:13 -07:00
2020-08-14 17:35:34 -07:00
General utility functions
2019-10-10 16:48:13 -07:00
2020-08-14 17:35:34 -07:00
Legacy
------
2019-10-10 16:48:13 -07:00
.. container :: cards
.. card ::
2020-08-14 17:35:34 -07:00
:title: mxnet.ndarray
:link: legacy/ndarray/index.html
2019-10-10 16:48:13 -07:00
2020-08-14 17:35:34 -07:00
Imperative APIs to manipulate multi-dimensional arrays.
2019-10-10 16:48:13 -07:00
.. card ::
2020-08-14 17:35:34 -07:00
:title: mxnet.symbol
:link: legacy/symbol/index.html
2019-10-10 16:48:13 -07:00
2020-08-14 17:35:34 -07:00
Symbolic APIs for multi-dimensional arrays and neural network layers
2019-10-10 16:48:13 -07:00
.. card ::
2020-08-14 17:35:34 -07:00
:title: mxnet.callback
:link: legacy/callback/index.html
2019-10-10 16:48:13 -07:00
2020-08-14 17:35:34 -07:00
Functions to track various statuses during an epoch.
2019-10-10 16:48:13 -07:00
.. card ::
2020-08-14 17:35:34 -07:00
:title: mxnet.image
:link: legacy/image/index.html
2019-10-10 16:48:13 -07:00
2020-08-14 17:35:34 -07:00
Image iterators and image augmentation functions.
2019-09-05 18:23:46 -07:00
.. card ::
2020-08-14 17:35:34 -07:00
:title: mxnet.io
:link: legacy/io/index.html
2019-09-05 18:23:46 -07:00
2020-08-14 17:35:34 -07:00
Data iterators for common data formats and utility functions.
2019-09-05 18:23:46 -07:00
.. card ::
2020-08-14 17:35:34 -07:00
:title: mxnet.recordio
:link: legacy/recordio/index.html
2019-09-05 18:23:46 -07:00
2020-08-14 17:35:34 -07:00
Read and write for the RecordIO data format.
.. card ::
:title: mxnet.visualization
:link: legacy/visualization/index.html
Functions for Symbol visualization.
2019-09-05 18:23:46 -07:00
.. toctree ::
:maxdepth: 1
:hidden:
2020-08-14 17:35:34 -07:00
:glob:
2019-09-05 18:23:46 -07:00
2020-08-14 17:35:34 -07:00
np/index
npx/index
2019-09-05 18:23:46 -07:00
gluon/index
2019-10-10 16:48:13 -07:00
autograd/index
initializer/index
optimizer/index
lr_scheduler/index
kvstore/index
contrib/index
2020-08-14 17:35:34 -07:00
legacy/index
*/index*