File size: 6,477 Bytes
25ff30c e7b5bdc 25ff30c |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
---
language:
- en
library_name: transformers
license: cc-by-4.0
tags:
- kl3m
- kl3m-002
- legal
- financial
- enterprise
- slm
date: '2024-02-20T00:00:00.000Z'
pipeline_tag: text-generation
widget:
- text: "Medical devices are regulated by"
- temperature: 0.3
- do_sample: True
---
# kl3m-170m Model
kl3m-170m is a (very) small language model (SLM) model trained on clean, legally-permissible data. Originally
developed by [273 Ventures](https://273ventures.com) and donated to the [ALEA Institute](https://aleainstitute.ai),
kl3m-170m was the first LLM to obtain the [Fairly Trained L-Certification](https://www.fairlytrained.org/certifications)
for its ethical training data and practices. The model is designed for legal, regulatory, and financial workflows,
with a focus on low toxicity and high efficiency.
Given its small size and lack of instruction-aligned training data, kl3m-170m is best suited for use either in
SLM fine-tuning or as part of training larger models without using unethical data or models.
The model was originally trained between November 2023 and January 2024 on a 12xRTX4090 node in DDP. A similar model is
being provided with complete source and data replication as part of the `kl3m-004` family to be released in Q4 2024.
## Source
[https://github.com/alea-institute/kl3m-model-research](https://github.com/alea-institute/kl3m-model-research)
## Training Data
While the original training data collection and training infrastructure relies on software that was not donated by
273 Ventures, ALEA Institute is open-sourcing an improved dataset, including both replication and an API.
[https://github.com/alea-institute/kl3m-data](https://github.com/alea-institute/kl3m-data)
Data is available upon request at this time via S3 under a Requester Pays model. We are actively working on a
zero-cost distribution model as soon as we can obtain additional support.
This model, the original `kl3m-002-170m` model, was trained on a US-only subset of the Kelvin Legal DataPack that
we believe is 100% public domain material. However, so as to enforce maximum transparency to all
downstream users in the event of any future determination otherwise, we are licensing this model under CC-BY 4.0.
## Model Details
### Summary
- **Architecture**: GPT-NeoX (i.e., ~GPT-3 architecture)
- **Parameters**: 170 million
- **Context Window**: 4,096 tokens (true size, no sliding window)
- **Language(s)**: Primarily English
- **Tokenizer**: kl3m-001-32k BPE tokenizer (32,768 vocabulary size with unorthodox whitespace handling)
- **Developed by**: Originally by [273 Ventures LLC](https://273ventures.com), donated to [ALEA Institute](https://aleainstitute.ai)
- **License**: [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/)
- **Hardware Requirements**: Runs real-time in fp32 on MacBook Air M1
## Performance Metrics
### Perplexity Scores
| Dataset | Score |
|---------------|--------|
| Wiki | 19.58 |
| CNN/Daily Mail| 11.20 |
| Legal Domain | 2.31 |
The model demonstrates particularly strong per-parameter performance on legal domain content, outperforming many
larger models as of its training data.
## Key Features
- **Clean Training Data**: Built on what was originally referred to as the Kelvin Legal DataPack, ensuring all training data is ethically sourced and legally permissible.
- **Low Toxicity**: [Empirically lower toxicity and bias](https://github.com/alea-institute/kl3m-toxicity)
- **Enterprise Focus**: Specifically designed for legal, regulatory, and financial workflows.
- **Efficient Deployment**: Optimized for real-time inference on consumer hardware.
## Use Cases
- Basic regulatory question answering
- Contract provision drafting
- Structured JSON information extraction
- Foundation for downstream optimization
- Base model for domain-specific fine-tuning
## Getting Started
```python
import json
from transformers import pipeline
# Load the model and tokenizer
p = pipeline('text-generation', 'alea-institute/kl3m-002-170m', device='cpu')
# Example usage on CPU
text = "Under this"
print(
json.dumps(
[
r.get("generated_text")
for r in p(text, do_sample=True, temperature=0.5, num_return_sequences=3, max_new_tokens=32)
],
indent=2
)
)
```
```json
[
"Under this proposed rule, the Federal agency must determine the effect on State, local, and",
"Under this proposed rule, we are proposing to amend the definition of \u201ccovered product\u201d in ",
"Under this proposed rule, the FAA is considering issuing this proposed rule after evaluating the information"
]
```
## Contract Example
```python
text = "Governing Law.\n"
print(
json.dumps(
[
r.get("generated_text")
for r in p(text, do_sample=True, temperature=0.3, num_return_sequences=3, max_new_tokens=32)
],
indent=2
)
)
```
```json
[
"Governing Law.\n The provisions of the Plan shall be construed and enforced in accordance with",
"Governing Law.\n The laws of the State of Delaware shall govern the validity, construction, and",
"Governing Law.\n The laws of the State of New York shall govern the validity, construction, enforcement"
]
```
## Technical Implementation
The model implements several techniques during training:
- Hybrid NTP and SFT cotraining
- Dynamic, document-aware segmentation
- Randomized padding
- Traditional fixed- attention mechanisms
## License
This model was originally developed by 273 Ventures and has been donated to the ALEA Institute.
The model weights are released under the CC-BY 4.0 License.
## Contact
The KL3M model family is now maintained by the [ALEA Institute](https://aleainstitute.ai). For technical support, collaboration opportunities, or general inquiries:
- GitHub: https://github.com/alea-institute/kl3m-model-research
- Email: [email protected]
- Website: https://aleainstitute.ai
## Acknowledgments
Special thanks to 273 Ventures for developing and donating this model to the open-source community through the Alea Institute.
## Citation
Tokenizer, dataset, and model publications are pending.
## Contact
For any questions, please contact [ALEA Institute](https://aleainstitute.ai) at [[email protected]](mailto:[email protected]) or
create an issue on this repository or [GitHub](https://github.com/alea-institute/kl3m-model-research).
![logo](https://aleainstitute.ai/images/alea-logo-ascii-1x1.png) |