trloom 0.1.0__tar.gz

trloom-0.1.0/.gitignore

@@ -0,0 +1,71 @@
+# Byte-compiled / cache
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+env/
+
+# Testing / coverage
+.coverage
+.coverage.*
+htmlcov/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.tox/
+.nox/
+
+# IDE / OS
+.idea/
+.vscode/
+*.swp
+.DS_Store
+Thumbs.db
+
+# Training artifacts
+outputs/
+output/
+wandb/
+runs/
+checkpoints/
+*.pt
+*.bin
+*.safetensors
+
+# Secrets / local config
+.env
+.env.*
+!.env.example
+secrets/
+*.pem
+
+# Modal
+.modal/
+
+# Docs build
+site/
+
+# Local article drafts (not part of the library)
+medium-trloom-tutorial.md
+*-medium*.md

trloom-0.1.0/LICENSE

@@ -0,0 +1,176 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

trloom-0.1.0/PKG-INFO

@@ -0,0 +1,305 @@
+Metadata-Version: 2.5
+Name: trloom
+Version: 0.1.0
+Summary: YAML-driven end-to-end fine-tuning on top of Hugging Face TRL, with W&B and Modal support.
+Project-URL: Homepage, https://github.com/saqlain2204/trloom
+Project-URL: Repository, https://github.com/saqlain2204/trloom
+Project-URL: Documentation, https://saqlain2204.github.io/trloom/
+Project-URL: Issues, https://github.com/saqlain2204/trloom/issues
+Author: TRLoom contributors
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: fine-tuning,modal,rlhf,transformers,trl,wandb,yaml
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+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.10
+Requires-Dist: accelerate>=1.0.0
+Requires-Dist: datasets>=3.0.0
+Requires-Dist: huggingface-hub>=0.26.0
+Requires-Dist: peft>=0.14.0
+Requires-Dist: pydantic>=2.7
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: transformers>=4.51.0
+Requires-Dist: trl>=0.24.0
+Provides-Extra: all
+Requires-Dist: bitsandbytes>=0.45.0; extra == 'all'
+Requires-Dist: modal>=0.73.0; extra == 'all'
+Requires-Dist: wandb>=0.18.0; extra == 'all'
+Provides-Extra: bitsandbytes
+Requires-Dist: bitsandbytes>=0.45.0; extra == 'bitsandbytes'
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.8.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.5.0; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.26.0; extra == 'docs'
+Provides-Extra: modal
+Requires-Dist: modal>=0.73.0; extra == 'modal'
+Provides-Extra: wandb
+Requires-Dist: wandb>=0.18.0; extra == 'wandb'
+Description-Content-Type: text/markdown
+
+# TRLoom
+
+<p align="center">
+  <img src="assets/trloom.png" alt="TRLoom" width="280" />
+</p>
+
+**TRLoom** weaves a single YAML config into an end-to-end [Hugging Face TRL](https://huggingface.co/docs/trl) fine-tuning job.
+
+Configure the model, dataset, trainer, Weights & Biases, and optional [Modal](https://modal.com) GPU execution — then run one command.
+
+**Docs:** [https://saqlain2204.github.io/trloom/](https://saqlain2204.github.io/trloom/)
+
+## Features
+
+- **TRL-native** — discovers trainers/configs from your installed TRL version (SFT, DPO, GRPO, KTO, Reward, RLOO, and experimental methods)
+- **YAML-first** — model, dataset, training args, W&B, and Modal all live in one file
+- **Datasets** — Hugging Face Hub, local files (`json`/`jsonl`/`csv`/`parquet`/…), saved `datasets` directories, and mixtures
+- **W&B** — enable and configure logging entirely from YAML
+- **Modal** — launch the same YAML on remote GPUs with volume-backed outputs
+- **CLI + Python API** — `trloom run config.yaml` or `FineTuneJob.from_yaml(...)`
+
+## Installation
+
+Requires Python 3.10+ and a working TRL / PyTorch environment for actual training.
+
+### One-command bootstrap (any OS)
+
+Creates `.venv` if needed, then installs TRLoom:
+
+```bash
+# Local only (no Modal auth)
+python scripts/bootstrap.py
+
+# Local + Modal extra + `modal setup`
+python scripts/bootstrap.py --modal
+```
+
+Optional flags: `--wandb`, `--dev`, `--all`, `--skip-modal-setup`.
+
+Then activate the venv:
+
+```bash
+# macOS / Linux
+source .venv/bin/activate
+
+# Windows PowerShell
+.venv\Scripts\Activate.ps1
+```
+
+### Manual install
+
+```bash
+pip install -e .
+
+# Optional extras
+pip install -e ".[wandb]"
+pip install -e ".[modal]"
+pip install -e ".[docs]"
+pip install -e ".[all]"
+pip install -e ".[dev]"
+```
+
+## Quickstart
+
+### 1. Write a config
+
+```yaml
+# sft.yaml
+method: sft
+
+model:
+  model_name_or_path: Qwen/Qwen2.5-0.5B-Instruct
+  use_peft: true
+  lora_r: 16
+  lora_alpha: 32
+
+dataset:
+  path: trl-lib/Capybara
+  train_split: train
+
+training:
+  output_dir: ./outputs/sft
+  learning_rate: 2.0e-4
+  num_train_epochs: 1
+  per_device_train_batch_size: 2
+  gradient_accumulation_steps: 4
+  report_to: none
+
+wandb:
+  enabled: false
+
+modal:
+  enabled: false
+```
+
+### 2. Run
+
+```bash
+trloom validate sft.yaml
+trloom run sft.yaml
+```
+
+Or from Python:
+
+```python
+from trloom import FineTuneJob, run_from_yaml
+
+# One-liner
+run_from_yaml("sft.yaml")
+
+# Or step through the API
+job = FineTuneJob.from_yaml("sft.yaml")
+job.run()
+```
+
+## Documentation
+
+Full guides and API reference:
+
+- Online: [saqlain2204.github.io/trloom](https://saqlain2204.github.io/trloom/)
+- Local preview:
+
+```bash
+pip install -e ".[docs]"
+mkdocs serve
+```
+
+Coverage includes configuration reference, datasets, W&B, Modal, CLI, and the Python API.
+
+## Configuration reference
+
+| Section | Purpose |
+|--------|---------|
+| `method` | TRL method key: `sft`, `dpo`, `grpo`, `kto`, `reward`, `rloo`, … |
+| `model` | Model id + PEFT/quantization (aligned with TRL `ModelConfig`) |
+| `dataset` | Hub repo, local path, or `datasets:` mixture |
+| `training` | Forwarded to the TRL `*Config` class (`SFTConfig`, `DPOConfig`, …) |
+| `wandb` | Weights & Biases project/entity/tags/mode |
+| `modal` | Remote GPU execution on Modal |
+| `reward_funcs` | Names or import paths for GRPO/RLOO-style rewards |
+| `trainer_kwargs` | Extra kwargs passed to the Trainer constructor |
+| `push_to_hub` / `hub_model_id` | Optional Hub upload after training |
+
+List methods available in your environment:
+
+```bash
+trloom methods
+```
+
+### Dataset examples
+
+**Hub**
+
+```yaml
+dataset:
+  path: trl-lib/Capybara
+  train_split: train
+```
+
+**Local JSONL**
+
+```yaml
+dataset:
+  path: ./data/train.jsonl
+  train_split: train
+```
+
+**Mixture**
+
+```yaml
+dataset:
+  train_split: train
+  datasets:
+    - path: stanfordnlp/imdb
+      split: train
+      weight: 0.5
+    - path: ./data/extra.jsonl
+      weight: 0.5
+```
+
+### Weights & Biases
+
+```yaml
+training:
+  report_to: wandb   # optional; set automatically when wandb.enabled is true
+
+wandb:
+  enabled: true
+  project: my-project
+  entity: my-team
+  run_name: qwen-sft-01
+  tags: [sft, lora]
+  mode: online       # online | offline | disabled
+```
+
+### Modal
+
+1. Install and authenticate: `pip install 'trloom[modal]' && modal setup`
+2. Create secrets named in the config (default: `huggingface`, `wandb`)
+3. Set `modal.enabled: true` (or pass `--modal`)
+
+```bash
+trloom run examples/grpo_modal.yaml --modal
+# or generate a standalone script
+trloom modal-script examples/grpo_modal.yaml -o run_modal.py
+modal run run_modal.py
+```
+
+## Python API
+
+```python
+from trloom import FineTuneJob, available_methods, load_config
+
+print(available_methods())
+
+config = load_config("sft.yaml")
+job = FineTuneJob(config)
+trainer = job.build()   # construct TRL trainer
+job.run()               # train + save (+ optional Hub push)
+```
+
+| Method | Description |
+|--------|-------------|
+| `FineTuneJob.from_yaml(path)` | Load YAML into a job |
+| `FineTuneJob.from_dict(data)` | Load an in-memory config |
+| `job.build()` | Construct the TRL trainer |
+| `job.train()` / `job.run()` | Run training end-to-end |
+| `run_from_yaml(path)` | Load + run (honors `modal.enabled`) |
+| `load_config(path)` | Validate and return `FineTuneConfig` |
+| `available_methods()` | List TRL methods for this install |
+
+## Examples
+
+See the [`examples/`](examples/) directory:
+
+- `modal_smoke/` — **complete end-to-end Modal walkthrough** (tiny GPT-2, 3 steps, T4)
+- `sft_hub.yaml` — SFT from the Hub
+- `sft_local.yaml` — SFT from local JSONL
+- `dpo_wandb.yaml` — DPO with W&B
+- `grpo_modal.yaml` — GRPO on Modal
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+
+# Documentation
+pip install -e ".[docs]"
+mkdocs serve
+mkdocs build --strict
+```
+
+## License
+
+Apache-2.0