Update README.md
Browse files
README.md
CHANGED
|
@@ -11,18 +11,26 @@ _Model:_ ELM introduces a new type of _(de)-composable LLM model architecture_ a
|
|
| 11 |
|
| 12 |
_Fast Inference with Customization:_ Once trained, the ELM model architecture permits flexible inference strategies at runtime depending on the deployment needs. For instance, the ELM model can be _decomposed_ into smaller slices, i.e., smaller (or larger) models can be extracted from the original model to create multiple inference endpoints. Alternatively, the original (single) ELM model can be loaded _as is_ for inference and different slices within the model can be queried directly to power faster inference. This provides an additional level of flexibility for users to make compute/memory tradeoffs depending on their application and runtime needs.
|
| 13 |
|
| 14 |
-
##
|
| 15 |
-
Models are located in the
|
| 16 |
- news_classification
|
| 17 |
- toxicity_detection
|
| 18 |
- news_content_generation
|
| 19 |
- news_summarization
|
| 20 |
|
|
|
|
|
|
|
| 21 |
```bash
|
| 22 |
git clone [email protected]:slicexai/elm-v0.1
|
| 23 |
sudo apt-get intall git-lfs
|
| 24 |
git lfs install
|
| 25 |
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 26 |
(Optional) Installing git-lfs without sudo,
|
| 27 |
```bash
|
| 28 |
wget https://github.com/git-lfs/git-lfs/releases/download/v3.2.0/git-lfs-linux-amd64-v3.2.0.tar.gz
|
|
@@ -35,7 +43,6 @@ git lfs install
|
|
| 35 |
|
| 36 |
Download elm-1.0 model checkpoints
|
| 37 |
```bash
|
| 38 |
-
cd elm-v0.1
|
| 39 |
git lfs pull -I models/elm-1.0_news_classification/ckpt.pt
|
| 40 |
git lfs pull -I models/elm-1.0_toxicity_detection/ckpt.pt
|
| 41 |
git lfs pull -I models/elm-1.0_news_content_generation/ckpt.pt
|
|
@@ -44,7 +51,6 @@ git lfs pull -I models/elm-1.0_news_summarization/ckpt.pt
|
|
| 44 |
|
| 45 |
Download elm-0.75 model checkpoints
|
| 46 |
```bash
|
| 47 |
-
cd elm-v0.1
|
| 48 |
git lfs pull -I models/elm-0.75_news_classification/ckpt.pt
|
| 49 |
git lfs pull -I models/elm-0.75_toxicity_detection/ckpt.pt
|
| 50 |
git lfs pull -I models/elm-0.75_news_content_generation/ckpt.pt
|
|
@@ -53,17 +59,13 @@ git lfs pull -I models/elm-0.75_news_summarization/ckpt.pt
|
|
| 53 |
|
| 54 |
Download elm-0.25 model checkpoints
|
| 55 |
```bash
|
| 56 |
-
cd elm-v0.1
|
| 57 |
git lfs pull -I models/elm-0.25_news_classification/ckpt.pt
|
| 58 |
git lfs pull -I models/elm-0.25_toxicity_detection/ckpt.pt
|
| 59 |
git lfs pull -I models/elm-0.25_news_content_generation/ckpt.pt
|
| 60 |
```
|
| 61 |
|
| 62 |
|
| 63 |
-
|
| 64 |
-
```bash
|
| 65 |
-
pip install -r requirements.txt
|
| 66 |
-
```
|
| 67 |
|
| 68 |
## How to use - Run ELM on a sample task (e.g., news classification)
|
| 69 |
```bash
|
|
|
|
| 11 |
|
| 12 |
_Fast Inference with Customization:_ Once trained, the ELM model architecture permits flexible inference strategies at runtime depending on the deployment needs. For instance, the ELM model can be _decomposed_ into smaller slices, i.e., smaller (or larger) models can be extracted from the original model to create multiple inference endpoints. Alternatively, the original (single) ELM model can be loaded _as is_ for inference and different slices within the model can be queried directly to power faster inference. This provides an additional level of flexibility for users to make compute/memory tradeoffs depending on their application and runtime needs.
|
| 13 |
|
| 14 |
+
## ELM-v0.1 Model Release
|
| 15 |
+
Models are located in the `models` folder. ELM models in this repository comes in three sizes (elm-1.0, elm-0.75 and elm-0.25) and supports the following use-cases.
|
| 16 |
- news_classification
|
| 17 |
- toxicity_detection
|
| 18 |
- news_content_generation
|
| 19 |
- news_summarization
|
| 20 |
|
| 21 |
+
## Setup ELM
|
| 22 |
+
### Download ELM repo with model files
|
| 23 |
```bash
|
| 24 |
git clone [email protected]:slicexai/elm-v0.1
|
| 25 |
sudo apt-get intall git-lfs
|
| 26 |
git lfs install
|
| 27 |
```
|
| 28 |
+
### Installation
|
| 29 |
+
```bash
|
| 30 |
+
cd elm-v0.1
|
| 31 |
+
pip install -r requirements.txt
|
| 32 |
+
```
|
| 33 |
+
|
| 34 |
(Optional) Installing git-lfs without sudo,
|
| 35 |
```bash
|
| 36 |
wget https://github.com/git-lfs/git-lfs/releases/download/v3.2.0/git-lfs-linux-amd64-v3.2.0.tar.gz
|
|
|
|
| 43 |
|
| 44 |
Download elm-1.0 model checkpoints
|
| 45 |
```bash
|
|
|
|
| 46 |
git lfs pull -I models/elm-1.0_news_classification/ckpt.pt
|
| 47 |
git lfs pull -I models/elm-1.0_toxicity_detection/ckpt.pt
|
| 48 |
git lfs pull -I models/elm-1.0_news_content_generation/ckpt.pt
|
|
|
|
| 51 |
|
| 52 |
Download elm-0.75 model checkpoints
|
| 53 |
```bash
|
|
|
|
| 54 |
git lfs pull -I models/elm-0.75_news_classification/ckpt.pt
|
| 55 |
git lfs pull -I models/elm-0.75_toxicity_detection/ckpt.pt
|
| 56 |
git lfs pull -I models/elm-0.75_news_content_generation/ckpt.pt
|
|
|
|
| 59 |
|
| 60 |
Download elm-0.25 model checkpoints
|
| 61 |
```bash
|
|
|
|
| 62 |
git lfs pull -I models/elm-0.25_news_classification/ckpt.pt
|
| 63 |
git lfs pull -I models/elm-0.25_toxicity_detection/ckpt.pt
|
| 64 |
git lfs pull -I models/elm-0.25_news_content_generation/ckpt.pt
|
| 65 |
```
|
| 66 |
|
| 67 |
|
| 68 |
+
|
|
|
|
|
|
|
|
|
|
| 69 |
|
| 70 |
## How to use - Run ELM on a sample task (e.g., news classification)
|
| 71 |
```bash
|