From 9876df16a2fd3f747c945c050698f25118ceaa6d Mon Sep 17 00:00:00 2001 From: Akihiro Nitta Date: Wed, 31 Mar 2021 02:22:59 +0900 Subject: [PATCH] [docs] Update Bolts link (#6743) * Update Bolts link * Update Bolts link * formt Co-authored-by: Jirka Borovec --- README.md | 20 +++++++++---------- docs/source/ecosystem/bolts.rst | 4 ++-- docs/source/extensions/callbacks.rst | 10 +++++----- docs/source/index.rst | 16 +++++++-------- notebooks/07-cifar10-baseline.ipynb | 2 +- pl_examples/README.md | 4 ++-- .../basic_examples/conv_sequential_example.py | 2 +- 7 files changed, 29 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index fd4e3219fbed4..08529f2b0c113 100644 --- a/README.md +++ b/README.md @@ -342,27 +342,27 @@ class LitAutoEncoder(pl.LightningModule): - [MNIST on TPUs](https://colab.research.google.com/github/PytorchLightning/pytorch-lightning/blob/master/notebooks/06-mnist-tpu-training.ipynb) ###### Contrastive Learning -- [BYOL](https://pytorch-lightning-bolts.readthedocs.io/en/latest/self_supervised_models.html#byol) -- [CPC v2](https://pytorch-lightning-bolts.readthedocs.io/en/latest/self_supervised_models.html#cpc-v2) -- [Moco v2](https://pytorch-lightning-bolts.readthedocs.io/en/latest/self_supervised_models.html#moco-v2) -- [SIMCLR](https://pytorch-lightning-bolts.readthedocs.io/en/latest/self_supervised_models.html#simclr) +- [BYOL](https://lightning-bolts.readthedocs.io/en/latest/self_supervised_models.html#byol) +- [CPC v2](https://lightning-bolts.readthedocs.io/en/latest/self_supervised_models.html#cpc-v2) +- [Moco v2](https://lightning-bolts.readthedocs.io/en/latest/self_supervised_models.html#moco-v2) +- [SIMCLR](https://lightning-bolts.readthedocs.io/en/latest/self_supervised_models.html#simclr) ###### NLP - [BERT](https://colab.research.google.com/github/PytorchLightning/pytorch-lightning/blob/master/notebooks/04-transformers-text-classification.ipynb) -- [GPT-2](https://pytorch-lightning-bolts.readthedocs.io/en/latest/convolutional.html#gpt-2) +- [GPT-2](https://lightning-bolts.readthedocs.io/en/latest/convolutional.html#gpt-2) ###### Reinforcement Learning -- [DQN](https://pytorch-lightning-bolts.readthedocs.io/en/latest/reinforce_learn.html#dqn-models) -- [Dueling-DQN](https://pytorch-lightning-bolts.readthedocs.io/en/latest/reinforce_learn.html#dueling-dqn) -- [Reinforce](https://pytorch-lightning-bolts.readthedocs.io/en/latest/reinforce_learn.html#reinforce) +- [DQN](https://lightning-bolts.readthedocs.io/en/latest/reinforce_learn.html#dqn-models) +- [Dueling-DQN](https://lightning-bolts.readthedocs.io/en/latest/reinforce_learn.html#dueling-dqn) +- [Reinforce](https://lightning-bolts.readthedocs.io/en/latest/reinforce_learn.html#reinforce) ###### Vision - [GAN](https://colab.research.google.com/github/PytorchLightning/pytorch-lightning/blob/master/notebooks/03-basic-gan.ipynb) ###### Classic ML -- [Logistic Regression](https://pytorch-lightning-bolts.readthedocs.io/en/latest/classic_ml.html#logistic-regression) -- [Linear Regression](https://pytorch-lightning-bolts.readthedocs.io/en/latest/classic_ml.html#linear-regression) +- [Logistic Regression](https://lightning-bolts.readthedocs.io/en/latest/classic_ml.html#logistic-regression) +- [Linear Regression](https://lightning-bolts.readthedocs.io/en/latest/classic_ml.html#linear-regression) --- diff --git a/docs/source/ecosystem/bolts.rst b/docs/source/ecosystem/bolts.rst index f3a4ab9c858be..c10097fa4bd05 100644 --- a/docs/source/ecosystem/bolts.rst +++ b/docs/source/ecosystem/bolts.rst @@ -1,11 +1,11 @@ Bolts ===== -`PyTorch Lightning Bolts `_, is our official collection +`PyTorch Lightning Bolts `_, is our official collection of prebuilt models across many research domains. .. code-block:: bash - pip install pytorch-lightning-bolts + pip install lightning-bolts In bolts we have: diff --git a/docs/source/extensions/callbacks.rst b/docs/source/extensions/callbacks.rst index 73691c6dd76f5..dd46e910ff541 100644 --- a/docs/source/extensions/callbacks.rst +++ b/docs/source/extensions/callbacks.rst @@ -71,10 +71,10 @@ Examples -------- You can do pretty much anything with callbacks. -- `Add a MLP to fine-tune self-supervised networks `_. -- `Find how to modify an image input to trick the classification result `_. -- `Interpolate the latent space of any variational model `_. -- `Log images to Tensorboard for any model `_. +- `Add a MLP to fine-tune self-supervised networks `_. +- `Find how to modify an image input to trick the classification result `_. +- `Interpolate the latent space of any variational model `_. +- `Log images to Tensorboard for any model `_. -------------- @@ -85,7 +85,7 @@ Lightning has a few built-in callbacks. .. note:: For a richer collection of callbacks, check out our - `bolts library `_. + `bolts library `_. .. currentmodule:: pytorch_lightning.callbacks diff --git a/docs/source/index.rst b/docs/source/index.rst index 81011cbf14724..1432badf2038f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -79,14 +79,14 @@ PyTorch Lightning Documentation ecosystem/pytorch_ecoystem ecosystem/community_examples - Autoencoder - BYOL - DQN - GAN - GPT-2 - Image-GPT - SimCLR - VAE + Autoencoder + BYOL + DQN + GAN + GPT-2 + Image-GPT + SimCLR + VAE .. toctree:: :maxdepth: 1 diff --git a/notebooks/07-cifar10-baseline.ipynb b/notebooks/07-cifar10-baseline.ipynb index 9f3209a8bbc02..8e9394d653846 100644 --- a/notebooks/07-cifar10-baseline.ipynb +++ b/notebooks/07-cifar10-baseline.ipynb @@ -61,7 +61,7 @@ "id": "ziAQCrE-TYWG" }, "source": [ - "! pip install pytorch-lightning pytorch-lightning-bolts -qU" + "! pip install pytorch-lightning lightning-bolts -qU" ], "execution_count": null, "outputs": [] diff --git a/pl_examples/README.md b/pl_examples/README.md index bed553322edf3..30a891f6b9bfc 100644 --- a/pl_examples/README.md +++ b/pl_examples/README.md @@ -1,6 +1,6 @@ # Examples Our most robust examples showing all sorts of implementations -can be found in our sister library [PyTorch-Lightning-Bolts](https://pytorch-lightning-bolts.readthedocs.io/en/latest/convolutional.html#gpt-2). +can be found in our sister library [PyTorch-Lightning-Bolts](https://lightning-bolts.readthedocs.io/en/latest/convolutional.html#gpt-2). --- @@ -15,5 +15,5 @@ In this folder we add 3 simple examples: ## Domain examples This folder contains older examples. You should instead use the examples -in [PyTorch-Lightning-Bolts](https://pytorch-lightning-bolts.readthedocs.io/en/latest/convolutional.html#gpt-2) +in [PyTorch-Lightning-Bolts](https://lightning-bolts.readthedocs.io/en/latest/convolutional.html#gpt-2) for advanced use cases. diff --git a/pl_examples/basic_examples/conv_sequential_example.py b/pl_examples/basic_examples/conv_sequential_example.py index f3d9469144f50..9747c4a939340 100644 --- a/pl_examples/basic_examples/conv_sequential_example.py +++ b/pl_examples/basic_examples/conv_sequential_example.py @@ -199,7 +199,7 @@ def instantiate_datamodule(args): if __name__ == "__main__": cli_lightning_logo() - assert _BOLTS_AVAILABLE, "Bolts is required for this example, install it via pip install pytorch-lightning-bolts" + assert _BOLTS_AVAILABLE, "Bolts is required for this example, install it via `pip install lightning-bolts`" assert _FAIRSCALE_PIPE_AVAILABLE, "FairScale and PyTorch 1.6 is required for this example." parser = ArgumentParser(description="Pipe Example")