Metadata-Version: 2.4
Name: arclm
Version: 0.1.0
Summary: A compact PyTorch language-model training and fine-tuning library.
Home-page: https://github.com/Ahmad-Al-Dibo/arclm
Author: ArcLM Contributors
Author-email: 1482072@student.rocvantwente.nl
License-Expression: MIT
Project-URL: Homepage, https://github.com/Ahmad-Al-Dibo/ArcLM
Project-URL: Documentation, https://github.com/Ahmad-Al-Dibo/ArcLM#readme
Project-URL: Source, https://github.com/Ahmad-Al-Dibo/ArcLM
Project-URL: Issues, https://github.com/Ahmad-Al-Dibo/ArcLM/issues
Keywords: language-model,transformer,pytorch,training,fine-tuning,nlp
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: torch>=2.1
Requires-Dist: numpy>=1.24
Requires-Dist: sentencepiece>=0.2.0
Requires-Dist: transformers>=4.38
Provides-Extra: dev
Requires-Dist: pytest>=8; extra == "dev"
Requires-Dist: build>=1.2; extra == "dev"
Requires-Dist: twine>=5; extra == "dev"
Provides-Extra: web
Requires-Dist: flask>=3; extra == "web"
Dynamic: author-email
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# ArcLM

ArcLM is a lightweight PyTorch library for training, fine-tuning, and generating text with compact causal language models.

It is designed for learning, experimentation, research, and local AI workflows.

## Features

* Train compact causal language models from your own text
* Generate text with a simple API
* Fine-tune existing ArcLM checkpoints
* Lightweight and easy to understand
* Built on PyTorch

## Installation

Install ArcLM from PyPI:

```bash
pip install arclm
```

Or install the latest development version:

```bash
git clone https://github.com/Ahmad-Al-Dibo/ArcLM.git
cd ArcLM
pip install -e ".[dev]"
```

## Quick Start

Train a model:

```bash
python train.py
```

Generate text:

```python
from arclm import load_model

model = load_model("models/arclm.pth")
print(model.predict("machine learning", max_new_tokens=50))
```

## Documentation

The complete documentation is available in **docs/USAGE.md**.

It includes:

* Training a model from scratch
* Loading saved checkpoints
* Fine-tuning existing ArcLM models
* Working with external checkpoints
* Configuration options
* Best practices and notes

## Project Structure

```text
arclm/              Library source code
data/               Example datasets
docs/               Documentation
examples/           Example scripts
models/             Local checkpoints
tests/              Tests
```

## License

ArcLM is licensed under the Apache License 2.0. See the LICENSE file for details.
