Skip to content

Commit d9696ed

Browse files
authored
Update Readme. Add Discord server. (#127)
* Update README text, add Discord server * Change tables to divs because GitHub does not allow removing table borders * Switch from tables to divs * Try fixing the paragraph not centered on github * Remove discord and cite titles, add new tab links * Remove _blank target for links as it does not work on github. Remove unneeded div. * Try styling pre * Crop logo vertically, move discord banner * Update style * Update summary * Update lighter summary * Exclude emojis from links
1 parent 9aaebf1 commit d9696ed

File tree

2 files changed

+61
-45
lines changed

2 files changed

+61
-45
lines changed

README.md

+61-45
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
2+
<br/>
13
<div align="center">
24
<picture>
35
<!-- old code that allows different pics for light/dark mode -->
@@ -9,50 +11,69 @@
911
</picture>
1012
</div>
1113
<br/>
14+
<br/>
15+
<br/>
1216
<div align="center">
1317

14-
[![build](https://github.com/project-lighter/lighter/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/project-lighter/lighter/actions/workflows/build.yml) ![Coverage](./assets/images/coverage.svg) [![GitHub license](https://img.shields.io/github/license/project-lighter/lighter)](https://github.com/project-lighter/lighter/blob/main/LICENSE)
18+
[![build](https://github.com/project-lighter/lighter/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/project-lighter/lighter/actions/workflows/build.yml) ![Coverage](./assets/images/coverage.svg) [![GitHub license](https://img.shields.io/github/license/project-lighter/lighter)](https://github.com/project-lighter/lighter/blob/main/LICENSE)
19+
20+
<a href="https://discord.gg/zJcnp6KrUp">
21+
<img src="https://discord.com/api/guilds/1252251284908539965/widget.png?style=banner2" alt="Lighter Discord Server"/>
22+
</a>
1523
</div>
1624

1725

18-
With `lighter`, focus on your deep learning experiments and forget about boilerplate through:
19-
1. **Task-agnostic** training logic already implemented for you (classification, segmentation, self-supervised, etc.)
20-
2. **Configuration-based** approach that will ensure that you can always reproduce your experiments and know what hyperparameters you used.
21-
3. Extremely **simple integration of custom** models, datasets, transforms, or any other components to your experiments.
26+
&nbsp;
27+
28+
29+
Focus on your deep learning experiments and forget about (re)writing code. `lighter` is:
30+
1. **Task-agnostic**
31+
32+
Whether you’re working on classification, segmentation, or self-supervised learning, `lighter` provides generalized training logic that you can use out-of-the-box.
33+
34+
2. **Configuration-based**
35+
36+
Easily define, track, and reproduce experiments with `lighter`’s configuration-driven approach, keeping all your hyperparameters organized.
37+
38+
3. **Customizable**
39+
40+
Seamlessly integrate your custom models, datasets, or transformations into `lighter`’s flexible framework.
2241

2342
&nbsp;
2443

2544
`lighter` stands on the shoulder of these two giants:
2645
- [MONAI Bundle](https://docs.monai.io/en/stable/bundle_intro.html) - Configuration system. Similar to [Hydra](https://github.com/facebookresearch/hydra), but with additional features.
2746
- [PyTorch Lightning](https://github.com/Lightning-AI/lightning) - Our [`LighterSystem`](https://project-lighter.github.io/lighter/reference/system/) is based on the PyTorch Lightning [`LightningModule`](https://lightning.ai/docs/pytorch/stable/common/lightning_module.html) and implements all the necessary training logic for you. Couple it with the PyTorch Lightning [Trainer](https://lightning.ai/docs/pytorch/stable/common/trainer.html) and you're good to go.
28-
29-
Simply put, `lighter = config(trainer + system)` 😇
30-
3147

32-
## 📖 Usage
33-
34-
- [📚 Documentation](https://project-lighter.github.io/lighter/)
35-
- [🎥 YouTube Channel](https://www.youtube.com/channel/UCef1oTpv2QEBrD2pZtrdk1Q)
36-
37-
## 🚀 Install
48+
<br/>
49+
<div align="center">Simply put, <code>lighter = config(trainer + system)</code> 😇</div>
50+
<br/>
3851

39-
Current release:
40-
```bash
41-
pip install project-lighter
42-
```
52+
## 📖 Getting Started
53+
<div align="center">
54+
<p style="text-align: center;">
55+
📚 <a href="https://project-lighter.github.io/lighter/"> Documentation</a>&nbsp;&nbsp;&nbsp;
56+
🎥 <a href="https://www.youtube.com/channel/UCef1oTpv2QEBrD2pZtrdk1Q">YouTube Channel</a>&nbsp;&nbsp;&nbsp;
57+
👾 <a href="https://discord.gg/zJcnp6KrUp">Discord Server</a>
58+
</p>
59+
</div>
4360

44-
Pre-release (up-to-date with the main branch):
45-
```bash
46-
pip install project-lighter --pre
47-
```
61+
<b>Install:</b>
62+
<pre><code>pip install project-lighter</code></pre>
63+
<details>
64+
<summary><b>Pre-release (up-to-date with the main branch):</b></summary>
65+
<pre><code>pip install project-lighter --pre</code></pre>
66+
</details>
4867

49-
For development:
50-
```bash
51-
make setup
68+
<details>
69+
<summary><b>For development:</b></summary>
70+
<pre><code>make setup
5271
make install # Install lighter via Poetry
5372
make pre-commit-install # Set up the pre-commit hook for code formatting
54-
poetry shell # Once installed, activate the poetry shell
55-
```
73+
poetry shell # Once installed, activate the poetry shell</code></pre>
74+
</details>
75+
<br/>
76+
5677

5778
## 💡 Projects
5879
Projects that use `lighter`:
@@ -61,22 +82,17 @@ Projects that use `lighter`:
6182
| --- | --- |
6283
| [Foundation Models for Quantitative Imaging Biomarker Discovery in Cancer Imaging](https://aim.hms.harvard.edu/foundation-cancer-image-biomarker) | A foundation model for lesions on CT scans that can be applied to down-stream tasks related to tumor radiomics, nodule classification, etc. |
6384

85+
<br/>
6486

65-
## 📄 Cite:
66-
67-
If you find `lighter` useful in your research or project, please consider citing it:
68-
69-
```bibtex
70-
@software{lighter,
71-
author = {Ibrahim Hadzic and
72-
Suraj Pai and
73-
Keno Bressem and
74-
Hugo Aerts},
75-
title = {Lighter},
76-
publisher = {Zenodo},
77-
doi = {10.5281/zenodo.8007711},
78-
url = {https://doi.org/10.5281/zenodo.8007711}
79-
}
80-
```
81-
82-
We appreciate your support!
87+
## Cite
88+
<pre><code>@software{lighter,
89+
author = {Ibrahim Hadzic and
90+
Suraj Pai and
91+
Keno Bressem and
92+
Hugo Aerts},
93+
title = {Lighter},
94+
publisher = {Zenodo},
95+
doi = {10.5281/zenodo.8007711},
96+
url = {https://doi.org/10.5281/zenodo.8007711}
97+
}</code></pre>
98+
</div>

assets/images/lighter.png

-2.67 KB
Loading

0 commit comments

Comments
 (0)