Update README.md
Browse files
README.md
CHANGED
|
@@ -1,21 +1,65 @@
|
|
| 1 |
---
|
| 2 |
-
title:
|
| 3 |
-
emoji:
|
| 4 |
colorFrom: purple
|
| 5 |
colorTo: blue
|
| 6 |
sdk: static
|
| 7 |
pinned: false
|
| 8 |
---
|
| 9 |
|
| 10 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 11 |
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 18 |
|
| 19 |
-
EasyDeL
|
| 20 |
|
| 21 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: EasyDeL
|
| 3 |
+
emoji: 🔮
|
| 4 |
colorFrom: purple
|
| 5 |
colorTo: blue
|
| 6 |
sdk: static
|
| 7 |
pinned: false
|
| 8 |
---
|
| 9 |
|
| 10 |
+
<p align="center">
|
| 11 |
+
<a href="https://github.com/erfanzar/EasyDeL">
|
| 12 |
+
<img src="https://raw.githubusercontent.com/erfanzar/easydel/main/images/easydel-logo-with-text.png" height="80" alt="EasyDeL" />
|
| 13 |
+
</a>
|
| 14 |
+
</p>
|
| 15 |
|
| 16 |
+
<p align="center">
|
| 17 |
+
<a href="https://github.com/erfanzar/EasyDeL">
|
| 18 |
+
<img src="https://img.shields.io/badge/GitHub-erfanzar%2FEasyDeL-111?logo=github&style=flat-square" alt="GitHub" />
|
| 19 |
+
</a>
|
| 20 |
+
<a href="https://pypi.org/project/easydel/">
|
| 21 |
+
<img src="https://img.shields.io/pypi/v/easydel?style=flat-square" alt="PyPI" />
|
| 22 |
+
</a>
|
| 23 |
+
<a href="https://easydel.readthedocs.io/en/latest/">
|
| 24 |
+
<img src="https://img.shields.io/badge/Docs-ReadTheDocs-1f72ff?logo=readthedocs&style=flat-square" alt="Docs" />
|
| 25 |
+
</a>
|
| 26 |
+
<a href="https://discord.gg/FCAMNqnGtt">
|
| 27 |
+
<img src="https://img.shields.io/badge/Discord-Join-5865F2?logo=discord&style=flat-square" alt="Discord" />
|
| 28 |
+
</a>
|
| 29 |
+
</p>
|
| 30 |
|
| 31 |
+
# EasyDeL
|
| 32 |
|
| 33 |
+
EasyDeL is an open-source framework for building, training, fine-tuning, converting, and serving modern ML models in **JAX** at scale. It is designed for people who want **the performance benefits of JAX** without giving up the **practical ergonomics** of the Hugging Face ecosystem.
|
| 34 |
+
|
| 35 |
+
## Purpose
|
| 36 |
+
|
| 37 |
+
JAX is extremely powerful, but scaling real training/inference workloads can still feel fragmented: model code, sharding, kernels, training loops, serving, and conversions often live in separate places. EasyDeL’s goal is to provide a cohesive toolkit where these pieces work together—while still staying readable and hackable.
|
| 38 |
+
|
| 39 |
+
## What EasyDeL focuses on
|
| 40 |
+
|
| 41 |
+
- **Scale-first**: multi-device training/inference across GPU/TPU with sharding-aware utilities.
|
| 42 |
+
- **Production inference**: a dedicated serving stack built for throughput and low latency.
|
| 43 |
+
- **Interoperability**: straightforward workflows with Hugging Face models and assets.
|
| 44 |
+
- **Hackability**: implementations you can actually read, debug, and modify.
|
| 45 |
+
|
| 46 |
+
## Core components
|
| 47 |
+
|
| 48 |
+
- **Model library (70+ architectures)**: text models, vision-language models, speech models (Whisper), and more.
|
| 49 |
+
- **Training & fine-tuning**: supervised fine-tuning plus multiple alignment paradigms (preference optimization and RL-style training), and distillation workflows.
|
| 50 |
+
- **eSurge (serving engine)**: continuous batching, paged KV cache, and OpenAI-compatible APIs (plus multimodal endpoints where applicable).
|
| 51 |
+
- **eLargeModel (ELM)**: a configuration-driven interface for end-to-end workflows (load → shard → train → evaluate → serve).
|
| 52 |
+
- **Conversion utilities**: convert PyTorch checkpoints to EasyDeL checkpoints, and generate model cards/metadata during export.
|
| 53 |
+
|
| 54 |
+
## Where it fits
|
| 55 |
+
|
| 56 |
+
EasyDeL is a good fit if you:
|
| 57 |
+
|
| 58 |
+
- want to train or serve large models on JAX with real sharding strategies,
|
| 59 |
+
- need a unified training + serving stack rather than a pile of scripts,
|
| 60 |
+
- care about performance but also want to iterate quickly and customize internals,
|
| 61 |
+
- want compatibility with common Hugging Face assets and workflows.
|
| 62 |
+
|
| 63 |
+
## License
|
| 64 |
+
|
| 65 |
+
EasyDeL is released under the Apache-2.0 license.
|