tuneprompt 1.0.0__tar.gz

tuneprompt-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 PromptForge Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tuneprompt-1.0.0/PKG-INFO

@@ -0,0 +1,316 @@
+Metadata-Version: 2.4
+Name: tuneprompt
+Version: 1.0.0
+Summary: Open-source prompt quality scoring and optimization for LLMs
+Author: PromptForge Contributors
+License: MIT
+Project-URL: Homepage, https://github.com/arjun988/promptModel
+Project-URL: Issues, https://github.com/arjun988/promptModel/issues
+Project-URL: Documentation, https://github.com/arjun988/promptModel#readme
+Project-URL: Hugging Face (Quality), https://huggingface.co/ArjunShukla/PromptForge-Quality
+Project-URL: Hugging Face (Optimizer), https://huggingface.co/ArjunShukla/PromptForge-Optimizer
+Keywords: prompt-engineering,llm,modernbert,huggingface,prompt-quality,promptforge
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: torch>=2.1.0
+Requires-Dist: transformers>=4.48.0
+Requires-Dist: datasets>=2.19.0
+Requires-Dist: accelerate>=0.30.0
+Requires-Dist: peft>=0.11.0
+Requires-Dist: scikit-learn>=1.4.0
+Requires-Dist: pandas>=2.1.0
+Requires-Dist: numpy>=1.26.0
+Requires-Dist: scipy>=1.11.0
+Requires-Dist: evaluate>=0.4.0
+Requires-Dist: huggingface_hub>=0.23.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: tqdm>=4.66.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: ruff>=0.4.0; extra == "dev"
+Provides-Extra: demo
+Requires-Dist: gradio>=4.0.0; extra == "demo"
+Dynamic: license-file
+
+# PromptForge
+
+**Local-first prompt quality scoring and optimization.**
+
+PromptForge scores LLM prompts across seven quality dimensions, then rewrites weak prompts into clear, intent-preserving instructions — runnable on your machine via Python API, CLI, or Gradio.
+
+```text
+"Make an app about social media like facebook"
+                    │
+                    ▼
+         ┌─────────────────────┐
+         │  Quality Scorer     │  ModernBERT · ~150M
+         │  41.5 → issues…     │
+         └──────────┬──────────┘
+                    ▼
+         ┌─────────────────────┐
+         │  Prompt Optimizer   │  Qwen2.5-1.5B + LoRA
+         └──────────┬──────────┘
+                    ▼
+   Build a social media app similar to Facebook…
+   profiles · feed · likes · constraints · output format
+                    │
+                    ▼
+              41.5 → 94.0
+```
+
+[Docs](docs/LOCAL.md) · [Product plan](docs/PRD.md) · [Contributing](CONTRIBUTING.md) · [License](LICENSE)
+
+---
+
+## Why PromptForge
+
+Most prompt tools either **judge** quality or **rewrite** text. PromptForge does both in one local pipeline:
+
+| Capability | What you get |
+|------------|--------------|
+| **Multi-dimension scoring** | Clarity, specificity, context, goals, constraints, completeness, actionability |
+| **Intent-preserving rewrite** | Optimizes the *same* topic — not a generic template |
+| **Validation & fallback** | Rejects repetitive / off-topic generations |
+| **Runs locally** | ~1.65B total params; trains on 8 GB GPUs |
+| **Dev-ready surface** | `pip` package, CLI, Gradio demo, Colab notebooks |
+
+No API key required for inference once models are on disk.
+
+---
+
+## Example
+
+**Input**
+
+```text
+Make an app about social media like facebook and stuff
+```
+
+**Output (optimizer)**
+
+```text
+Build a social media app similar to Facebook for product managers.
+This is for a portfolio demo.
+
+Core features:
+- User profiles and friend connections
+- News feed with posts, likes, and comments
+- Basic notifications
+
+Requirements:
+- Use Python and Flask.
+- Keep the first version simple and usable
+- Include error handling and clear project structure
+
+Include short examples.
+```
+
+**Quality:** `41.5 → 94.0` (Δ +52.5) · topic preserved · no fallback
+
+---
+
+## Models
+
+| Component | Base | Size | Training |
+|-----------|------|------|----------|
+| **Scorer** | [`ModernBERT-base`](https://huggingface.co/answerdotai/ModernBERT-base) | ~150M | Full fine-tune |
+| **Optimizer** | [`Qwen2.5-1.5B-Instruct`](https://huggingface.co/Qwen/Qwen2.5-1.5B-Instruct) | 1.5B | LoRA (base frozen) |
+
+Weights are **not** stored in git. Train locally or download from Hugging Face:
+
+```bash
+python -m promptforge download \
+  --quality-repo ArjunShukla/PromptForge-Quality \
+  --optimizer-repo ArjunShukla/PromptForge-Optimizer
+```
+
+- Quality: https://huggingface.co/ArjunShukla/PromptForge-Quality  
+- Optimizer: https://huggingface.co/ArjunShukla/PromptForge-Optimizer
+
+---
+
+## Results
+
+Benchmarks from local training on **RTX 5060 Laptop (8 GB)** · Windows · `torch+cu128`.
+
+### Quality scorer
+
+| Split | MAE | Pearson |
+|-------|----:|--------:|
+| Validation | **2.73** | **0.993** |
+| Test (overall) | **0.96** | **0.999** |
+
+25k synthetic examples · 3 epochs · ~33 min
+
+### Prompt optimizer
+
+| Metric | Value |
+|--------|------:|
+| Validation loss | **0.121** |
+| Train loss | 0.466 |
+| Data | **800** curated weak→strong pairs |
+| Epochs | 6 |
+| Wall time | ~87 min |
+
+Config: `configs/optimizer_fast_8gb.yaml` (seq 512, grad checkpointing, batch 1 × accum 8)
+
+---
+
+## Quickstart
+
+### Install from PyPI
+
+```bash
+pip install tuneprompt
+```
+
+> **Note:** The PyPI package is **`tuneprompt`** (`promptforge` is already taken).  
+> Import and CLI stay the same: `from promptforge import PromptForge` · `promptforge` / `tuneprompt`.
+
+### Install from source
+
+```bash
+git clone https://github.com/arjun988/promptModel.git
+cd promptModel
+
+python -m venv .venv
+# Windows:  .venv\Scripts\activate
+# Unix:     source .venv/bin/activate
+
+pip install -U pip
+pip install -e ".[demo,dev]"
+```
+
+**GPU tip:** default `pip install torch` is often CPU-only. For NVIDIA (incl. RTX 50-series):
+
+```bash
+pip uninstall -y torch torchvision torchaudio
+pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu128
+```
+
+Full local guide: [docs/LOCAL.md](docs/LOCAL.md)
+
+### Configure & run
+
+```bash
+# Point at your trained checkpoints
+python -m promptforge init \
+  --quality-model outputs/promptforge-quality-model \
+  --optimizer-model outputs/promptforge-optimizer-model
+
+python -m promptforge doctor
+python -m promptforge run "Build me a website for a startup"
+python -m promptforge analyze "Make an app." --json
+```
+
+> On some Windows setups, Application Control blocks `.venv\Scripts\promptforge.exe`. Prefer `python -m promptforge …`.
+
+### Python API
+
+```python
+from promptforge import PromptForge
+
+pf = PromptForge.from_config()
+
+print(pf.analyze("Make an app."))
+result = pf.run("Make an app about social media like facebook and stuff")
+print(result["optimized_prompt"])
+print(result["delta"]["quality_score"])
+```
+
+---
+
+## Train your own
+
+```bash
+# Phase 1 — quality scorer
+python scripts/train_quality.py --require-gpu --regenerate
+
+# Phase 2 — optimizer (recommended on 8GB GPUs)
+python scripts/train_optimizer.py --require-gpu --fast --regenerate
+```
+
+| Flag / config | Purpose |
+|---------------|---------|
+| `--fast` | Loads `configs/optimizer_fast_8gb.yaml` |
+| `--regenerate` | Rebuild curated optimizer dataset |
+| `load_in_4bit: true` | Use if 1.5B LoRA OOMs |
+
+Publish checkpoints:
+
+```bash
+huggingface-cli login
+python scripts/export_to_hub.py --repo-id ArjunShukla/PromptForge-Quality
+python scripts/export_to_hub.py --repo-id ArjunShukla/PromptForge-Optimizer --optimizer
+```
+
+---
+
+## CLI
+
+| Command | Description |
+|---------|-------------|
+| `init` | Create `~/.promptforge` and register model paths |
+| `doctor` | GPU / config / model health check |
+| `download` | Pull models from Hugging Face |
+| `analyze` | Score a prompt |
+| `optimize` | Rewrite a prompt |
+| `run` | Score → optimize → compare |
+| `eval` | Pipeline evaluation reports |
+| `space` | Launch Gradio demo |
+| `train-quality` / `train-optimizer` | Training entrypoints |
+
+---
+
+## Project layout
+
+```text
+promptModel/
+├── src/promptforge/     # Package: scorer, optimizer, pipeline, CLI
+├── configs/             # Training + local defaults
+├── scripts/             # Train / eval / Hub export
+├── demo/                # Gradio app
+├── notebooks/
+│   ├── colab/           # Self-contained experiments
+│   └── package/         # Thin package drivers
+├── docs/                # PRD + local setup
+├── tests/
+└── pyproject.toml
+```
+
+Notebooks: [notebooks/README.md](notebooks/README.md)
+
+---
+
+## Roadmap
+
+| Phase | Deliverable | Status |
+|------:|-------------|--------|
+| 1 | Multi-dimension quality scorer | Done |
+| 2 | Intent-preserving prompt optimizer (LoRA) | Done |
+| 3 | Combined pipeline + eval + Gradio | Done |
+| 4 | Local package + CLI | Done |
+| 5 | VS Code / Cursor extension | Planned |
+
+---
+
+## Contributing
+
+Issues and PRs welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for setup, style, and PR expectations.
+
+```bash
+pip install -e ".[dev]"
+pytest -q
+```
+
+---
+
+## License
+
+[MIT](LICENSE) © PromptForge contributors

tuneprompt-1.0.0/README.md

@@ -0,0 +1,276 @@
+# PromptForge
+
+**Local-first prompt quality scoring and optimization.**
+
+PromptForge scores LLM prompts across seven quality dimensions, then rewrites weak prompts into clear, intent-preserving instructions — runnable on your machine via Python API, CLI, or Gradio.
+
+```text
+"Make an app about social media like facebook"
+                    │
+                    ▼
+         ┌─────────────────────┐
+         │  Quality Scorer     │  ModernBERT · ~150M
+         │  41.5 → issues…     │
+         └──────────┬──────────┘
+                    ▼
+         ┌─────────────────────┐
+         │  Prompt Optimizer   │  Qwen2.5-1.5B + LoRA
+         └──────────┬──────────┘
+                    ▼
+   Build a social media app similar to Facebook…
+   profiles · feed · likes · constraints · output format
+                    │
+                    ▼
+              41.5 → 94.0
+```
+
+[Docs](docs/LOCAL.md) · [Product plan](docs/PRD.md) · [Contributing](CONTRIBUTING.md) · [License](LICENSE)
+
+---
+
+## Why PromptForge
+
+Most prompt tools either **judge** quality or **rewrite** text. PromptForge does both in one local pipeline:
+
+| Capability | What you get |
+|------------|--------------|
+| **Multi-dimension scoring** | Clarity, specificity, context, goals, constraints, completeness, actionability |
+| **Intent-preserving rewrite** | Optimizes the *same* topic — not a generic template |
+| **Validation & fallback** | Rejects repetitive / off-topic generations |
+| **Runs locally** | ~1.65B total params; trains on 8 GB GPUs |
+| **Dev-ready surface** | `pip` package, CLI, Gradio demo, Colab notebooks |
+
+No API key required for inference once models are on disk.
+
+---
+
+## Example
+
+**Input**
+
+```text
+Make an app about social media like facebook and stuff
+```
+
+**Output (optimizer)**
+
+```text
+Build a social media app similar to Facebook for product managers.
+This is for a portfolio demo.
+
+Core features:
+- User profiles and friend connections
+- News feed with posts, likes, and comments
+- Basic notifications
+
+Requirements:
+- Use Python and Flask.
+- Keep the first version simple and usable
+- Include error handling and clear project structure
+
+Include short examples.
+```
+
+**Quality:** `41.5 → 94.0` (Δ +52.5) · topic preserved · no fallback
+
+---
+
+## Models
+
+| Component | Base | Size | Training |
+|-----------|------|------|----------|
+| **Scorer** | [`ModernBERT-base`](https://huggingface.co/answerdotai/ModernBERT-base) | ~150M | Full fine-tune |
+| **Optimizer** | [`Qwen2.5-1.5B-Instruct`](https://huggingface.co/Qwen/Qwen2.5-1.5B-Instruct) | 1.5B | LoRA (base frozen) |
+
+Weights are **not** stored in git. Train locally or download from Hugging Face:
+
+```bash
+python -m promptforge download \
+  --quality-repo ArjunShukla/PromptForge-Quality \
+  --optimizer-repo ArjunShukla/PromptForge-Optimizer
+```
+
+- Quality: https://huggingface.co/ArjunShukla/PromptForge-Quality  
+- Optimizer: https://huggingface.co/ArjunShukla/PromptForge-Optimizer
+
+---
+
+## Results
+
+Benchmarks from local training on **RTX 5060 Laptop (8 GB)** · Windows · `torch+cu128`.
+
+### Quality scorer
+
+| Split | MAE | Pearson |
+|-------|----:|--------:|
+| Validation | **2.73** | **0.993** |
+| Test (overall) | **0.96** | **0.999** |
+
+25k synthetic examples · 3 epochs · ~33 min
+
+### Prompt optimizer
+
+| Metric | Value |
+|--------|------:|
+| Validation loss | **0.121** |
+| Train loss | 0.466 |
+| Data | **800** curated weak→strong pairs |
+| Epochs | 6 |
+| Wall time | ~87 min |
+
+Config: `configs/optimizer_fast_8gb.yaml` (seq 512, grad checkpointing, batch 1 × accum 8)
+
+---
+
+## Quickstart
+
+### Install from PyPI
+
+```bash
+pip install tuneprompt
+```
+
+> **Note:** The PyPI package is **`tuneprompt`** (`promptforge` is already taken).  
+> Import and CLI stay the same: `from promptforge import PromptForge` · `promptforge` / `tuneprompt`.
+
+### Install from source
+
+```bash
+git clone https://github.com/arjun988/promptModel.git
+cd promptModel
+
+python -m venv .venv
+# Windows:  .venv\Scripts\activate
+# Unix:     source .venv/bin/activate
+
+pip install -U pip
+pip install -e ".[demo,dev]"
+```
+
+**GPU tip:** default `pip install torch` is often CPU-only. For NVIDIA (incl. RTX 50-series):
+
+```bash
+pip uninstall -y torch torchvision torchaudio
+pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu128
+```
+
+Full local guide: [docs/LOCAL.md](docs/LOCAL.md)
+
+### Configure & run
+
+```bash
+# Point at your trained checkpoints
+python -m promptforge init \
+  --quality-model outputs/promptforge-quality-model \
+  --optimizer-model outputs/promptforge-optimizer-model
+
+python -m promptforge doctor
+python -m promptforge run "Build me a website for a startup"
+python -m promptforge analyze "Make an app." --json
+```
+
+> On some Windows setups, Application Control blocks `.venv\Scripts\promptforge.exe`. Prefer `python -m promptforge …`.
+
+### Python API
+
+```python
+from promptforge import PromptForge
+
+pf = PromptForge.from_config()
+
+print(pf.analyze("Make an app."))
+result = pf.run("Make an app about social media like facebook and stuff")
+print(result["optimized_prompt"])
+print(result["delta"]["quality_score"])
+```
+
+---
+
+## Train your own
+
+```bash
+# Phase 1 — quality scorer
+python scripts/train_quality.py --require-gpu --regenerate
+
+# Phase 2 — optimizer (recommended on 8GB GPUs)
+python scripts/train_optimizer.py --require-gpu --fast --regenerate
+```
+
+| Flag / config | Purpose |
+|---------------|---------|
+| `--fast` | Loads `configs/optimizer_fast_8gb.yaml` |
+| `--regenerate` | Rebuild curated optimizer dataset |
+| `load_in_4bit: true` | Use if 1.5B LoRA OOMs |
+
+Publish checkpoints:
+
+```bash
+huggingface-cli login
+python scripts/export_to_hub.py --repo-id ArjunShukla/PromptForge-Quality
+python scripts/export_to_hub.py --repo-id ArjunShukla/PromptForge-Optimizer --optimizer
+```
+
+---
+
+## CLI
+
+| Command | Description |
+|---------|-------------|
+| `init` | Create `~/.promptforge` and register model paths |
+| `doctor` | GPU / config / model health check |
+| `download` | Pull models from Hugging Face |
+| `analyze` | Score a prompt |
+| `optimize` | Rewrite a prompt |
+| `run` | Score → optimize → compare |
+| `eval` | Pipeline evaluation reports |
+| `space` | Launch Gradio demo |
+| `train-quality` / `train-optimizer` | Training entrypoints |
+
+---
+
+## Project layout
+
+```text
+promptModel/
+├── src/promptforge/     # Package: scorer, optimizer, pipeline, CLI
+├── configs/             # Training + local defaults
+├── scripts/             # Train / eval / Hub export
+├── demo/                # Gradio app
+├── notebooks/
+│   ├── colab/           # Self-contained experiments
+│   └── package/         # Thin package drivers
+├── docs/                # PRD + local setup
+├── tests/
+└── pyproject.toml
+```
+
+Notebooks: [notebooks/README.md](notebooks/README.md)
+
+---
+
+## Roadmap
+
+| Phase | Deliverable | Status |
+|------:|-------------|--------|
+| 1 | Multi-dimension quality scorer | Done |
+| 2 | Intent-preserving prompt optimizer (LoRA) | Done |
+| 3 | Combined pipeline + eval + Gradio | Done |
+| 4 | Local package + CLI | Done |
+| 5 | VS Code / Cursor extension | Planned |
+
+---
+
+## Contributing
+
+Issues and PRs welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for setup, style, and PR expectations.
+
+```bash
+pip install -e ".[dev]"
+pytest -q
+```
+
+---
+
+## License
+
+[MIT](LICENSE) © PromptForge contributors

tuneprompt-1.0.0/pyproject.toml

@@ -0,0 +1,68 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tuneprompt"
+version = "1.0.0"
+description = "Open-source prompt quality scoring and optimization for LLMs"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+authors = [{ name = "PromptForge Contributors" }]
+keywords = [
+  "prompt-engineering",
+  "llm",
+  "modernbert",
+  "huggingface",
+  "prompt-quality",
+  "promptforge",
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+dependencies = [
+  "torch>=2.1.0",
+  "transformers>=4.48.0",
+  "datasets>=2.19.0",
+  "accelerate>=0.30.0",
+  "peft>=0.11.0",
+  "scikit-learn>=1.4.0",
+  "pandas>=2.1.0",
+  "numpy>=1.26.0",
+  "scipy>=1.11.0",
+  "evaluate>=0.4.0",
+  "huggingface_hub>=0.23.0",
+  "pyyaml>=6.0",
+  "tqdm>=4.66.0",
+]
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=8.0.0",
+  "ruff>=0.4.0",
+]
+demo = [
+  "gradio>=4.0.0",
+]
+
+[project.scripts]
+tuneprompt = "promptforge.cli:main"
+promptforge = "promptforge.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/arjun988/promptModel"
+Issues = "https://github.com/arjun988/promptModel/issues"
+Documentation = "https://github.com/arjun988/promptModel#readme"
+"Hugging Face (Quality)" = "https://huggingface.co/ArjunShukla/PromptForge-Quality"
+"Hugging Face (Optimizer)" = "https://huggingface.co/ArjunShukla/PromptForge-Optimizer"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+promptforge = ["py.typed"]

tuneprompt-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tuneprompt-1.0.0/src/promptforge/__init__.py

@@ -0,0 +1,15 @@
+"""PromptForge — local prompt quality scoring and optimization."""
+
+from promptforge.analyzer import PromptAnalyzer
+from promptforge.optimizer import PromptOptimizer
+from promptforge.pipeline import PromptForge
+from promptforge.scorer import PromptQualityScorer
+
+__version__ = "1.0.0"
+__all__ = [
+    "PromptAnalyzer",
+    "PromptForge",
+    "PromptOptimizer",
+    "PromptQualityScorer",
+    "__version__",
+]

tuneprompt-1.0.0/src/promptforge/__main__.py

@@ -0,0 +1,6 @@
+"""Package entrypoint: python -m promptforge"""
+
+from promptforge.cli import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())