Adding task transform tutorial, updating docs generation (#312)

* Add task transforms tutorial

* Modify link

* Add task transforms tutorial

* Update Changelog.md

* Replace mkdocs-pydocs with mkdocstrings.

* Update docs requirements.

* Update changelog.

* fix latex renders

Co-authored-by: seba-1511 <[email protected]>

CHANGELOG.md

@@ -10,9 +10,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* Add tutorial: "Demystifying Task Transforms", ([Varad Pimpalkhute](https://github.com/nightlessbaron/))
+
 ### Changed
 
+* Documentation: uses `mkdocstrings` instead of `pydoc-markdown`.
+
 ### Fixed
+
 * example for `detach_module`. ([Nimish Sanghi](https://github.com/nsanghi))
 
 ## v0.1.7

Makefile

@@ -43,15 +43,19 @@ alltests:
 	make tests >>alltests.txt 2>&1
 	make notravis-tests >>alltests.txt 2>&1
 
-docs:
-	rm -f docs/mkdocs.yml
+predocs:
 	#python scripts/compile_paper_list.py
-	cd docs && pydocmd build && pydocmd serve
+	cp ./README.md docs/index.md
+	cp ./CHANGELOG.md docs/changelog.md
+	cp ./examples/vision/README.md docs/examples/vision.md
+	cp ./examples/rl/README.md docs/examples/rl.md
+	cp ./examples/optimization/README.md docs/examples/optim.md
 
-docs-deploy:
-	rm -f docs/mkdocs.yml
-	#python scripts/compile_paper_list.py
-	cd docs && pydocmd gh-deploy
+docs: predocs
+	mkdocs serve
+
+docs-deploy: predocs
+	mkdocs gh-deploy
 
 # https://dev.to/neshaz/a-tutorial-for-tagging-releases-in-git-147e
 release:

docs/changelog.md

@@ -0,0 +1,157 @@
+
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+* Add tutorial: "Demystifying Task Transforms", ([Varad Pimpalkhute](https://github.com/nightlessbaron/))
+
+### Changed
+
+### Fixed
+* example for `detach_module`. ([Nimish Sanghi](https://github.com/nsanghi))
+
+## v0.1.7
+
+### Added
+
+* Bounding box cropping for Aircraft and CUB200.
+* Pretrained weights for vision models with: `l2l.vision.models.get_pretrained_backbone()`.
+* Add `keep_requires_grad` flag to `detach_module`. ([Zhaofeng Wu](https://github.com/ZhaofengWu))
+
+### Fixed
+
+* Fix arguments when instantiating `l2l.nn.Scale`.
+* Fix `train_loss` logging in `LightningModule` implementations with PyTorch-Lightning 1.5.
+* Fix `RandomClassRotation` ([#283](https://github.com/learnables/learn2learn/pull/283)) to incorporate multi-channelled inputs. ([Varad Pimpalkhute](https://github.com/nightlessbaron/)) 
+* Fix memory leak in `maml.py` and `meta-sgd.py` and add tests to `maml_test.py` and `metasgd_test.py` to check for possible future memory leaks. ([#284](https://github.com/learnables/learn2learn/issues/284)) ([Kevin Zhang](https://github.com/kzhang2)) 
+
+
+## v0.1.6
+
+### Added
+
+* PyTorch Lightning interface to MAML, ANIL, ProtoNet, MetaOptNet.
+* Automatic batcher for Lightning: `l2l.data.EpisodicBatcher`.
+* `l2l.nn.PrototypicalClassifier` and `l2l.nn.SVMClassifier`.
+* Add `l2l.vision.models.WRN28`.
+* Separate modules for `CNN4Backbone`, `ResNet12Backbone`, `WRN28Backbones` w/ pretrained weights.
+* Add `l2l.data.OnDeviceDataset` and implement `device` parameter for benchmarks.
+* (Beta) Add `l2l.data.partition_task` and `l2l.data.InfiniteIterator`.
+
+### Changed
+
+* Renamed and clarify dropout parameters for `ResNet12`.
+
+### Fixed
+
+* Improved support for 1D inputs in `l2l.nn.KroneckerLinear`. (@timweiland)
+
+
+## v0.1.5
+
+### Fixed
+
+* Fix setup.py for windows installs.
+
+## v0.1.4
+
+### Added
+
+* `FilteredMetaDatasest` filter the classes used to sample tasks.
+* `UnionMetaDatasest` to get the union of multiple MetaDatasets.
+* Alias `MiniImageNetCNN` to `CNN4` and add `embedding_size` argument.
+* Optional data augmentation schemes for vision benchmarks.
+* `l2l.vision.models.ResNet12`
+* `l2l.vision.datasets.DescribableTextures`
+* `l2l.vision.datasets.Quickdraw`
+* `l2l.vision.datasets.FGVCFungi`
+* Add `labels_to_indices` and `indices_to_labels` as optional arguments to `l2l.data.MetaDataset`.
+
+### Changed
+
+* Updated reference for citations.
+
+
+## v0.1.3
+
+### Added
+
+* `l2l.vision.datasets.CUBirds200`.
+
+### Changed
+
+* Optimization transforms can be accessed directly through `l2l.optim`, e.g. `l2l.optim.KroneckerTransform`.
+* All vision models adhere to the `.features` and `.classifier` interface.
+
+### Fixed
+
+* Fix `clone_module` for Modules whose submodules share parameters.
+
+
+## v0.1.2
+
+### Added
+
+* New example: [Meta-World](https://github.com/rlworkgroup/metaworld) example with MAML-TRPO with it's own env wrapper. (@[Kostis-S-Z](https://github.com/Kostis-S-Z))
+* `l2l.vision.benchmarks` interface.
+* Differentiable optimization utilities in `l2l.optim`. (including `l2l.optim.LearnableOptimizer` for meta-descent)
+* General gradient-based meta-learning wrapper in `l2l.algorithms.GBML`.
+* Various `nn.Modules` in `l2l.nn`.
+* `l2l.update_module` as a more general alternative to `l2l.algorithms.maml_update`.
+
+### Changed
+
+### Fixed
+
+* clone_module supports non-Module objects.
+* VGG flowers now relies on tarfile.open() instead of tarfile.TarFile().
+
+
+## v0.1.1
+
+### Added
+
+* New tutorial: 'Feature Reuse with ANIL'. (@ewinapun)
+
+### Changed
+
+* Mujoco imports optional for docs: the import error is postponed to first method call.
+
+### Fixed
+
+* `MAML()` and `clone_module` support for RNN modules.
+
+
+## v0.1.0.1
+
+### Fixed
+
+* Remove Cython dependency when installing from PyPI and clean up package distribution.
+
+
+## v0.1.0
+
+### Added
+
+* A CHANGELOG.md file.
+* New vision datasets: FC100, tiered-Imagenet, FGVCAircraft, VGGFlowers102.
+* New vision examples: Reptile & ANIL.
+* Extensive benchmarks of all vision examples.
+
+### Changed
+
+* Re-wrote TaskDataset and task transforms in Cython, for a 20x speed-up.
+* Travis testing with different versions of Python (3.6, 3.7), torch (1.1, 1.2, 1.3, 1.4), and torchvision (0.3, 0.4, 0.5).
+* New Material doc theme with links to changelog and examples.
+
+### Fixed
+
+* Support for `RandomClassRotation` with newer versions of torchvision.
+* Various minor fixes in the examples.
+* Add Dropbox download if GDrive fails for FC100.

docs/docs/learn2learn.algorithms.md

@@ -0,0 +1,44 @@
+
+# learn2learn.algorithms
+
+## High-Level Interfaces
+
+### ::: learn2learn.algorithms.MAML
+    selection:
+      members:
+        - adapt
+        - clone
+
+### ::: learn2learn.algorithms.MetaSGD
+    selection:
+      members:
+        - adapt
+        - clone
+
+### ::: learn2learn.algorithms.GBML
+    selection:
+      members:
+        - adapt
+        - clone
+
+## PyTorch Lightning
+
+### ::: learn2learn.algorithms.LightningMAML
+    selection:
+      members:
+        -
+
+### ::: learn2learn.algorithms.LightningANIL
+    selection:
+      members:
+        -
+
+### ::: learn2learn.algorithms.LightningPrototypicalNetworks
+    selection:
+      members:
+        -
+
+### ::: learn2learn.algorithms.LightningMetaOptNet
+    selection:
+      members:
+        -

docs/docs/learn2learn.data.md

@@ -0,0 +1,64 @@
+
+# learn2learn.data
+
+## Meta-Datasets
+
+### ::: learn2learn.data.MetaDataset
+    selection:
+      members:
+        - __init__
+        - __getitem__
+
+### ::: learn2learn.data.UnionMetaDataset
+    selection:
+      members:
+        - __init__
+        - __getitem__
+
+### ::: learn2learn.data.FilteredMetaDataset
+    selection:
+      members:
+        - __init__
+        - __getitem__
+
+::: learn2learn.data.TaskDataset
+    selection:
+      members:
+        - __init__
+        - __getitem__
+
+
+## learn2learn.data.transforms
+
+Transforms to help automatically generate tasks.
+
+### ::: learn2learn.data.transforms.LoadData
+
+### ::: learn2learn.data.transforms.NWays
+
+### ::: learn2learn.data.transforms.KShots
+
+### ::: learn2learn.data.transforms.FilterLabels
+
+### ::: learn2learn.data.transforms.FusedNWaysKShots
+
+### ::: learn2learn.data.transforms.RemapLabels
+
+### ::: learn2learn.data.transforms.ConsecutiveLabels
+
+## learn2learn.data.utils
+
+Help functions to work with data and tasks.
+
+
+### ::: learn2learn.data.utils.OnDeviceDataset
+    selection:
+      members:
+        -
+
+### ::: learn2learn.data.utils.InfiniteIterator
+    selection:
+      members:
+        -
+
+### ::: learn2learn.data.utils.partition_task

docs/docs/learn2learn.gym.md

@@ -0,0 +1,72 @@
+
+# learn2learn.gym
+
+The `learn2learn.gym` interface is being re-worked and will soon be released with major improvements.
+
+If you need those tasks now, please refer to the [code](https://github.com/learnables/learn2learn/tree/master/learn2learn/gym) and [examples](https://github.com/learnables/learn2learn/tree/master/examples/rl).
+
+
+<!--
+::: learn2learn.gym.MetaEnv
+    selection:
+      members:
+        -
+
+::: learn2learn.gym.AsyncVectorEnv
+    selection:
+      members:
+        - __init__
+
+## learn2learn.gym.envs.mujoco
+
+::: learn2learn.gym.envs.mujoco.HalfCheetahForwardBackwardEnv
+    selection:
+      members:
+        - __init__
+
+::: learn2learn.gym.envs.mujoco.AntForwardBackwardEnv
+    selection:
+      members:
+        - __init__
+
+::: learn2learn.gym.envs.mujoco.AntDirectionEnv
+    selection:
+      members:
+        - __init__
+
+::: learn2learn.gym.envs.mujoco.HumanoidForwardBackwardEnv
+    selection:
+      members:
+        - __init__
+
+::: learn2learn.gym.envs.mujoco.HumanoidDirectionEnv
+    selection:
+      members:
+        - __init__
+
+## learn2learn.gym.envs.particles
+
+::: learn2learn.gym.envs.particles.Particles2DEnv
+    selection:
+      members:
+        - __init__
+
+## learn2learn.gym.envs.metaworld
+
+::: learn2learn.gym.envs.metaworld.MetaWorldML1
+    selection:
+      members:
+        - __init__
+
+::: learn2learn.gym.envs.metaworld.MetaWorldML10
+    selection:
+      members:
+        - __init__
+
+::: learn2learn.gym.envs.metaworld.MetaWorldML45
+    selection:
+      members:
+        - __init__
+
+-->
+

docs/docs/learn2learn.md

@@ -0,0 +1,14 @@
+
+# learn2learn
+
+::: learn2learn.clone_module
+
+::: learn2learn.detach_module
+
+::: learn2learn.update_module
+
+::: learn2learn.magic_box
+
+::: learn2learn.clone_distribution
+
+::: learn2learn.detach_distribution