diff --git a/docs/python_docs/python/api/gluon/data/index.rst b/docs/python_docs/python/api/gluon/data/index.rst new file mode 100644 index 000000000000..f9e8a21e69d2 --- /dev/null +++ b/docs/python_docs/python/api/gluon/data/index.rst @@ -0,0 +1,63 @@ +.. 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. + +gluon.data +========== + +.. automodule:: mxnet.gluon.data + +Datasets +-------- + +.. autosummary:: + + Dataset + ArrayDataset + RecordFileDataset + SimpleDataset + +Sampling +-------- + +.. autosummary:: + + Sampler + SequentialSampler + RandomSampler + BatchSampler + +DataLoader +---------- + +.. autosummary:: + + DataLoader + + +API Reference +------------- +.. automodule:: mxnet.gluon.data + :members: + :imported-members: + :autosummary: + +.. toctree:: + :hidden: + :maxdepth: 2 + :glob: + + */index \ No newline at end of file diff --git a/docs/python_docs/python/api/gluon/data/vision/datasets/index.rst b/docs/python_docs/python/api/gluon/data/vision/datasets/index.rst new file mode 100644 index 000000000000..6b007526607a --- /dev/null +++ b/docs/python_docs/python/api/gluon/data/vision/datasets/index.rst @@ -0,0 +1,26 @@ +.. 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. + +vision.datasets +=============== + +Gluon provides pre-defined vision datasets functions in the :py:mod:`mxnet.gluon.data.vision.datasets` +module. + +.. automodule:: mxnet.gluon.data.vision.datasets + :members: + :autosummary: diff --git a/docs/python_docs/python/api/gluon/data/vision/index.rst b/docs/python_docs/python/api/gluon/data/vision/index.rst new file mode 100644 index 000000000000..2731b5f4245a --- /dev/null +++ b/docs/python_docs/python/api/gluon/data/vision/index.rst @@ -0,0 +1,53 @@ +.. 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. + +data.vision +============ + +.. automodule:: mxnet.gluon.data.vision + +Datasets +^^^^^^^^ + +.. autosummary:: + :nosignatures: + + mxnet.gluon.data.vision.datasets + + +Data transformations +^^^^^^^^^^^^^^^^^^^^ + + +.. autosummary:: + :nosignatures: + + mxnet.gluon.data.vision.transforms + + +API Reference +------------- +.. automodule:: mxnet.gluon.data.vision + :members: + :autosummary: + +.. toctree:: + :hidden: + :maxdepth: 2 + :glob: + + */index \ No newline at end of file diff --git a/docs/python_docs/python/api/gluon/data/vision/transforms/index.rst b/docs/python_docs/python/api/gluon/data/vision/transforms/index.rst new file mode 100644 index 000000000000..60d975d87aff --- /dev/null +++ b/docs/python_docs/python/api/gluon/data/vision/transforms/index.rst @@ -0,0 +1,48 @@ +.. 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. + +vision.transforms +================= + +Gluon provides pre-defined vision transformation and data augmentation functions in the :py:mod:`mxnet.gluon.data.vision.transforms` +module. + +.. currentmodule:: mxnet.gluon.data.vision + +.. autosummary:: + :nosignatures: + + transforms.Compose + transforms.Cast + transforms.ToTensor + transforms.Normalize + transforms.RandomResizedCrop + transforms.CenterCrop + transforms.Resize + transforms.RandomFlipLeftRight + transforms.RandomFlipTopBottom + transforms.RandomBrightness + transforms.RandomContrast + transforms.RandomSaturation + transforms.RandomHue + transforms.RandomColorJitter + transforms.RandomLighting + +API Reference +------------- +.. automodule:: mxnet.gluon.data.vision.transforms + :members: diff --git a/docs/python_docs/python/api/mxnet/log/index.rst b/docs/python_docs/python/api/mxnet/log/index.rst new file mode 100644 index 000000000000..fd4d8788c28a --- /dev/null +++ b/docs/python_docs/python/api/mxnet/log/index.rst @@ -0,0 +1,23 @@ +.. 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. + +mxnet.log +========= + +.. automodule:: mxnet.log + :members: + :autosummary: \ No newline at end of file diff --git a/docs/python_docs/python/api/mxnet/model/index.rst b/docs/python_docs/python/api/mxnet/model/index.rst new file mode 100644 index 000000000000..69bcddce6bc1 --- /dev/null +++ b/docs/python_docs/python/api/mxnet/model/index.rst @@ -0,0 +1,23 @@ +.. 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. + +mxnet.model +=========== + +.. automodule:: mxnet.model + :members: + :autosummary: