A library for generating artificial structured texts of advice from narrative, emotional, and world-context templates.
Project description
NarrEmGen: Narrative Generation Pipeline (CLI & GUI)
Narremgen is a Python package for structured narrative text generation, combining narrative schemas (SN) and emotional dynamics (DE) to produce coherent short texts assembled into full booklets of advice or answers from a topic or a question with optional chapters. It provides a reproducible multi-batch pipeline for controlled text generation using LLM models with narrative+emotional structures with:
- Implementing Partially The SN/DE/K Method For a Controlled Generation
- Artificial structured advice micro-texts from narrative, emotional, context
- Writing in file Full Booklets of Advice or Answers from a Topic or Question
- Suitable for education & learning, or comparing and training the llm output
- Process data with five different llm calls from key in file or in environment
- Available: command lines, graphical user interface, or python programming
Main modules of narremgen
pipeline: Entry point for batch generation, variants, stats, and exports per topic run.llmcore: Unified LLM router (role→model mapping, retries, multi-provider support).data: Input preparation and CSV handling for topic–advice–prompt-based generation.narratives: Text post-processing, style control, and SN/DE-aware narrative realization.variants: Planning and batch rewriting into alternative styles (direct, formal, etc.) with stats.themes: LLM-based theme discovery and assignment for advice corpora, producing themes+assignments.chapters: Build chaptered corpora (CSV/JSON) from themes or manual grouping, for book-like exports.export: Plain-text and LaTeX exporters (merged.txtandbook_*.texfrom neutral and variants).analyzestats: Length, lexical, emotion and SN/DE distribution analysis, with CSV summaries and plots.utils: Shared helpers for workdirs, filenames, CSV repair, backups, and neutral corpus construction.gui: Optional Tkinter GUI for generation, or readings aligned/selected texts, or segmentation.main: Optional command-line terminal module for the generation with input arguments.
Key features
- Generation of a Corpus of Stories (of varying and controlled structures) and Formal Texts for advice from a topic (full sentence).
- Multi-batch narrative pipeline using a configurable LLM router (
llmcore) across several providers with a command-line interface. - Automatic topic and advice mapping, SN/DE-structured neutral generation, and aligned variant rewriting (direct, formal, other styles).
- Robust CSV workflow: filtering, renumbering, safe merging of advice/sentence/context/mapping, consistent filenames, variant workdirs.
- LLM-driven theme extraction and assignment, plus chapter construction for organizing texts into coherent sections (classes of texts).
- Plain-text and TeX export of neutral and variant corpora (merged narrative files and full chaptered books for text reading/selection).
- Integrated corpus analysis: lexical richness, length, emotion profiles, and SN/DE distributions, including neutral vs. variant comparison.
- Textual statistics and emotion statistics of specialized language models from the literature for evaluation of generated texts or corpus.
- Ready-to-use structure for reproducible experiments in text generation with emotions for character and educational content synthesis.
- Graphical user interface for generation with api key checkings, creation of variants, and reading/selection of aligned textes for a topic.
- Available connection to OpenAI, OpenRouter, Google-GenAI, Mistral, etc for text generation (see python code and interface for dry-run).
- No limited length for topic str, available command for adding file/str long text as context for advice or generation stages in pipeline.
- Input in the pipeline a list of pre-written advice with a csv table path with col name Advice, or prefer a dedup automatically generated.
Output: Each generated corpus is stored under outputs/ in CSV and TXT format.
The naming convention is: outputs/<corpus_name>_1/ for its directory.
Each directory contains:
topic, advice, and mapping tables in csv format and generated texts
and two subdirectories containing generated batched texts + csv files
plus directories for variants with statistics + chaptered tex files
Note: This package is provided “as is” for the research and educational purposes.
The code was written/debogged in iterative way with help of gpt5 openai + vs code.
All texts generated are synthetic and intended for future experimentations only.
Last version in directory package for pypi.
To do: improve genericity, generality and robutness, add parallelism, classes re-factor.
Installation
pip install narremgen
Ask for help and the first examples in the cli
narremgen --help
Usage from cli, examples of command lines
OpenAI gpt4o as the default model (use also sys env key OPENAI_API_KEY instead of txt file) + export TeX booklet
narremgen --topic "Small walks, big effects" --default-model "openai\gpt-4o-mini" --export-book-tex
OpenRouter for DeepSeek for mapping, Llama for narrative, GPT-4o-mini for the rest + multiple variants
narremgen --topic "Walk habits in the city" --model-advice "openrouter\openai/gpt-4o-mini" --model-mapping "openrouter\deepseek/deepseek-reasoner" --model-context "openrouter\openai/gpt-4o-mini" --model-narrative "openrouter\meta-llama/llama-3.1-70b-instruct" --model-variants-generation "openrouter\openai/gpt-4o-mini"
Mistral direct (OpenAI-compatible api, use sys env key) + themes enabled with custom range and batch size
narremgen --topic "Healthy routines for a walk everyday" --default-model "mistral\mistral-large-latest" --themes-min 1 --themes-max 15 --themes-batch-size 30
Grok default (use sys env key) + bypass variants generation to local Phi-4 (Ollama) with larger token budget
narremgen --topic "Walking around in a small town" --default-model "xai\grok-2-latest" --model-variants-generation "ollama\phi4:14b" --variant-batch-size 40 --variant-max-tokens 2500
Quick connectivity check (no files generated): diagnostic dry-run with longer timeout to check which models are available
narremgen --diagnostic-dry-run --request-timeout 90 --model-theme-analysis "ollama\\phi3-chat:latest" --model-advice "ollama\\phi3-chat:latest" --model-mapping "ollama\\phi3-chat:latest" --model-context "ollama\\phi3-chat:latest" --model-narrative "google\\gemini-2.0-flash"
Launch call for GUI
# Interface generation+reading+saving
python -m narremgen.gui
Custom calls with python programming for pipeline
from importlib.resources import files
from narremgen import LLMConnect, run_pipeline
LLMConnect.init_global(default_model="openai/gpt-4o-mini")
assets_dir = str(files("narremgen").joinpath("settings"))
run_pipeline(
topic="Walking in the city",
workdir="./outputs",
assets_dir=assets_dir,
n_batches=2,
n_per_batch=20,
output_format="txt",
verbose=False,
)
Custom calls with python programming for llmcore
| Provider | Required env variables or key file | Model example (provider\\model) |
|---|---|---|
| OpenAI | OPENAI_API_KEY |
openai\\gpt-4o-mini |
| Mistral | MISTRAL_API_KEY |
mistral\\mistral-small-latest |
| xAI / Grok | XAI_API_KEY or GROK_API_KEY |
xai\\grok-2-mini |
| Gemini/Google | GEMINI_API_KEY or GOOGLE_API_KEY |
gemini\\gemini-2.0-flash |
| Ollama (local) | OLLAMA_HOST (optional) |
ollama\\llama3.2:3b |
| OpenRouter | OPENROUTER_API_KEY |
openrouter\\anthropic/claude-3.5-sonnet |
from narremgen.llmcore import LLMConnect
llm = LLMConnect(
default_model="ollama\\phi3-chat:latest",
max_tokens=400,
request_timeout=60,
)
messages = [
{"role": "system", "content": "Answer concisely."},
{"role": "user", "content": "Write 3 advice for walking in a city, 1 sentence each."},
]
reply = llm.safe_chat_completion(model="gemini\\gemini-2.0-flash", messages=messages)
print(reply)
Warning
- Only informed users or trainers should use this system in practice.
- Some advice may be missing or mistaken du to ia/programming.
- In future automatic checkings may be implemented for end user.
- Always do a dry-run before launching to check models in use.
References
- Rodolphe Priam (2025). Narrative and Emotional Structures For Generation Of Short Texts For Advice, hal-05135171, 2025.
© NarrEmGen Project, 2025-2026.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file narremgen-0.9.6.tar.gz.
File metadata
- Download URL: narremgen-0.9.6.tar.gz
- Upload date:
- Size: 866.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9a9eceddea30e3d0f1df453afbc2bf87ed5ccb518a7ef70ab9fafcf8ef518f1d
|
|
| MD5 |
ed92390f0d05dc83f24a0b95c8e27c25
|
|
| BLAKE2b-256 |
1676d90f399cf4fcc320b94efa0858e5412aca40a5778aecf63af7588a47150a
|
File details
Details for the file narremgen-0.9.6-py3-none-any.whl.
File metadata
- Download URL: narremgen-0.9.6-py3-none-any.whl
- Upload date:
- Size: 873.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7ad2c8ffddb12e6391aaf9052fbe2a20bf624fadc623e81dc6acbd00cfc6deba
|
|
| MD5 |
6e4685231135323545153872cb51e10f
|
|
| BLAKE2b-256 |
0bbeeb40cb952522d9b1d4aaeb1059079c47725c513343e62b39db9a0cea6a44
|