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

Commit

Permalink
Add optimizer.contrib to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
leezu committed Sep 4, 2018
1 parent ffde329 commit 089134f
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/api/python/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ Code examples are placed throughout the API documentation and these can be run a
:maxdepth: 1
optimization/optimization.md
optimization/contrib.md
```

## Callback API
Expand Down
52 changes: 52 additions & 0 deletions docs/api/python/optimization/contrib.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Contrib Optimization API

```eval_rst
.. currentmodule:: mxnet.optimizer.contrib
```

## Overview

This document summaries the contrib APIs used to initialize and update the model
weights during training

```eval_rst
.. autosummary::
:nosignatures:
mxnet.optimizer.contrib
```

The `Contrib Optimization` API, defined in the `optimizer.contrib` package, provides
many useful experimental APIs for new features.
This is a place for the community to try out the new features,
so that feature contributors can receive feedback.

```eval_rst
.. warning:: This package contains experimental APIs and may change in the near future.
```

In the rest of this document, we list routines provided by the `optimizer.contrib` package.

## Contrib

```eval_rst
.. currentmodule:: mxnet.optimizer.contrib
.. autosummary::
:nosignatures:
ProximalGroupAdaGrad
```

## API Reference

<script type="text/javascript" src='../../../_static/js/auto_module_index.js'></script>

```eval_rst
.. automodule:: mxnet.optimizer.contrib
:members:
```

<script>auto_index("api-reference");</script>

0 comments on commit 089134f

Please sign in to comment.