text2model 1.0.0__tar.gz → 1.1.0__tar.gz

{text2model-1.0.0/text2model.egg-info → text2model-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: text2model
-Version: 1.0.0
+Version: 1.1.0
 Summary: LLM Modeling Copilots for Text-to-Model Translation
 License: Apache-2.0
 Keywords: minizinc,constraint-programming,LLM,text-to-model
@@ -14,13 +14,13 @@ Requires-Dist: openai
 Requires-Dist: datasets
 Requires-Dist: tqdm
 Requires-Dist: langchain-ollama
-Provides-Extra: test
-Requires-Dist: pytest; extra == "test"
+Requires-Dist: flet==0.21.2
+Requires-Dist: pytest
 Dynamic: license-file
 
 [![Tests](https://github.com/skadio/text2model/actions/workflows/tests.yml/badge.svg)](https://github.com/skadio/text2model/actions/workflows/tests.yml)
-[![PyPI version](https://img.shields.io/pypi/v/text2model.svg)](https://pypi.org/project/text2model/)
-[![PyPI license](https://img.shields.io/pypi/l/text2model.svg)](https://pypi.python.org/pypi/text2model/)
+[![PyPI version](https://img.shields.io/pypi/v/text2model.svg?cacheSeconds=1)](https://pypi.org/project/text2model/)
+[![PyPI license](https://img.shields.io/pypi/l/text2model.svg?cacheSeconds=1)](https://pypi.python.org/pypi/text2model/)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
 [![Downloads](https://static.pepy.tech/personalized-badge/text2model?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads)](https://pepy.tech/project/text2model)
 
@@ -30,8 +30,10 @@ Dynamic: license-file
   <h3>
     <a href="https://github.com/skadio/text2model?tab=readme-ov-file#text-mode">Text Mode</a> •
     <a href="https://github.com/skadio/text2model?tab=readme-ov-file#text2zinc-mode">Text2Zinc Mode</a> •
+    <a href="https://github.com/skadio/text2model?tab=readme-ov-file#interactive-mode">Interactive Mode</a> •
     <a href="https://github.com/skadio/text2model?tab=readme-ov-file#copilots">Copilots</a> •
     <a href="https://github.com/skadio/text2model?tab=readme-ov-file#installation">Installation</a> •
+    <a href="https://github.com/skadio/text2model?tab=readme-ov-file#dataset-editor">Dataset Editor</a> •
     <a href="https://github.com/skadio/text2model?tab=readme-ov-file#evaluation">Evaluation</a> •
     <a href="https://github.com/skadio/text2model?tab=readme-ov-file#leaderboard">Leaderboard</a>
   </h3>
@@ -49,7 +51,7 @@ Please visit [Text2Model](https://skadio.github.io/text2model/) for latest publi
 
 ## Quick Start
 
-Text2Model supports translating given problem descriptions, **Text mode**, or specific problems from our dataset, **Text2Zinc mode**.
+Text2Model supports translating given problem descriptions (**Text mode**), specific problems from our dataset (**Text2Zinc mode**), or running interactively using the [editor](https://github.com/skadio/text2model?tab=readme-ov-file#dataset-editor) (**Editor mode**).
 
 ### Text Mode
 
@@ -86,8 +88,8 @@ text2model --source nlp4lp --strategies cot --model gpt-4 --output-dir my_result
 # List all available data sources
 text2model --list-sources
 
-# List all available model options
-# --model accepts gpt-4, gpt-4o, gpt-5.2 (OpenAI, requires OPENAI_API_KEY), or phi4 (served locally through Ollama, no API key needed)
+# List all available --model options (which need OPENAI_API_KEY vs. run locally through Ollama)
+text2model --list-models
 
 # Advanced options
 text2model --strategies agents --model gpt-4 \
@@ -96,8 +98,22 @@ text2model --strategies agents --model gpt-4 \
   --max-tokens 8192 \
   --sleep-time 2 \
   --include-unverified
+
+# Use a local dataset (e.g. one saved by `text2model --editor`) instead of the
+# default skadio/text2zinc HuggingFace dataset
+text2model --strategies cot --model gpt-4 --output-dir my_results \
+  --dataset-path text2zinc_edited.csv
+```
+
+### Interactive Mode
+
+```bash
+text2model --editor
+text2model --editor --dataset-path text2zinc_edited.csv
 ```
 
+See [Dataset Editor](https://github.com/skadio/text2model?tab=readme-ov-file#dataset-editor) for details.
+
 ## Copilots
 
 Text2Model offers different copilot strategies, ranging from simple single-call approaches to sophisticated multi-agent systems. Each makes different trade-offs between speed and accuracy.
@@ -114,6 +130,18 @@ Text2Model offers different copilot strategies, ranging from simple single-call
 | `agents_with_code_validation` | Agents approach plus a final validation/fix step.                                                                                                            |
 | `gala` | Global Agents for different constraint types (all_different, cumulative, etc.) plus an assembler. See the [GALA paper](https://arxiv.org/abs/2509.08970).|
 
+> **Want to use `knowledge_graph` on your own problems?** It requires a pre-built `.ttl` knowledge-graph file per problem. See [`text2model/generate_knowledge_graph.py`](text2model/generate_knowledge_graph.py) and any example file under [`text2model/knowledge_graphs/`](text2model/knowledge_graphs/) (e.g. `nlp4lp_1.ttl`) and do similar — either adapt the script to your problem or hand-write a `.ttl` following the same structure.
+
+### Adding a Custom Copilot
+
+Every strategy in the table above follows the same shape, so plugging in a new one is mechanical:
+
+1. **Add prompt(s)** under [`text2model/prompts/`](text2model/prompts/) (`.txt` files with `{problem_description}`, `{input_data}`, etc. placeholders — see any existing prompt for the pattern).
+2. **Write a `run_<name>_strategy(client, model, problem, problem_identifier, output_dir)` function** in [`text2model/main.py`](text2model/main.py). Use `utils.prepare_problem_data`, `utils.get_effective_input_data`, and `utils.load_file` to build your prompt(s), call `utils.call_api(client, model, prompt)` to get code back, and stitch/combine calls the way `run_agents_strategy` does if your copilot needs multiple LLM calls. Finish with `utils.save_solution(output_dir, problem_identifier, code)`.
+3. **Register it** by adding `'<name>': run_<name>_strategy` to `_STRATEGY_MAP` in `main.py`, and add `'<name>'` to the `--strategies` argparse `choices` list (and to the `'all'` expansion list if it should run as part of `--strategies all`).
+
+That's it — your strategy is now available via `--strategies <name>` in both `--problem` and batch modes.
+
 ## Installation
 
 Text2Model requires **Python 3.8+** and can be installed from PyPI or by building from source.
@@ -136,9 +164,35 @@ cd text2model
 pip install -e .
 ```
 
+## Dataset Editor
+
+Text2Model ships a GUI editor (built with [Flet](https://flet.dev)) for browsing and editing Text2Zinc problems (input.json, data.dzn, model.mzn, output.json), running them through MiniZinc, and chatting with an AI assistant for help rephrasing descriptions or fixing model code.
+
+### Launch
+
+```bash
+text2model --editor
+```
+
+By default the editor opens, in order: a previous editing session (`text2zinc_edited.csv` in the current directory), otherwise the dataset bundled with the package. Use the **"Load from HuggingFace"** button inside the editor to instead start from a fresh copy of `skadio/text2zinc`, or open any other local dataset with **"Open CSV..."** — or non-interactively:
+
+```bash
+text2model --editor --dataset-path my_dataset.csv
+```
+
+### Save and Benchmark
+
+- **Save** (or Ctrl+S) quick-saves your edits to `text2zinc_edited.csv` in the current directory.
+- **Save As New Dataset...** exports to any path you choose. That path is a complete Text2Zinc dataset you can pass to `--dataset-path` to generate or benchmark against your edits instead of the default HuggingFace dataset:
+
+```bash
+text2model --strategies cot --model gpt-4 --output-dir my_results --dataset-path my_dataset.csv
+python evals/evaluate.py --output-dir my_results --dataset-path my_dataset.csv
+```
+
 ## Evaluation
 
-After generating models, evaluate their correctness via `evaluate.py`. This script compiles and runs each generated MiniZinc model against test instances, checking for both execution success and solution correctness.
+After generating models, evaluate their correctness via [`evals/evaluate.py`](evals/evaluate.py). This script compiles and runs each generated MiniZinc model against test instances, checking for both execution success and solution correctness.
 
 #### Prerequisite
 
@@ -148,9 +202,15 @@ Install MiniZinc solver: https://www.minizinc.org/doc-2.5.5/en/installation.html
 ```bash
 # Evaluate all generated code
 # `--output-dir` is required. Point it at the directory produced by the batch-mode `text2model` run.
-python evaluate.py --output-dir my_results
+python evals/evaluate.py --output-dir my_results
+
+# Evaluate against a local dataset (e.g. one saved by `text2model --editor`) instead
+# of the default skadio/text2zinc HuggingFace dataset
+python evals/evaluate.py --output-dir my_results --dataset-path text2zinc_edited.csv
 ```
 
+Running the eval generates a JSON file (`evals/evaluation_results.json` by default, via `--output-json`) with your accuracy metrics. You can PR that file to the [Text2Model Leaderboard](https://huggingface.co/spaces/skadio/text2model-leaderboard) on Hugging Face to get your results added to the online leaderboard.
+
 #### Metrics
 
 | Metric | Description |
@@ -169,8 +229,6 @@ Text2Model hosts an online leaderboard tracking execution accuracy, solution acc
 
 ## Testing
 
-Install test dependencies with `pip install -e ".[test]"`.
-
 **Default tests** (`tests/test_main.py`, `tests/test_utils.py`) do not need an API key, network, or MiniZinc.
 They are pure logic tests with mocked API calls and is run by the CI:
 
@@ -199,15 +257,20 @@ text2model/
 │   │   ├── global_constraint_prompts/
 │   │   └── ...
 │   ├── knowledge_graphs/        # KG files (.ttl) for knowledge_graph strategy
+│   ├── editor/                  # Dataset editor GUI (`text2model --editor`)
+│   │   ├── app.py               # Flet app: browse/edit/execute Text2Zinc problems, AI chat assistant
+│   │   └── data/text2zinc.csv   # Bundled default dataset the editor opens on first run
 │   ├── grammar.mzn              # MiniZinc grammar for validation
 │   ├── main.py                  # Copilot strategies and CLI entry point
-│   └── utils.py                 # Shared utilities (API calls, validation)
+│   ├── generate_knowledge_graph.py  # Generates KGs for the knowledge_graph strategy
+│   └── utils.py                 # Shared utilities (API calls, validation, dataset loading)
 ├── tests/                       # Unit and integration tests (pytest)
-├── output/                      # Generated models (created automatically)
-│   ├── [model]/[strategy]/      # e.g., gpt-4/cot/problem_1.mzn
-│   └── evaluation_results/      # Accuracy metrics and leaderboard
-├── evaluate.py                  # Evaluates generated MiniZinc models
-├── generate_knowledge_graph.py  # Generates KGs for knowledge_graph strategy
+├── evals/                       # Evaluation tooling
+│   ├── evaluate.py              # Evaluates generated MiniZinc models
+│   ├── evaluation_results.json  # Latest evaluation results (PR-able to the HF leaderboard)
+│   └── results/                 # Accuracy metrics and leaderboard from paper runs
+├── output/                      # Original outputs per strategy, kept for reproducing paper results
+│   └── [model]/[strategy]/      # e.g., gpt-4/cot/problem_1.mzn
 ├── pyproject.toml               # Package metadata and install config
 ├── CHANGELOG.txt                # Release history
 └── LICENSE                      # Apache License 2.0

{text2model-1.0.0 → text2model-1.1.0}/README.md

@@ -1,6 +1,6 @@
 [![Tests](https://github.com/skadio/text2model/actions/workflows/tests.yml/badge.svg)](https://github.com/skadio/text2model/actions/workflows/tests.yml)
-[![PyPI version](https://img.shields.io/pypi/v/text2model.svg)](https://pypi.org/project/text2model/)
-[![PyPI license](https://img.shields.io/pypi/l/text2model.svg)](https://pypi.python.org/pypi/text2model/)
+[![PyPI version](https://img.shields.io/pypi/v/text2model.svg?cacheSeconds=1)](https://pypi.org/project/text2model/)
+[![PyPI license](https://img.shields.io/pypi/l/text2model.svg?cacheSeconds=1)](https://pypi.python.org/pypi/text2model/)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
 [![Downloads](https://static.pepy.tech/personalized-badge/text2model?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads)](https://pepy.tech/project/text2model)
 
@@ -10,8 +10,10 @@
   <h3>
     <a href="https://github.com/skadio/text2model?tab=readme-ov-file#text-mode">Text Mode</a> •
     <a href="https://github.com/skadio/text2model?tab=readme-ov-file#text2zinc-mode">Text2Zinc Mode</a> •
+    <a href="https://github.com/skadio/text2model?tab=readme-ov-file#interactive-mode">Interactive Mode</a> •
     <a href="https://github.com/skadio/text2model?tab=readme-ov-file#copilots">Copilots</a> •
     <a href="https://github.com/skadio/text2model?tab=readme-ov-file#installation">Installation</a> •
+    <a href="https://github.com/skadio/text2model?tab=readme-ov-file#dataset-editor">Dataset Editor</a> •
     <a href="https://github.com/skadio/text2model?tab=readme-ov-file#evaluation">Evaluation</a> •
     <a href="https://github.com/skadio/text2model?tab=readme-ov-file#leaderboard">Leaderboard</a>
   </h3>
@@ -29,7 +31,7 @@ Please visit [Text2Model](https://skadio.github.io/text2model/) for latest publi
 
 ## Quick Start
 
-Text2Model supports translating given problem descriptions, **Text mode**, or specific problems from our dataset, **Text2Zinc mode**.
+Text2Model supports translating given problem descriptions (**Text mode**), specific problems from our dataset (**Text2Zinc mode**), or running interactively using the [editor](https://github.com/skadio/text2model?tab=readme-ov-file#dataset-editor) (**Editor mode**).
 
 ### Text Mode
 
@@ -66,8 +68,8 @@ text2model --source nlp4lp --strategies cot --model gpt-4 --output-dir my_result
 # List all available data sources
 text2model --list-sources
 
-# List all available model options
-# --model accepts gpt-4, gpt-4o, gpt-5.2 (OpenAI, requires OPENAI_API_KEY), or phi4 (served locally through Ollama, no API key needed)
+# List all available --model options (which need OPENAI_API_KEY vs. run locally through Ollama)
+text2model --list-models
 
 # Advanced options
 text2model --strategies agents --model gpt-4 \
@@ -76,8 +78,22 @@ text2model --strategies agents --model gpt-4 \
   --max-tokens 8192 \
   --sleep-time 2 \
   --include-unverified
+
+# Use a local dataset (e.g. one saved by `text2model --editor`) instead of the
+# default skadio/text2zinc HuggingFace dataset
+text2model --strategies cot --model gpt-4 --output-dir my_results \
+  --dataset-path text2zinc_edited.csv
+```
+
+### Interactive Mode
+
+```bash
+text2model --editor
+text2model --editor --dataset-path text2zinc_edited.csv
 ```
 
+See [Dataset Editor](https://github.com/skadio/text2model?tab=readme-ov-file#dataset-editor) for details.
+
 ## Copilots
 
 Text2Model offers different copilot strategies, ranging from simple single-call approaches to sophisticated multi-agent systems. Each makes different trade-offs between speed and accuracy.
@@ -94,6 +110,18 @@ Text2Model offers different copilot strategies, ranging from simple single-call
 | `agents_with_code_validation` | Agents approach plus a final validation/fix step.                                                                                                            |
 | `gala` | Global Agents for different constraint types (all_different, cumulative, etc.) plus an assembler. See the [GALA paper](https://arxiv.org/abs/2509.08970).|
 
+> **Want to use `knowledge_graph` on your own problems?** It requires a pre-built `.ttl` knowledge-graph file per problem. See [`text2model/generate_knowledge_graph.py`](text2model/generate_knowledge_graph.py) and any example file under [`text2model/knowledge_graphs/`](text2model/knowledge_graphs/) (e.g. `nlp4lp_1.ttl`) and do similar — either adapt the script to your problem or hand-write a `.ttl` following the same structure.
+
+### Adding a Custom Copilot
+
+Every strategy in the table above follows the same shape, so plugging in a new one is mechanical:
+
+1. **Add prompt(s)** under [`text2model/prompts/`](text2model/prompts/) (`.txt` files with `{problem_description}`, `{input_data}`, etc. placeholders — see any existing prompt for the pattern).
+2. **Write a `run_<name>_strategy(client, model, problem, problem_identifier, output_dir)` function** in [`text2model/main.py`](text2model/main.py). Use `utils.prepare_problem_data`, `utils.get_effective_input_data`, and `utils.load_file` to build your prompt(s), call `utils.call_api(client, model, prompt)` to get code back, and stitch/combine calls the way `run_agents_strategy` does if your copilot needs multiple LLM calls. Finish with `utils.save_solution(output_dir, problem_identifier, code)`.
+3. **Register it** by adding `'<name>': run_<name>_strategy` to `_STRATEGY_MAP` in `main.py`, and add `'<name>'` to the `--strategies` argparse `choices` list (and to the `'all'` expansion list if it should run as part of `--strategies all`).
+
+That's it — your strategy is now available via `--strategies <name>` in both `--problem` and batch modes.
+
 ## Installation
 
 Text2Model requires **Python 3.8+** and can be installed from PyPI or by building from source.
@@ -116,9 +144,35 @@ cd text2model
 pip install -e .
 ```
 
+## Dataset Editor
+
+Text2Model ships a GUI editor (built with [Flet](https://flet.dev)) for browsing and editing Text2Zinc problems (input.json, data.dzn, model.mzn, output.json), running them through MiniZinc, and chatting with an AI assistant for help rephrasing descriptions or fixing model code.
+
+### Launch
+
+```bash
+text2model --editor
+```
+
+By default the editor opens, in order: a previous editing session (`text2zinc_edited.csv` in the current directory), otherwise the dataset bundled with the package. Use the **"Load from HuggingFace"** button inside the editor to instead start from a fresh copy of `skadio/text2zinc`, or open any other local dataset with **"Open CSV..."** — or non-interactively:
+
+```bash
+text2model --editor --dataset-path my_dataset.csv
+```
+
+### Save and Benchmark
+
+- **Save** (or Ctrl+S) quick-saves your edits to `text2zinc_edited.csv` in the current directory.
+- **Save As New Dataset...** exports to any path you choose. That path is a complete Text2Zinc dataset you can pass to `--dataset-path` to generate or benchmark against your edits instead of the default HuggingFace dataset:
+
+```bash
+text2model --strategies cot --model gpt-4 --output-dir my_results --dataset-path my_dataset.csv
+python evals/evaluate.py --output-dir my_results --dataset-path my_dataset.csv
+```
+
 ## Evaluation
 
-After generating models, evaluate their correctness via `evaluate.py`. This script compiles and runs each generated MiniZinc model against test instances, checking for both execution success and solution correctness.
+After generating models, evaluate their correctness via [`evals/evaluate.py`](evals/evaluate.py). This script compiles and runs each generated MiniZinc model against test instances, checking for both execution success and solution correctness.
 
 #### Prerequisite
 
@@ -128,9 +182,15 @@ Install MiniZinc solver: https://www.minizinc.org/doc-2.5.5/en/installation.html
 ```bash
 # Evaluate all generated code
 # `--output-dir` is required. Point it at the directory produced by the batch-mode `text2model` run.
-python evaluate.py --output-dir my_results
+python evals/evaluate.py --output-dir my_results
+
+# Evaluate against a local dataset (e.g. one saved by `text2model --editor`) instead
+# of the default skadio/text2zinc HuggingFace dataset
+python evals/evaluate.py --output-dir my_results --dataset-path text2zinc_edited.csv
 ```
 
+Running the eval generates a JSON file (`evals/evaluation_results.json` by default, via `--output-json`) with your accuracy metrics. You can PR that file to the [Text2Model Leaderboard](https://huggingface.co/spaces/skadio/text2model-leaderboard) on Hugging Face to get your results added to the online leaderboard.
+
 #### Metrics
 
 | Metric | Description |
@@ -149,8 +209,6 @@ Text2Model hosts an online leaderboard tracking execution accuracy, solution acc
 
 ## Testing
 
-Install test dependencies with `pip install -e ".[test]"`.
-
 **Default tests** (`tests/test_main.py`, `tests/test_utils.py`) do not need an API key, network, or MiniZinc.
 They are pure logic tests with mocked API calls and is run by the CI:
 
@@ -179,15 +237,20 @@ text2model/
 │   │   ├── global_constraint_prompts/
 │   │   └── ...
 │   ├── knowledge_graphs/        # KG files (.ttl) for knowledge_graph strategy
+│   ├── editor/                  # Dataset editor GUI (`text2model --editor`)
+│   │   ├── app.py               # Flet app: browse/edit/execute Text2Zinc problems, AI chat assistant
+│   │   └── data/text2zinc.csv   # Bundled default dataset the editor opens on first run
 │   ├── grammar.mzn              # MiniZinc grammar for validation
 │   ├── main.py                  # Copilot strategies and CLI entry point
-│   └── utils.py                 # Shared utilities (API calls, validation)
+│   ├── generate_knowledge_graph.py  # Generates KGs for the knowledge_graph strategy
+│   └── utils.py                 # Shared utilities (API calls, validation, dataset loading)
 ├── tests/                       # Unit and integration tests (pytest)
-├── output/                      # Generated models (created automatically)
-│   ├── [model]/[strategy]/      # e.g., gpt-4/cot/problem_1.mzn
-│   └── evaluation_results/      # Accuracy metrics and leaderboard
-├── evaluate.py                  # Evaluates generated MiniZinc models
-├── generate_knowledge_graph.py  # Generates KGs for knowledge_graph strategy
+├── evals/                       # Evaluation tooling
+│   ├── evaluate.py              # Evaluates generated MiniZinc models
+│   ├── evaluation_results.json  # Latest evaluation results (PR-able to the HF leaderboard)
+│   └── results/                 # Accuracy metrics and leaderboard from paper runs
+├── output/                      # Original outputs per strategy, kept for reproducing paper results
+│   └── [model]/[strategy]/      # e.g., gpt-4/cot/problem_1.mzn
 ├── pyproject.toml               # Package metadata and install config
 ├── CHANGELOG.txt                # Release history
 └── LICENSE                      # Apache License 2.0

{text2model-1.0.0 → text2model-1.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "text2model"
-version = "1.0.0"
+version = "1.1.0"
 description = "LLM Modeling Copilots for Text-to-Model Translation"
 readme = "README.md"
 requires-python = ">=3.8"
@@ -20,11 +20,10 @@ dependencies = [
     "datasets",
     "tqdm",
     "langchain-ollama",
+    "flet==0.21.2",
+    "pytest",
 ]
 
-[project.optional-dependencies]
-test = ["pytest"]
-
 [tool.pytest.ini_options]
 markers = [
     "integration: hits a real external dependency (OpenAI API, MiniZinc binary). Skipped automatically when the credential/binary is missing, and always excluded in CI.",
@@ -43,4 +42,5 @@ include = ["text2model*"]
     "prompts/global_constraint_prompts/*.txt",
     "grammar.mzn",
     "knowledge_graphs/*.ttl",
+    "editor/data/*.csv",
 ]

text2model-1.1.0/text2model/editor/__init__.py

@@ -0,0 +1,10 @@
+"""Text2Zinc dataset editor (flet GUI). Launched via `text2model --editor`.
+
+Import of this subpackage is deliberately kept out of text2model/__init__.py
+and text2model/main.py's module scope, so plain `--problem`/Text2Zinc-mode
+invocations don't pay the cost of importing flet at startup; it's only
+imported inside the `--editor` CLI branch.
+"""
+from text2model.editor.app import launch
+
+__all__ = ["launch"]