Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor: shorten bolts name #583

Merged
merged 5 commits into from
Mar 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Tests are written using [pytest](https://docs.pytest.org/en/stable/). Tests in P

Along with these we have tests for losses, callbacks and transforms as well.

Have a look at sample tests [here](https://github.com/PyTorchLightning/pytorch-lightning-bolts/tree/master/tests).
Have a look at sample tests [here](https://github.com/PyTorchLightning/lightning-bolts/tree/master/tests).

After you have added the respective tests, you can run the tests locally with make script:

Expand All @@ -118,7 +118,7 @@ In case you adding new dependencies, make sure that they are compatible with the

1. **How can I help/contribute?**

All help is extremely welcome - reporting bugs, fixing documentation, adding test cases, solving issues and preparing bug fixes. To solve some issues you can start with label [good first issue](https://github.com/PyTorchLightning/pytorch-lightning-bolts/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or chose something close to your domain with label [help wanted](https://github.com/PyTorchLightning/pytorch-lightning-bolts/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22). Before you start to implement anything check that the issue description that it is clear and self-assign the task to you (if it is not possible, just comment that you take it and we assign it to you...).
All help is extremely welcome - reporting bugs, fixing documentation, adding test cases, solving issues and preparing bug fixes. To solve some issues you can start with label [good first issue](https://github.com/PyTorchLightning/lightning-bolts/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or chose something close to your domain with label [help wanted](https://github.com/PyTorchLightning/lightning-bolts/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22). Before you start to implement anything check that the issue description that it is clear and self-assign the task to you (if it is not possible, just comment that you take it and we assign it to you...).

2. **Is there a recommendation for branch names?**

Expand Down
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ Fixes # (issue)

## Before submitting
- [ ] Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
- [ ] Did you read the [contributor guideline](https://github.com/PyTorchLightning/pytorch-lightning-bolts/blob/master/.github/CONTRIBUTING.md), Pull Request section?
- [ ] Did you read the [contributor guideline](https://github.com/PyTorchLightning/lightning-bolts/blob/master/.github/CONTRIBUTING.md), Pull Request section?
- [ ] Did you make sure your PR does only one thing, instead of bundling different changes together?
- [ ] Did you make sure to update the documentation with your changes?
- [ ] Did you write any new necessary tests? [not needed for typos/docs]
- [ ] Did you verify new and existing tests pass locally with your changes?
- [ ] If you made a notable change (that affects users), did you update the [CHANGELOG](https://github.com/PyTorchLightning/pytorch-lightning-bolts/blob/master/CHANGELOG.md)?
- [ ] If you made a notable change (that affects users), did you update the [CHANGELOG](https://github.com/PyTorchLightning/lightning-bolts/blob/master/CHANGELOG.md)?

<!-- For CHANGELOG separate each item in unreleased section by a blank line to reduce collisions -->

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci_test-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ jobs:
# see: https://github.com/actions/toolkit/issues/399
continue-on-error: true
with:
token: ${{ secrets.CODECOV_TOKEN }}
# token: ${{ secrets.CODECOV_TOKEN }}
file: coverage.xml
flags: cpu,pytest
name: Base-coverage
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci_test-full.yml
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ jobs:
# see: https://github.com/actions/toolkit/issues/399
continue-on-error: true
with:
token: ${{ secrets.CODECOV_TOKEN }}
# token: ${{ secrets.CODECOV_TOKEN }}
file: ./coverage.xml
flags: unittests
env_vars: OS,PYTHON
Expand Down
166 changes: 83 additions & 83 deletions CHANGELOG.md

Large diffs are not rendered by default.

30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,22 @@
<a href="https://www.pytorchlightning.ai/">Website</a> •
<a href="#install">Installation</a> •
<a href="#main-Goals-of-Bolts">Main goals</a> •
<a href="https://pytorch-lightning-bolts.readthedocs.io/en/latest/">latest Docs</a> •
<a href="https://pytorch-lightning-bolts.readthedocs.io/en/stable/">stable Docs</a> •
<a href="https://lightning-bolts.readthedocs.io/en/latest/">latest Docs</a> •
<a href="https://lightning-bolts.readthedocs.io/en/stable/">stable Docs</a> •
<a href="#team">Community</a> •
<a href="https://www.grid.ai/">Grid AI</a> •
<a href="#licence">Licence</a>
</p>

[![PyPI Status](https://badge.fury.io/py/pytorch-lightning-bolts.svg)](https://badge.fury.io/py/pytorch-lightning-bolts)
[![PyPI Status](https://pepy.tech/badge/pytorch-lightning-bolts)](https://pepy.tech/project/pytorch-lightning-bolts)
[![codecov](https://codecov.io/gh/PyTorchLightning/pytorch-lightning-bolts/branch/master/graph/badge.svg)](https://codecov.io/gh/PyTorchLightning/pytorch-lightning-bolts)
[![CodeFactor](https://www.codefactor.io/repository/github/pytorchlightning/pytorch-lightning-bolts/badge)](https://www.codefactor.io/repository/github/pytorchlightning/pytorch-lightning-bolts)
[![PyPI Status](https://badge.fury.io/py/lightning-bolts.svg)](https://badge.fury.io/py/lightning-bolts)
[![PyPI Status](https://pepy.tech/badge/lightning-bolts)](https://pepy.tech/project/lightning-bolts)
[![codecov](https://codecov.io/gh/PyTorchLightning/lightning-bolts/branch/master/graph/badge.svg)](https://codecov.io/gh/PyTorchLightning/lightning-bolts)
[![CodeFactor](https://www.codefactor.io/repository/github/pytorchlightning/lightning-bolts/badge)](https://www.codefactor.io/repository/github/pytorchlightning/lightning-bolts)

[![Documentation Status](https://readthedocs.org/projects/pytorch-lightning-bolts/badge/?version=latest)](https://pytorch-lightning-bolts.readthedocs.io/en/latest/)
[![Documentation Status](https://readthedocs.org/projects/lightning-bolts/badge/?version=latest)](https://lightning-bolts.readthedocs.io/en/latest/)
[![Slack](https://img.shields.io/badge/slack-chat-green.svg?logo=slack)](https://join.slack.com/t/pytorch-lightning/shared_invite/zt-f6bl2l0l-JYMK3tbAgAmGRrlNr00f1A)
[![Discourse status](https://img.shields.io/discourse/status?server=https%3A%2F%2Fforums.pytorchlightning.ai)](https://forums.pytorchlightning.ai/)
[![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/PytorchLightning/pytorch-lightning/blob/master/LICENSE)
[![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/PytorchLightning/lightning-bolts/blob/master/LICENSE)

<!--
[![Next Release](https://img.shields.io/badge/Next%20Release-Oct%2005-purple.svg)](https://shields.io/)
Expand All @@ -39,11 +39,11 @@

<center>

| System / PyTorch ver. | 1.6 (min. req.) | 1.7 (latest) |
| System / PyTorch ver. | 1.6 (min. req.) | 1.8 (latest) |
| :---: | :---: | :---: |
| Linux py3.{6,8} | ![CI full testing](https://github.com/PyTorchLightning/pytorch-lightning-bolts/workflows/CI%20full%20testing/badge.svg?branch=master&event=push) | ![CI full testing](https://github.com/PyTorchLightning/pytorch-lightning-bolts/workflows/CI%20full%20testing/badge.svg?branch=master&event=push) |
| OSX py3.{6,8} | ![CI full testing](https://github.com/PyTorchLightning/pytorch-lightning-bolts/workflows/CI%20full%20testing/badge.svg?branch=master&event=push) | ![CI full testing](https://github.com/PyTorchLightning/pytorch-lightning-bolts/workflows/CI%20full%20testing/badge.svg?branch=master&event=push) |
| Windows py3.7* | ![CI base testing](https://github.com/PyTorchLightning/pytorch-lightning-bolts/workflows/CI%20base%20testing/badge.svg?branch=master&event=push) | ![CI base testing](https://github.com/PyTorchLightning/pytorch-lightning-bolts/workflows/CI%20base%20testing/badge.svg?branch=master&event=push) |
| Linux py3.{6,8} | ![CI full testing](https://github.com/PyTorchLightning/lightning-bolts/workflows/CI%20full%20testing/badge.svg?branch=master&event=push) | ![CI full testing](https://github.com/PyTorchLightning/lightning-bolts/workflows/CI%20full%20testing/badge.svg?branch=master&event=push) |
| OSX py3.{6,8} | ![CI full testing](https://github.com/PyTorchLightning/lightning-bolts/workflows/CI%20full%20testing/badge.svg?branch=master&event=push) | ![CI full testing](https://github.com/PyTorchLightning/lightning-bolts/workflows/CI%20full%20testing/badge.svg?branch=master&event=push) |
| Windows py3.7* | ![CI base testing](https://github.com/PyTorchLightning/lightning-bolts/workflows/CI%20base%20testing/badge.svg?branch=master&event=push) | ![CI base testing](https://github.com/PyTorchLightning/lightning-bolts/workflows/CI%20base%20testing/badge.svg?branch=master&event=push) |

</center>

Expand All @@ -53,17 +53,17 @@

Simple installation from PyPI
```bash
pip install pytorch-lightning-bolts
pip install lightning-bolts
```

Install bleeding-edge (no guarantees)
```bash
pip install git+https://github.com/PytorchLightning/pytorch-lightning-bolts.git@master --upgrade
pip install git+https://github.com/PytorchLightning/lightning-bolts.git@master --upgrade
```

In case you want to have full experience you can install all optional packages at once
```bash
pip install pytorch-lightning-bolts["extra"]
pip install lightning-bolts["extra"]
```

## What is Bolts
Expand Down
16 changes: 8 additions & 8 deletions docs/source/_templates/theme_variables.jinja
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
{%- set external_urls = {
'github': 'https://github.com/PytorchLightning/pytorch-lightning-bolts',
'github_issues': 'https://github.com/PytorchLightning/pytorch-lightning-bolts/issues',
'contributing': 'https://github.com/PytorchLightning/pytorch-lightning/blob/master/CONTRIBUTING.md',
'github': 'https://github.com/PytorchLightning/lightning-bolts',
'github_issues': 'https://github.com/PytorchLightning/lightning-bolts/issues',
'contributing': 'https://github.com/PytorchLightning/lightning-bolts/blob/master/CONTRIBUTING.md',
'governance': 'https://github.com/PytorchLightning/pytorch-lightning/blob/master/governance.md',
'docs': 'https://pytorch-lightning-bolts.rtfd.io/en/latest',
'docs': 'https://lightning-bolts.rtfd.io/en/latest',
'twitter': 'https://twitter.com/PyTorchLightnin',
'discuss': 'https://pytorch-lightning.slack.com',
'tutorials': 'https://pytorch-lightning.readthedocs.io/en/latest/#tutorials',
'previous_pytorch_versions': 'https://pytorch-lightning.rtfd.io/en/latest/',
'home': 'https://pytorch-lightning.rtfd.io/en/latest/',
'previous_pytorch_versions': 'https://pytorch.rtfd.io/en/latest/',
'home': 'https://lightning-bolts.rtfd.io/en/latest/',
'get_started': 'https://pytorch-lightning.readthedocs.io/en/latest/introduction_guide.html',
'features': 'https://pytorch-lightning.rtfd.io/en/latest/',
'features': 'https://lightning-bolts.rtfd.io/en/latest/',
'blog': 'https://www.pytorchlightning.ai/blog',
'resources': 'https://pytorch-lightning.readthedocs.io/en/latest/#community-examples',
'support': 'https://pytorch-lightning.rtfd.io/en/latest/',
'support': 'https://lightning-bolts.rtfd.io/en/latest/',
}
-%}
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
# -- Project information -----------------------------------------------------

# this name shall match the project name in Github as it is used for linking to code
project = 'PyTorch-Lightning-Bolts'
project = 'Lightning-Bolts'
copyright = pl_bolts.__copyright__
author = pl_bolts.__author__

Expand Down
4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

PyTorch-Lightning-Bolts documentation
=====================================
Lightning-Bolts documentation
=============================
.. toctree::
:maxdepth: 1
:name: start
Expand Down
8 changes: 4 additions & 4 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
Installation
============

You can install using `pip <https://pypi.org/project/pytorch-lightning/>`_
You can install using `pip <https://pypi.org/project/lightning-bolts/>`_

.. code-block:: bash

pip install pytorch-lightning-bolts
pip install lightning-bolts

Install bleeding-edge (no guarantees)

.. code-block:: bash

pip install git+https://github.com/PytorchLightning/pytorch-lightning-bolts.git@master --upgrade
pip install git+https://github.com/PytorchLightning/lightning-bolts.git@master --upgrade

In case you want to have full experience you can install all optional packages at once

.. code-block:: bash

pip install pytorch-lightning-bolts["extra"]
pip install lightning-bolts["extra"]

6 changes: 3 additions & 3 deletions docs/source/introduction_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,10 @@ We accept contributions directly to Bolts or via your own repository.
To contribute:

1. Submit a pull request to Bolts (we will help you finish it!).
2. We'll help you add `tests <https://github.com/PyTorchLightning/pytorch-lightning-bolts/tree/master/tests>`_.
2. We'll help you add `tests <https://github.com/PyTorchLightning/lightning-bolts/tree/master/tests>`_.
3. We'll help you refactor models to work on `(GPU, TPU, CPU). <https://www.youtube.com/watch?v=neuNEcN9FK4>`_.
4. We'll help you remove bottlenecks in your model.
5. We'll help you write up `documentation <https://pytorch-lightning-bolts.readthedocs.io/en/latest/convolutional.html#image-gpt>`_.
5. We'll help you write up `documentation <https://lightning-bolts.readthedocs.io/en/latest/convolutional.html#image-gpt>`_.
6. We'll help you pretrain expensive models and host weights for you.
7. We'll create proper attribution for you and link to your repo.
8. Once all of this is ready, we will merge into bolts.
Expand All @@ -129,7 +129,7 @@ Contribution ideas
^^^^^^^^^^^^^^^^^^
Don't have something to contribute? Ping us on
`Slack <https://join.slack.com/t/pytorch-lightning/shared_invite/zt-f6bl2l0l-JYMK3tbAgAmGRrlNr00f1A>`_
or look at our `Github issues <https://github.com/PyTorchLightning/pytorch-lightning-bolts/
or look at our `Github issues <https://github.com/PyTorchLightning/lightning-bolts/
issues?q=is%3Aissue+is%3Aopen+label%3A%22Model+to+implement%22>`_!

**We'll help and guide you through the implementation / conversion**
Expand Down
4 changes: 2 additions & 2 deletions docs/source/models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ Tested
^^^^^^
Models are tested on every PR (on CPUs, GPUs and soon TPUs).

- `Live build <https://github.com/PyTorchLightning/pytorch-lightning-bolts/pull/59/checks>`_
- `Tests <https://github.com/PyTorchLightning/pytorch-lightning-bolts/tree/master/tests>`_
- `Live build <https://github.com/PyTorchLightning/lightning-bolts/pull/59/checks>`_
- `Tests <https://github.com/PyTorchLightning/lightning-bolts/tree/master/tests>`_

Modular
^^^^^^^
Expand Down
20 changes: 10 additions & 10 deletions docs/source/self_supervised_models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -159,23 +159,23 @@ Results in table are reported from the
- LR
* - CIFAR-10
- 84.52
- `CPCresnet101 <https://github.com/PyTorchLightning/pytorch-lightning-bolts/blob/master/pl_bolts/models/self_supervised/cpc/networks.py#L103>`_
- `CPCresnet101 <https://github.com/PyTorchLightning/lightning-bolts/blob/master/pl_bolts/models/self_supervised/cpc/networks.py#L103>`_
- Adam
- 64
- 1000 (upto 24 hours)
- 1 V100 (32GB)
- 4e-5
* - STL-10
- 78.36
- `CPCresnet101 <https://github.com/PyTorchLightning/pytorch-lightning-bolts/blob/master/pl_bolts/models/self_supervised/cpc/networks.py#L103>`_
- `CPCresnet101 <https://github.com/PyTorchLightning/lightning-bolts/blob/master/pl_bolts/models/self_supervised/cpc/networks.py#L103>`_
- Adam
- 144
- 1000 (upto 72 hours)
- 4 V100 (32GB)
- 1e-4
* - ImageNet
- 54.82
- `CPCresnet101 <https://github.com/PyTorchLightning/pytorch-lightning-bolts/blob/master/pl_bolts/models/self_supervised/cpc/networks.py#L103>`_
- `CPCresnet101 <https://github.com/PyTorchLightning/lightning-bolts/blob/master/pl_bolts/models/self_supervised/cpc/networks.py#L103>`_
- Adam
- 3072
- 1000 (upto 21 days)
Expand Down Expand Up @@ -311,8 +311,8 @@ CIFAR-10 baseline
- 1.0/1.5
* - Ours
- 88.50
- `resnet50 <https://github.com/PyTorchLightning/PyTorch-Lightning-Bolts/blob/master/pl_bolts/models/self_supervised/resnets.py#L301-L309>`_
- `LARS-SGD <https://pytorch-lightning-bolts.readthedocs.io/en/latest/api/pl_bolts.optimizers.lars_scheduling.html#pl_bolts.optimizers.lars_scheduling.LARSWrapper>`_
- `resnet50 <https://github.com/PyTorchLightning/lightning-bolts/blob/master/pl_bolts/models/self_supervised/resnets.py#L301-L309>`_
- `LARS-SGD <https://lightning-bolts.readthedocs.io/en/latest/api/pl_bolts.optimizers.lars_scheduling.html#pl_bolts.optimizers.lars_scheduling.LARSWrapper>`_
- 2048
- 800 (4 hours)
- 8 V100 (16GB)
Expand Down Expand Up @@ -400,8 +400,8 @@ Imagenet baseline for SimCLR
- 4.8
* - Ours
- 68.4
- `resnet50 <https://github.com/PyTorchLightning/PyTorch-Lightning-Bolts/blob/master/pl_bolts/models/self_supervised/resnets.py#L301-L309>`_
- `LARS-SGD <https://pytorch-lightning-bolts.readthedocs.io/en/latest/api/pl_bolts.optimizers.lars_scheduling.html#pl_bolts.optimizers.lars_scheduling.LARSWrapper>`_
- `resnet50 <https://github.com/PyTorchLightning/lightning-bolts/blob/master/pl_bolts/models/self_supervised/resnets.py#L301-L309>`_
- `LARS-SGD <https://lightning-bolts.readthedocs.io/en/latest/api/pl_bolts.optimizers.lars_scheduling.html#pl_bolts.optimizers.lars_scheduling.LARSWrapper>`_
- 4096
- 800
- 64 V100 (16GB)
Expand Down Expand Up @@ -533,7 +533,7 @@ The original paper does not provide baselines on STL10.
* - Ours
- `86.72 <https://tensorboard.dev/experiment/w2pq3bPPSxC4VIm5udhA2g/>`_
- SwAV resnet50
- `LARS <https://pytorch-lightning-bolts.readthedocs.io/en/latest/api/pl_bolts.optimizers.lars_scheduling.html#pl_bolts.optimizers.lars_scheduling.LARSWrapper>`_
- `LARS <https://lightning-bolts.readthedocs.io/en/latest/api/pl_bolts.optimizers.lars_scheduling.html#pl_bolts.optimizers.lars_scheduling.LARSWrapper>`_
- 128
- No
- 100 (~9 hr)
Expand Down Expand Up @@ -629,8 +629,8 @@ Imagenet baseline for SwAV
- 4.8
* - Ours
- 74
- `resnet50 <https://github.com/PyTorchLightning/PyTorch-Lightning-Bolts/blob/master/pl_bolts/models/self_supervised/resnets.py#L301-L309>`_
- `LARS-SGD <https://pytorch-lightning-bolts.readthedocs.io/en/latest/api/pl_bolts.optimizers.lars_scheduling.html#pl_bolts.optimizers.lars_scheduling.LARSWrapper>`_
- `resnet50 <https://github.com/PyTorchLightning/lightning-bolts/blob/master/pl_bolts/models/self_supervised/resnets.py#L301-L309>`_
- `LARS-SGD <https://lightning-bolts.readthedocs.io/en/latest/api/pl_bolts.optimizers.lars_scheduling.html#pl_bolts.optimizers.lars_scheduling.LARSWrapper>`_
- 4096
- 800
- 64 V100 (16GB)
Expand Down
2 changes: 1 addition & 1 deletion pl_bolts/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
__author_email__ = '[email protected]'
__license__ = 'Apache-2.0'
__copyright__ = f'Copyright (c) 2020-2021, {__author__}'
__homepage__ = 'https://github.com/PyTorchLightning/pytorch-lightning-bolts'
__homepage__ = 'https://github.com/PyTorchLightning/lightning-bolts'
__docs__ = "PyTorch Lightning Bolts is a community contribution for ML researchers."
__long_doc__ = """
What is it?
Expand Down
2 changes: 1 addition & 1 deletion pl_bolts/setup_tools.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ def _load_readme_description(path_dir: str, homepage: str = __homepage__, ver: s

# readthedocs badge
text = text.replace('badge/?version=stable', f'badge/?version={ver}')
text = text.replace('pytorch-lightning.readthedocs.io/en/stable/', f'pytorch-lightning.readthedocs.io/en/{ver}')
text = text.replace('lightning-bolts.readthedocs.io/en/stable/', f'lightning-bolts.readthedocs.io/en/{ver}')
# codecov badge
text = text.replace('/branch/master/graph/badge.svg', f'/release/{ver}/graph/badge.svg')
# replace github badges for release ones
Expand Down
Loading