Skip to content

Commit

Permalink
[Website] adjust website structure (apache#18839)
Browse files Browse the repository at this point in the history
* adjust website structure

* update per comments

* adjust ecosystem page

* add ray tune

* fix issues

* update notebooks

* fix breakage
  • Loading branch information
szha authored Aug 15, 2020
1 parent daf8b43 commit be12c8d
Show file tree
Hide file tree
Showing 122 changed files with 1,015 additions and 1,815 deletions.
134 changes: 77 additions & 57 deletions docs/python_docs/python/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,16 @@ Imperative API
.. container:: cards

.. card::
:title: mxnet.ndarray
:link: ndarray/index.html
:title: mxnet.np
:link: np/index.html

Imperative APIs to manipulate multi-dimensional arrays.
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.

.. card::
:title: mxnet.gluon
Expand Down Expand Up @@ -98,123 +104,137 @@ Gluon related modules
Imperative random distribution generator functions.


Symbolic API
------------
Advanced modules
----------------

.. container:: cards

.. card::
:title: mxnet.sym
:link: symbol/index.html
:title: mxnet.runtime
:link: runtime/index.html

Symbolic APIs for multi-dimensional arrays and neural network layers
API for querying MXNet enabled features.

.. card::
:title: mxnet.module
:link: module/index.html

Intermediate and high-level interface for performing computation with Symbols.
:title: mxnet.context
:link: context/index.html

MXNet array context for specifying in-memory storage device.

Symbol related modules
----------------------
.. card::
:title: mxnet.profiler
:link: profiler/index.html

.. container:: cards
MXNet memory and performance profiler.

.. card::
:title: mxnet.callback
:link: mxnet/callback/index.html
:title: mxnet.executor
:link: executor/index.html

Functions to track various statuses during an epoch.
Managing symbolic graph execution.

.. card::
:title: mxnet.monitor
:link: mxnet/monitor/index.html

Outputs, weights, and gradients for debugging
:title: mxnet.kvstore_server
:link: kvstore_server/index.html

Server node for the key value store.

.. card::
:title: mxnet.image
:link: mxnet/image/index.html
:title: mxnet.engine
:link: engine/index.html

Image iterators and image augmentation functions.
Engine properties management.

.. card::
:title: mxnet.io
:link: mxnet/io/index.html
:title: mxnet.rtc
:link: rtc/index.html

Data iterators for common data formats and utility functions.
Tools for compiling and running CUDA code from the python frontend.

.. card::
:title: mxnet.recordio
:link: mxnet/recordio/index.html
:title: mxnet.test_utils
:link: test_utils/index.html

Read and write for the RecordIO data format.
Tools for using and testing MXNet.

.. card::
:title: mxnet.visualization
:link: mxnet/visualization/index.html
:title: mxnet.util
:link: util/index.html

Functions for Symbol visualization.
General utility functions

Advanced modules
----------------
Legacy
------

.. container:: cards

.. card::
:title: mxnet.executor
:link: mxnet/executor/index.html
:title: mxnet.ndarray
:link: legacy/ndarray/index.html

Managing symbolic graph execution.
Imperative APIs to manipulate multi-dimensional arrays.

.. card::
:title: mxnet.kvstore_server
:link: mxnet/kvstore_server/index.html
:title: mxnet.symbol
:link: legacy/symbol/index.html

Server node for the key value store.
Symbolic APIs for multi-dimensional arrays and neural network layers

.. card::
:title: mxnet.engine
:link: mxnet/engine/index.html
:title: mxnet.callback
:link: legacy/callback/index.html

Engine properties management.
Functions to track various statuses during an epoch.

.. card::
:title: mxnet.monitor
:link: legacy/monitor/index.html

Outputs, weights, and gradients for debugging

.. card::
:title: mxnet.rtc
:link: mxnet/rtc/index.html
:title: mxnet.image
:link: legacy/image/index.html

Tools for compiling and running CUDA code from the python frontend.
Image iterators and image augmentation functions.

.. card::
:title: mxnet.test_utils
:link: mxnet/test_utils/index.html
:title: mxnet.io
:link: legacy/io/index.html

Tools for using and testing MXNet.
Data iterators for common data formats and utility functions.

.. card::
:title: mxnet.util
:link: mxnet/util/index.html
:title: mxnet.recordio
:link: legacy/recordio/index.html

General utility functions
Read and write for the RecordIO data format.

.. card::
:title: mxnet.visualization
:link: legacy/visualization/index.html

Functions for Symbol visualization.


.. toctree::
:maxdepth: 1
:hidden:
:glob:

ndarray/index
np/index
npx/index
gluon/index
autograd/index
initializer/index
optimizer/index
lr_scheduler/index
metric/index
kvstore/index
symbol/index
module/index
contrib/index
image/index
mxnet/index
ndarray/index
symbol/index
legacy/index
*/index*
78 changes: 78 additions & 0 deletions docs/python_docs/python/api/legacy/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
.. 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.
Legacy
======

This document hosts API for legacy modules that are being deprecated in MXNet 2.x.

.. container:: cards

.. card::
:title: NDArray API
:link: ndarray/index.html

Imperative APIs to manipulate multi-dimensional arrays.

.. card::
:title: mxnet.symbol
:link: symbol/index.html

Symbolic APIs for multi-dimensional arrays and neural network layers

.. card::
:title: mxnet.callback
:link: callback/index.html

Functions to track various statuses during an epoch.

.. card::
:title: mxnet.monitor
:link: monitor/index.html

Outputs, weights, and gradients for debugging

.. card::
:title: mxnet.io
:link: io/index.html

Data iterators for common data formats and utility functions.

.. card::
:title: mxnet.recordio
:link: recordio/index.html

Read and write for the RecordIO data format.

.. card::
:title: mxnet.image
:link: image/index.html

Image iterators and image augmentation functions.

.. card::
:title: mxnet.visualization
:link: visualization/index.html

Functions for Symbol visualization.


.. toctree::
:hidden:
:glob:

*/index*
23 changes: 0 additions & 23 deletions docs/python_docs/python/api/mxnet/attribute/index.rst

This file was deleted.

23 changes: 0 additions & 23 deletions docs/python_docs/python/api/mxnet/base/index.rst

This file was deleted.

Loading

0 comments on commit be12c8d

Please sign in to comment.