CIT AI Model Simulator
The CIT AI Model Simulator is a deterministic local service for CIT courses. It gives students who cannot run an approved local model a hardware-neutral fallback, and it gives students and instructors reproducible conditions for testing model-client behavior. It presents the small OpenAI-compatible HTTP surface used by the course without claiming to be an AI model or a complete llama.cpp replacement.
Responses come from versioned scenario state graphs rather than unrestricted text generation. The simulator labels its identity and all simulated timing and token evidence, listens only on the local computer by default, does not execute model-requested tools, and writes append-only evidence logs for debugging and course work.
The current implementation includes the M0/M1 Week 1 server baseline and the first data-driven interaction layer. Later-lab capabilities such as model-emitted tool calls, context shifting, compaction, protected validation, and evaluation reports remain deliberately incremental.
Install for development
python -m venv .venv-dev
.venv-dev\Scripts\python -m pip install -e .
On macOS or Linux, use .venv-dev/bin/python instead.
Start the full simulator experience
The package has three distinct components:
| Component | Invocation or module | Responsibility |
|---|---|---|
| Interaction-graph engine | Internal engine used by serve |
Load the active YAML scenario, track session state, and select declared transitions and responses |
| Model Simulator | cit-simulator serve |
Provide the model-compatible and graph-control APIs on port 8081 |
| User Simulator | cit-simulator run |
Present terminal choices, expose user-input handoff on port 8082, and communicate with the Model Simulator over HTTP |
Start the Model Simulator in the first terminal:
cit-simulator serve
Leave it running, then start the User Simulator in a second terminal:
cit-simulator run
The default Model Simulator URL is http://127.0.0.1:8081. The default User Simulator URL is http://127.0.0.1:8082. run does not load a scenario or instantiate a model engine; it creates a session through the Model Simulator's control API and follows the scenario selected by serve.
Useful commands:
cit-simulator --help
cit-simulator validate
cit-simulator preview
cit-simulator test
cit-simulator serve --port 8081 --acceleration 20
cit-simulator run
cit-simulator run --harness
cit-simulator run starts the User Simulator only after it confirms that a compatible Model Simulator is running. It displays numbered choices obtained through the graph-control API, labels the selected message as User Simulator Prompt:, sends it to the Model Simulator over HTTP, and visually renders the returned deterministic response beneath Model Simulator Response:. Internal session, scenario, option-ID, and graph-state details are hidden unless --show-details is used.
The packaged Lab 1 interaction is a guided simulator orientation. Students can explore how predefined prompt choices and simulated responses work, learn the package's principal commands and display options, and finish with a hands-on practice checklist. It does not mention or require system prompts, tools, request packaging, or a student harness.
The two terminals report only their own activity. The run terminal reports prompt submission and response receipt as User Simulator Activity. The serve terminal reports actual model requests, scenario matches, and response statuses as Model Simulator Activity. Internal control traffic is omitted from the default Model Simulator log. --show-details expands User Simulator information, --verbose enables lower-level diagnostics for the invoked component, and --no-activity suppresses activity for that component. --no-animation disables progressive terminal rendering in the User Simulator.
For later labs, harness mode lets a student implementation poll the User Simulator on port 8082 for the canonical selected prompt, add its own system prompt, history, tools, and response settings, and submit the resulting request to the Model Simulator on port 8081. Later scenarios can reject unexpected packaging with structured, field-level differences.
Week 1 API
Learner-facing endpoints:
GET /healthGET /v1/healthGET /v1/modelsPOST /v1/chat/completionsPOST /v1/chat/completions/input_tokens
Interaction-engine control endpoints hosted by the Model Simulator:
GET /sim/v1/infoPOST /sim/v1/sessionsGET /sim/v1/sessions/{id}GET /sim/v1/sessions/{id}/optionsPOST /sim/v1/sessions/{id}/selectGET /sim/v1/sessions/{id}/user-inputPOST /sim/v1/sessions/{id}/resetGET /sim/v1/sessions/{id}/evidence
User Simulator endpoints on port 8082:
GET /healthGET /sim/v1/infoGET /sim/v1/sessions/{id}/user-input
Create a session before a reproducible run:
curl -X POST http://127.0.0.1:8081/sim/v1/sessions \
-H "Content-Type: application/json" \
-d "{\"seed\": 49501, \"attempt_number\": 1}"
Pass the returned session ID in the X-CIT-Sim-Session request header. A chat request without that header receives a newly created session ID in the response header, which is convenient for simple compatibility checks but should not be used for graded multi-request attempts.
Scenario data
The built-in service baseline, Lab 1 orientation, and later harness-validation scenarios are YAML data packaged separately from both HTTP adapters and the graph engine. serve alone selects and loads the scenario; run discovers that active scenario through the Model Simulator. Each lab can supply another YAML file without changing the Python implementation:
cit-simulator serve --scenario path/to/scenario.yaml
Validate it before use:
cit-simulator validate path/to/scenario.yaml
A branching scenario declares its prompt options on transitions. Each option has a short terminal label and one explicit canonical user prompt. The same transition can declare request expectations such as a required system message, minimum history length, required system-prompt phrases, and required tool names. Responses, next states, timing, and context limits remain scenario data as well.
Evidence and privacy
The server writes one append-only JSON Lines file per session beneath the selected evidence directory. Logs contain structural summaries, counts, identifiers, and hashes rather than raw prompts or credentials. Evidence fields explicitly label the backend as simulator, token counts as approximate, and timing as simulated.
Do not treat simulator TTFT, TPS, or token estimates as measurements of a student's hardware or of a real model.
Specification
The architecture and behavioral authority is TECHNICAL_SPECIFICATION.md. The implementation must not silently weaken its observable contract. Features beyond M1 are future milestones unless the changelog states otherwise.
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 cit_ai_model_simulator-0.5.0.tar.gz.
File metadata
- Download URL: cit_ai_model_simulator-0.5.0.tar.gz
- Upload date:
- Size: 65.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4a372d01f1c01dd1dd39f7d5a9c6c2de57497511de6eaf0d984d95d74c99d3c5
|
|
| MD5 |
3b2690e7b620796acf816065d459844b
|
|
| BLAKE2b-256 |
9dacf64616b113656046b9ab48a77f16ff419bdd2f3d7461bdec7592ab1a469f
|
File details
Details for the file cit_ai_model_simulator-0.5.0-py3-none-any.whl.
File metadata
- Download URL: cit_ai_model_simulator-0.5.0-py3-none-any.whl
- Upload date:
- Size: 39.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5fb13ffbabfe621df70e9d04748d05abaef455dbb0be98490b9c5c709b34e88c
|
|
| MD5 |
0777716c6e2c8ee0b2f0a772b30a18ad
|
|
| BLAKE2b-256 |
963025959cd9b57eddbaaea40153e14ca414fb9d1020af86f10f4fde55eeedc1
|