Skip to content
This repository was archived by the owner on Jan 20, 2026. It is now read-only.

Commit 3de17c0

Browse files
BordaBorda
authored
Refactor: shorten bolts name (#583)
* shorter name * shorter name * . * rename * ci
1 parent 79d4184 commit 3de17c0

File tree

16 files changed

+141
-141
lines changed

16 files changed

+141
-141
lines changed

‎.github/CONTRIBUTING.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Tests are written using [pytest](https://docs.pytest.org/en/stable/). Tests in P
9191

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

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

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

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

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

121-
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...).
121+
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...).
122122

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

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ Fixes # (issue)
1010

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

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

‎.github/workflows/ci_test-base.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ jobs:
9191
# see: https://github.com/actions/toolkit/issues/399
9292
continue-on-error: true
9393
with:
94-
token: ${{ secrets.CODECOV_TOKEN }}
94+
# token: ${{ secrets.CODECOV_TOKEN }}
9595
file: coverage.xml
9696
flags: cpu,pytest
9797
name: Base-coverage

‎.github/workflows/ci_test-full.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ jobs:
100100
# see: https://github.com/actions/toolkit/issues/399
101101
continue-on-error: true
102102
with:
103-
token: ${{ secrets.CODECOV_TOKEN }}
103+
# token: ${{ secrets.CODECOV_TOKEN }}
104104
file: ./coverage.xml
105105
flags: unittests
106106
env_vars: OS,PYTHON

‎CHANGELOG.md‎

Lines changed: 83 additions & 83 deletions
Large diffs are not rendered by default.

‎README.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,22 @@
1010
<a href="https://www.pytorchlightning.ai/">Website</a> •
1111
<a href="#install">Installation</a> •
1212
<a href="#main-Goals-of-Bolts">Main goals</a> •
13-
<a href="https://pytorch-lightning-bolts.readthedocs.io/en/latest/">latest Docs</a> •
14-
<a href="https://pytorch-lightning-bolts.readthedocs.io/en/stable/">stable Docs</a> •
13+
<a href="https://lightning-bolts.readthedocs.io/en/latest/">latest Docs</a> •
14+
<a href="https://lightning-bolts.readthedocs.io/en/stable/">stable Docs</a> •
1515
<a href="#team">Community</a> •
1616
<a href="https://www.grid.ai/">Grid AI</a> •
1717
<a href="#licence">Licence</a>
1818
</p>
1919

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

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

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

4040
<center>
4141

42-
| System / PyTorch ver. | 1.6 (min. req.) | 1.7 (latest) |
42+
| System / PyTorch ver. | 1.6 (min. req.) | 1.8 (latest) |
4343
| :---: | :---: | :---: |
44-
| 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) |
45-
| 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) |
46-
| 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) |
44+
| 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) |
45+
| 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) |
46+
| 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) |
4747

4848
</center>
4949

@@ -53,17 +53,17 @@
5353

5454
Simple installation from PyPI
5555
```bash
56-
pip install pytorch-lightning-bolts
56+
pip install lightning-bolts
5757
```
5858

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

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

6969
## What is Bolts

‎docs/source/_templates/theme_variables.jinja‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
{%- set external_urls = {
2-
'github': 'https://github.com/PytorchLightning/pytorch-lightning-bolts',
3-
'github_issues': 'https://github.com/PytorchLightning/pytorch-lightning-bolts/issues',
4-
'contributing': 'https://github.com/PytorchLightning/pytorch-lightning/blob/master/CONTRIBUTING.md',
2+
'github': 'https://github.com/PytorchLightning/lightning-bolts',
3+
'github_issues': 'https://github.com/PytorchLightning/lightning-bolts/issues',
4+
'contributing': 'https://github.com/PytorchLightning/lightning-bolts/blob/master/CONTRIBUTING.md',
55
'governance': 'https://github.com/PytorchLightning/pytorch-lightning/blob/master/governance.md',
6-
'docs': 'https://pytorch-lightning-bolts.rtfd.io/en/latest',
6+
'docs': 'https://lightning-bolts.rtfd.io/en/latest',
77
'twitter': 'https://twitter.com/PyTorchLightnin',
88
'discuss': 'https://pytorch-lightning.slack.com',
99
'tutorials': 'https://pytorch-lightning.readthedocs.io/en/latest/#tutorials',
10-
'previous_pytorch_versions': 'https://pytorch-lightning.rtfd.io/en/latest/',
11-
'home': 'https://pytorch-lightning.rtfd.io/en/latest/',
10+
'previous_pytorch_versions': 'https://pytorch.rtfd.io/en/latest/',
11+
'home': 'https://lightning-bolts.rtfd.io/en/latest/',
1212
'get_started': 'https://pytorch-lightning.readthedocs.io/en/latest/introduction_guide.html',
13-
'features': 'https://pytorch-lightning.rtfd.io/en/latest/',
13+
'features': 'https://lightning-bolts.rtfd.io/en/latest/',
1414
'blog': 'https://www.pytorchlightning.ai/blog',
1515
'resources': 'https://pytorch-lightning.readthedocs.io/en/latest/#community-examples',
16-
'support': 'https://pytorch-lightning.rtfd.io/en/latest/',
16+
'support': 'https://lightning-bolts.rtfd.io/en/latest/',
1717
}
1818
-%}

‎docs/source/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
# -- Project information -----------------------------------------------------
3737

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

‎docs/source/index.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
PyTorch-Lightning-Bolts documentation
7-
=====================================
6+
Lightning-Bolts documentation
7+
=============================
88
.. toctree::
99
:maxdepth: 1
1010
:name: start

‎docs/source/installation.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
Installation
22
============
33

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

66
.. code-block:: bash
77
8-
pip install pytorch-lightning-bolts
8+
pip install lightning-bolts
99
1010
Install bleeding-edge (no guarantees)
1111

1212
.. code-block:: bash
1313
14-
pip install git+https://github.com/PytorchLightning/pytorch-lightning-bolts.git@master --upgrade
14+
pip install git+https://github.com/PytorchLightning/lightning-bolts.git@master --upgrade
1515
1616
In case you want to have full experience you can install all optional packages at once
1717

1818
.. code-block:: bash
1919
20-
pip install pytorch-lightning-bolts["extra"]
20+
pip install lightning-bolts["extra"]
2121

0 commit comments

Comments
 (0)