Skip to content

Commit

Permalink
Update Readme. Add Discord server. (#127)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
ibro45 authored Jun 24, 2024
1 parent 9aaebf1 commit d9696ed
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 45 deletions.
106 changes: 61 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@

<br/>
<div align="center">
<picture>
<!-- old code that allows different pics for light/dark mode -->
Expand All @@ -9,50 +11,69 @@
</picture>
</div>
<br/>
<br/>
<br/>
<div align="center">

[![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)
[![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)

<a href="https://discord.gg/zJcnp6KrUp">
<img src="https://discord.com/api/guilds/1252251284908539965/widget.png?style=banner2" alt="Lighter Discord Server"/>
</a>
</div>


With `lighter`, focus on your deep learning experiments and forget about boilerplate through:
1. **Task-agnostic** training logic already implemented for you (classification, segmentation, self-supervised, etc.)
2. **Configuration-based** approach that will ensure that you can always reproduce your experiments and know what hyperparameters you used.
3. Extremely **simple integration of custom** models, datasets, transforms, or any other components to your experiments.
&nbsp;


Focus on your deep learning experiments and forget about (re)writing code. `lighter` is:
1. **Task-agnostic**

Whether you’re working on classification, segmentation, or self-supervised learning, `lighter` provides generalized training logic that you can use out-of-the-box.

2. **Configuration-based**

Easily define, track, and reproduce experiments with `lighter`’s configuration-driven approach, keeping all your hyperparameters organized.

3. **Customizable**

Seamlessly integrate your custom models, datasets, or transformations into `lighter`’s flexible framework.

&nbsp;

`lighter` stands on the shoulder of these two giants:
- [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.
- [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.

Simply put, `lighter = config(trainer + system)` 😇


## 📖 Usage

- [📚 Documentation](https://project-lighter.github.io/lighter/)
- [🎥 YouTube Channel](https://www.youtube.com/channel/UCef1oTpv2QEBrD2pZtrdk1Q)

## 🚀 Install
<br/>
<div align="center">Simply put, <code>lighter = config(trainer + system)</code> 😇</div>
<br/>

Current release:
```bash
pip install project-lighter
```
## 📖 Getting Started
<div align="center">
<p style="text-align: center;">
📚 <a href="https://project-lighter.github.io/lighter/"> Documentation</a>&nbsp;&nbsp;&nbsp;
🎥 <a href="https://www.youtube.com/channel/UCef1oTpv2QEBrD2pZtrdk1Q">YouTube Channel</a>&nbsp;&nbsp;&nbsp;
👾 <a href="https://discord.gg/zJcnp6KrUp">Discord Server</a>
</p>
</div>

Pre-release (up-to-date with the main branch):
```bash
pip install project-lighter --pre
```
<b>Install:</b>
<pre><code>pip install project-lighter</code></pre>
<details>
<summary><b>Pre-release (up-to-date with the main branch):</b></summary>
<pre><code>pip install project-lighter --pre</code></pre>
</details>

For development:
```bash
make setup
<details>
<summary><b>For development:</b></summary>
<pre><code>make setup
make install # Install lighter via Poetry
make pre-commit-install # Set up the pre-commit hook for code formatting
poetry shell # Once installed, activate the poetry shell
```
poetry shell # Once installed, activate the poetry shell</code></pre>
</details>
<br/>


## 💡 Projects
Projects that use `lighter`:
Expand All @@ -61,22 +82,17 @@ Projects that use `lighter`:
| --- | --- |
| [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. |

<br/>

## 📄 Cite:

If you find `lighter` useful in your research or project, please consider citing it:

```bibtex
@software{lighter,
author = {Ibrahim Hadzic and
Suraj Pai and
Keno Bressem and
Hugo Aerts},
title = {Lighter},
publisher = {Zenodo},
doi = {10.5281/zenodo.8007711},
url = {https://doi.org/10.5281/zenodo.8007711}
}
```

We appreciate your support!
## Cite
<pre><code>@software{lighter,
author = {Ibrahim Hadzic and
Suraj Pai and
Keno Bressem and
Hugo Aerts},
title = {Lighter},
publisher = {Zenodo},
doi = {10.5281/zenodo.8007711},
url = {https://doi.org/10.5281/zenodo.8007711}
}</code></pre>
</div>
Binary file modified assets/images/lighter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d9696ed

Please sign in to comment.