Skip to content

Commit 844b0e6

Browse files
authored
update readme with clarity (#88)
1 parent 3183ae3 commit 844b0e6

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -242,9 +242,9 @@ trainer.fit(
242242
<details>
243243
<summary>Save any Python class as a checkpoint</summary>
244244

245-
Why is this useful???
245+
Mixin classes streamline model management in Python by modularizing reusable functionalities like saving/loading, enabling consistent, conflict-free, and maintainable code across multiple models.
246246

247-
Save model:
247+
**Save model:**
248248

249249
```python
250250
from litmodels.integrations.mixins import PickleRegistryMixin
@@ -274,7 +274,8 @@ loaded_model = MyModel.download_model(name="my-org/my-team/my-model")
274274
<details>
275275
<summary>Save custom PyTorch models</summary>
276276

277-
why is this useful? why do i need this?
277+
Mixin classes centralize serialization logic, eliminating redundant code and ensuring consistent, error-free model persistence across projects.
278+
The `download_model` method bypasses constructor arguments entirely, reconstructing the model directly from the registry with pre-configured architecture and weights, eliminating initialization mismatches.
278279

279280
Save model:
280281

@@ -310,7 +311,9 @@ loaded_model = MyTorchModel.download_model(name="my-org/my-team/torch-model")
310311

311312
# Performance
312313

314+
<!--
313315
TODO: show the chart between not using this vs using this and the impact on training (the GPU utilization side-by-side)... also, what are tangible speed ups in training and inference.
316+
-->
314317

315318
# Community
316319

0 commit comments

Comments
 (0)