Skip to main content

Vanguard Modeling Language compiler for agentic AI

Project description

Vanguard Modeling Language

Vanguard Modeling Language is an open-source modeling language compiler aimed to complement agentic AI development in order to define the logics and requirements of prompts into a fixed format in order to mitigate consistency of results among different AI agent models.

Repository: github.com/Selkomark/vanguard-modeling-language

Contributors and AI assistants: see AGENTS.md for project scope and architecture, and TODO.md for the roadmap.

Scope

VML is a compile-time DSL compiler: .vml source in, static artifacts (dist/prompts, dist/finetune, dist/flows, dist/flags, dist/judges, dist/manifest.json) out. It does not call LLMs, invoke MCP, run conversations, or manage session/context state — that belongs to whatever downstream platform consumes these artifacts, not this repo.

Meant to be consumed as a dependency by other projects, e.g. as a git submodule plus pip install -e path/to/vanguard-modeling-language, or via PyPI once published. For integrating VML into a Python or TypeScript project — install, config, and runnable examples of loading compiled artifacts — see docs/integration.md.

Environment

Use a dedicated environment before installing (Python 3.10+).

venv (stdlib)

python3 -m venv .venv
source .venv/bin/activate   # macOS/Linux

On Windows: .venv\Scripts\activate

conda

conda create -n vml python=3.10   # or 3.11+
conda activate vml

Install

Once published to PyPI:

pip install vanguard-modeling-language

From source, with the environment active:

pip install -e ".[dev]"

Requires Python 3.10+.

Compile a project

vml compile examples/support_project

By default, artifacts are written to <project>/dist. Override with --out:

vml compile examples/support_project --out ./build

Outputs (under dist/ by default):

Path Description
dist/prompts/<Model>.md Rendered system prompt + constraints
dist/finetune/openai/<Model>.jsonl OpenAI chat fine-tuning JSONL
dist/finetune/anthropic/<Model>.jsonl Claude fine-tuning JSONL (Amazon Bedrock format — Anthropic has no hosted fine-tuning API)
dist/finetune/gemini/<Model>.jsonl Gemini supervised fine-tuning JSONL (Vertex AI format)
dist/flows/<Flow>.flow.json Conversation flow IR
dist/flags/<Flow>.flags.json Flag definitions
dist/judges/<Judge>.judge.md Judge validation prompts
dist/manifest.json Project artifact index

Validate without writing files:

vml compile examples/support_project --check-only

Language features

  • Models with extends, use logic, implements traits
  • Flows with stages, routing, flags, MCP actions, and judges
  • Imports for DRY composition across .vml files

See docs/language.md and docs/orchestrator.md.

VS Code extension

Editor support (syntax highlighting, snippets, compile diagnostics) lives in vscode-extension/.

Try in development

  1. Open vscode-extension/ in VS Code (or the whole repo).
  2. Press F5 (Run Extension) to open an Extension Development Host.
  3. In that window, open a folder with vml.json (e.g. examples/support_project) and edit .vml files.

Install a VSIX

cd vscode-extension
vsce package    # requires: npm install -g @vscode/vsce

Then in VS Code: ExtensionsInstall from VSIX…

The extension runs vml compile <project> --check-only when you save or open .vml files. Install the compiler (pip install -e .) so vml is on your PATH (or set vml.compilerPath in settings).

Tests

pytest

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

vanguard_modeling_language-1.0.0.tar.gz (37.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vanguard_modeling_language-1.0.0-py3-none-any.whl (25.4 kB view details)

Uploaded Python 3

File details

Details for the file vanguard_modeling_language-1.0.0.tar.gz.

File metadata

File hashes

Hashes for vanguard_modeling_language-1.0.0.tar.gz
Algorithm Hash digest
SHA256 f235007d6a672fafcb6944b6b5b87e777329910d2e4ce4ab79576f9c298ffdcf
MD5 55910b2de0b9f85a8debf8b15165d851
BLAKE2b-256 44bbcd9a0afb462a61b6ba1632ca416609cbcc4bccdfff997cfcffba15ac1888

See more details on using hashes here.

Provenance

The following attestation bundles were made for vanguard_modeling_language-1.0.0.tar.gz:

Publisher: publish.yml on Selkomark/vanguard-modeling-language

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vanguard_modeling_language-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for vanguard_modeling_language-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6dd60afb6b639dada88d868aed62ea1820b4bf4100200753aaae044fda373fb0
MD5 253934093cbabddad17e217d151747e3
BLAKE2b-256 5676b92b0f82196e78cf5427f18acd4d74864128b1dd9bbf9b1539746b4738f2

See more details on using hashes here.

Provenance

The following attestation bundles were made for vanguard_modeling_language-1.0.0-py3-none-any.whl:

Publisher: publish.yml on Selkomark/vanguard-modeling-language

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page