diff --git a/Makefile b/Makefile index b88884dc..246c9b39 100644 --- a/Makefile +++ b/Makefile @@ -22,7 +22,7 @@ uninstall: ## Uninstall pip uninstall labml_nn docs: ## Render annotated HTML - python ../../pylit/pylit.py --remove_empty_sections -s ../../pylit/pylit_docs.css -t ../../pylit/template_docs.html -d html -w labml_nn + python ../../pylit/pylit.py --remove_empty_sections --title_md -s ../../pylit/pylit_docs.css -t ../../pylit/template_docs.html -d html -w labml_nn pages: ## Copy to lab-ml site @cd ../lab-ml.github.io; git pull diff --git a/labml_nn/capsule_networks/__init__.py b/labml_nn/capsule_networks/__init__.py index ae15c528..9a3ad02a 100644 --- a/labml_nn/capsule_networks/__init__.py +++ b/labml_nn/capsule_networks/__init__.py @@ -1,4 +1,6 @@ """ +# Capsule Networks + This is an implementation of [Dynamic Routing Between Capsules](https://arxiv.org/abs/1710.09829). Unlike in other implementations of models, we've included a sample, because diff --git a/labml_nn/gan/__init__.py b/labml_nn/gan/__init__.py index 25372851..6f809aad 100644 --- a/labml_nn/gan/__init__.py +++ b/labml_nn/gan/__init__.py @@ -1,4 +1,6 @@ """ +# Generative Adversarial Networks (GAN) + This is an implementation of [Generative Adversarial Networks](https://arxiv.org/abs/1406.2661). diff --git a/labml_nn/gan/cycle_gan.py b/labml_nn/gan/cycle_gan.py index 99b565d9..b2832ef2 100644 --- a/labml_nn/gan/cycle_gan.py +++ b/labml_nn/gan/cycle_gan.py @@ -1,5 +1,6 @@ """ # Cycle GAN + This is an implementation of paper [Unpaired Image-to-Image Translation using Cycle-Consistent Adversarial Networks](https://arxiv.org/abs/1703.10593). diff --git a/labml_nn/gan/dcgan.py b/labml_nn/gan/dcgan.py index 7092f18f..79be4f5a 100644 --- a/labml_nn/gan/dcgan.py +++ b/labml_nn/gan/dcgan.py @@ -1,4 +1,6 @@ """ +# Deep Convolutional Generative Adversarial Networks (DCGAN) + This is an implementation of paper [Unsupervised Representation Learning with Deep Convolutional Generative Adversarial Networks](https://arxiv.org/abs/1511.06434). diff --git a/labml_nn/gan/simple_mnist_experiment.py b/labml_nn/gan/simple_mnist_experiment.py index 1941dc76..9685d14e 100644 --- a/labml_nn/gan/simple_mnist_experiment.py +++ b/labml_nn/gan/simple_mnist_experiment.py @@ -1,3 +1,7 @@ +""" +# Generative Adversarial Networks experiment with MNIST +""" + from typing import Optional import torch diff --git a/labml_nn/lstm/__init__.py b/labml_nn/lstm/__init__.py index 187d6c6d..181985bf 100644 --- a/labml_nn/lstm/__init__.py +++ b/labml_nn/lstm/__init__.py @@ -1,3 +1,7 @@ +""" +# Long Short-Term Memory (LSTM) +""" + from typing import Optional, Tuple import torch diff --git a/labml_nn/recurrent_highway_networks/__init__.py b/labml_nn/recurrent_highway_networks/__init__.py index f431e6d4..6ba609ec 100644 --- a/labml_nn/recurrent_highway_networks/__init__.py +++ b/labml_nn/recurrent_highway_networks/__init__.py @@ -1,4 +1,6 @@ """ +# Recurrent Highway Networks + This is an implementation of [Recurrent Highway Networks](https://arxiv.org/abs/1607.03474). """ from typing import Optional diff --git a/labml_nn/rl/ppo/__init__.py b/labml_nn/rl/ppo/__init__.py index 15b06c79..50b7c3fa 100644 --- a/labml_nn/rl/ppo/__init__.py +++ b/labml_nn/rl/ppo/__init__.py @@ -1,4 +1,6 @@ """ +# Proximal Policy Optimization (PPO) + This is a an implementation of [Proximal Policy Optimization - PPO](https://arxiv.org/abs/1707.06347). You can find an experiment that uses it [here](experiment.html). diff --git a/labml_nn/rl/ppo/experiment.py b/labml_nn/rl/ppo/experiment.py index 33d5a955..83c02a5c 100644 --- a/labml_nn/rl/ppo/experiment.py +++ b/labml_nn/rl/ppo/experiment.py @@ -1,4 +1,6 @@ """ +# PPO Experiment with Atari Breakout + This experiment runs PPO Atari Breakout game on OpenAI Gym. It runs the [game environments on multiple processes](game.html) to sample efficiently. """ diff --git a/labml_nn/rl/ppo/gae.py b/labml_nn/rl/ppo/gae.py index 1ad63600..67de7341 100644 --- a/labml_nn/rl/ppo/gae.py +++ b/labml_nn/rl/ppo/gae.py @@ -1,4 +1,6 @@ """ +# Generalized Advantage Estimation (GAE) + This is an implementation of paper [Generalized Advantage Estimation](https://arxiv.org/abs/1506.02438). """ diff --git a/labml_nn/rl/ppo/game.py b/labml_nn/rl/ppo/game.py index 4019cb1b..af8743ea 100644 --- a/labml_nn/rl/ppo/game.py +++ b/labml_nn/rl/ppo/game.py @@ -1,3 +1,6 @@ +""" +# Atari wrapper with multi-processing +""" import multiprocessing import multiprocessing.connection diff --git a/labml_nn/sketch_rnn/__init__.py b/labml_nn/sketch_rnn/__init__.py index 55a50d8a..29ac60a9 100644 --- a/labml_nn/sketch_rnn/__init__.py +++ b/labml_nn/sketch_rnn/__init__.py @@ -1,5 +1,5 @@ """ -# SketchRNN +# Sketch RNN This is an annotated implementation of the paper [A Neural Representation of Sketch Drawings](https://arxiv.org/abs/1704.03477). diff --git a/labml_nn/transformers/configs.py b/labml_nn/transformers/configs.py index faa5a249..c4467d96 100644 --- a/labml_nn/transformers/configs.py +++ b/labml_nn/transformers/configs.py @@ -1,3 +1,6 @@ +""" +# Configurable Transformer Components +""" import copy import torch.nn as nn diff --git a/labml_nn/transformers/label_smoothing_loss.py b/labml_nn/transformers/label_smoothing_loss.py index 04cbd7f1..b1f3e93a 100644 --- a/labml_nn/transformers/label_smoothing_loss.py +++ b/labml_nn/transformers/label_smoothing_loss.py @@ -1,3 +1,6 @@ +""" +# Label Smoothing Loss +""" import matplotlib.pyplot as plt import numpy as np import torch diff --git a/labml_nn/transformers/models.py b/labml_nn/transformers/models.py index e2f71f32..00063375 100644 --- a/labml_nn/transformers/models.py +++ b/labml_nn/transformers/models.py @@ -1,3 +1,6 @@ +""" +# Transformer Models +""" import math import torch