Metadata-Version: 2.4
Name: zeldarose
Version: 0.14.0
Summary: Train transformer-based models
Project-URL: Bug Tracker, https://codeberg.org/mgrobol/zeldarose/issues
Project-URL: Changes, https://codeberg.org/mgrobol/zeldarose/src/branch/main/CHANGELOG.md
Project-URL: Documentation, https://mgrobol.codeberg.page/zeldarose
Project-URL: Source Code, https://codeberg.org/mgrobol/zeldarose
Author-email: Morgan Grobol <morgan.grobol@tuta.com>
License-Expression: EUPL-1.2
License-File: LICENCE.md
Keywords: language-model,nlp,transformers
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Requires-Dist: click<9.0,>=8.0.4
Requires-Dist: datasets<4.9,>=3.0
Requires-Dist: filelock
Requires-Dist: jsonlines
Requires-Dist: lightning<2.7,>=2.5.3
Requires-Dist: loguru
Requires-Dist: pydantic
Requires-Dist: pytorch-lightning<2.7,>=2.5.3
Requires-Dist: rich<15,>=14
Requires-Dist: sacrebleu
Requires-Dist: sacremoses
Requires-Dist: system-info
Requires-Dist: tensorboardx
Requires-Dist: tokenizers<0.23,>=0.10
Requires-Dist: tomli
Requires-Dist: torch<2.12,>=2.0
Requires-Dist: torchmetrics<2.0,>=1.0
Requires-Dist: transformers<5.0,>=4.55
Description-Content-Type: text/markdown

# Zelda Rose

[![Latest PyPI version](https://img.shields.io/pypi/v/zeldarose.svg)](https://pypi.org/project/zeldarose)

A straightforward trainer for transformer-based models.

## Installation

Simply install with pipx

```bash
pipx install zeldarose
```

## Train MLM models

Here is a short example of training first a tokenizer, then a transformer MLM model:

```bash
TOKENIZERS_PARALLELISM=true zeldarose tokenizer --vocab-size 4096 --out-path local/tokenizer  --model-name "my-muppet" tests/fixtures/raw.txt
zeldarose 
transformer --tokenizer local/tokenizer --pretrained-model flaubert/flaubert_small_cased --out-dir local/muppet --val-text tests/fixtures/raw.txt tests/fixtures/raw.txt
```

See [the documentation](https://mgrobol.codeberg.page/zeldarose) for more details!

## Citation

If you use Zelda Rose, please cite it as :

> Loïc Grobol. 2023. ‘Zelda Rose: A Tool for Hassle-Free Training of Transformer Models’. Paper
> presented at NLP OSS, Singapore, Indonesia. Proceedings of the 3rd Workshop for Natural Language
> Processing Open Source Software. <https://hal.science/hal-04262806>.

## Licence

This software is released under the
[EUPL 1.2](https://interoperable-europe.ec.europa.eu/collection/eupl/eupl-text-eupl-12) or later,
with some files released under compatible free licences, see [LICENCE.md](LICENCE.md) for the
details.
