Skip to content

Commit d7eb1fa

Browse files
Update README
Updated the README to reflect the new name 'LitLogger' and enhanced descriptions of its features and installation instructions.
1 parent 472c497 commit d7eb1fa

1 file changed

Lines changed: 26 additions & 24 deletions

File tree

README.md

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,40 @@
11
<div align="center">
22

3-
# Lightning Logger
3+
# LitLogger
44

5-
**Log your metrics from anywhere and view them on Lightning.AI**
5+
**Log, track, compare, and share AI model experiments**
66

7-
✅ fast ✅ cloud persistent ✅ accessible from everywhere ✅ easy to share ✅ easy to use
7+
<pre>
8+
✅ Any Python code ✅ Zero-setup ✅ Cloud or on-prem
9+
✅ Fine-grain controls ✅ Training, inference ✅ Free tier
10+
</pre>
811

912
______________________________________________________________________
1013

1114
<p align="center">
12-
<a href="https://lightning.ai/">Lightning AI</a> •
13-
<a href="https://lightning.ai/docs">Docs</a> •
14-
<a href="#quick-start">Quick start</a>
15+
<a href="#quick-start">Quick start</a> •
16+
<a href="https://lightning.ai/docs/overview/experiment-management">Docs</a>
1517
</p>
1618

1719
</div>
1820

19-
# Log & view your metrics on Lightning.AI
21+
# Why LitLogger?
22+
Reproducible model building is hard. As teams iterate on models, data, or prompts, it quickly becomes difficult to track what changed and why results improved or regressed. LitLogger automatically keeps a complete history of every run, including inputs, metrics, and model outputs, so teams can trace changes, compare results, and audit decisions over time instead of re-running everything from scratch.
2023

21-
The Lightning Logger is a python library to log your metrics to the Lightning.AI platform.
24+
LitLogger is free for developers and built into [Lightning AI](https://lightning.ai/), an independent platform trusted by enterprises. It runs in the cloud or fully on-prem, giving teams long-term stability, clear auditability, and control over their experiment history.
2225

23-
### Install Lightning Logger
26+
<img width="2323" height="1072" alt="image" src="https://github.com/user-attachments/assets/669e8f8e-9d68-473d-8625-6f80d7733cba" />
27+
28+
# Quick start
2429

2530
Install Lightning Logger with pip.
2631

2732
```bash
2833
pip install litlogger
2934
```
3035

31-
### Quick start
32-
33-
Once installed, you can dive right in with our quick start guide. This example shows how to log metadata and metrics using the standalone API.
34-
It's designed to be simple enough for beginners yet robust enough to handle more advanced use cases.
36+
### Hello world example
37+
LitLogger works with any Python code, not just model training. Use it with PyTorch, vLLM, LangChain, custom scripts, batch jobs, or live services to track metrics and results consistently.
3538

3639
```python
3740
import litlogger
@@ -64,10 +67,8 @@ litlogger.log_file("/path/to/config.txt")
6467
litlogger.finalize()
6568
```
6669

67-
### Lightning AI Boring Model
68-
69-
Integrate Lightning Logger into your model training process with ease.
70-
The example below extends a basic model to log both training and validation metrics, giving you clear insights into model performance with every step.
70+
### PyTorch Lightning example
71+
PyTorch Lightning now comes with LitLogger natively built in. It's also built by the PyTorch Lightning team for guaranteed fast performance at 10,000+ GPU scale.
7172

7273
```python
7374
from lightning import Trainer
@@ -92,11 +93,8 @@ trainer = Trainer(max_epochs=10, logger=LightningLogger(), log_every_n_steps=10)
9293
trainer.fit(LoggingBoringModel(), BoringDataModule())
9394
```
9495

95-
### Loss simulator
96-
97-
This detailed example illustrates how to simulate a changing loss value during training.
98-
It logs metric updates at intervals, so you can see how your loss fluctuates over time.
99-
This practical demonstration shows you the flexibility of Lightning Logger in handling real-world training scenarios.
96+
### Example 3: loss simulator
97+
This is a fun example that simulates a long model training run.
10098

10199
<details>
102100
<summary>Python code</summary>
@@ -151,5 +149,9 @@ litlogger.finalize()
151149

152150
</details>
153151

154-
Enjoy exploring Lightning Logger and watch your project's metrics come to life on [lightning.ai](lightning.ai)!
155-
This library is designed to simplify your workflow while providing you with clear, insightful data that drives smarter decisions in your development process.
152+
# Community
153+
LitLogger is a community project accepting contributions - Let's make the world's most advanced AI experiment manager.
154+
155+
💬 [Get help on Discord](https://discord.com/invite/XncpTy7DSt)
156+
📋 [License: Apache 2.0](https://github.com/Lightning-AI/litlogger/blob/main/LICENSE)
157+

0 commit comments

Comments
 (0)