Skip to main content

Naming Contract

This document defines the canonical naming contract for the SiMa NEAT codebase.

Canonical names​

  • Product name: SiMa NEAT
  • CMake project: SimaNeat
  • C++ namespace: simaai::neat
  • Core runtime types: Model, Session, Run

Public include surface​

Use headers under include/ as the public source of truth.

Examples:

#include "model/Model.h"
#include "pipeline/Session.h"
#include "pipeline/Run.h"

Legacy aliases​

Legacy names are supported only as compatibility references and migration guides.

  • PipelineSession -> Session
  • PipelineRun -> Run
  • NeatModel -> Model
  • InputAppSrc -> Input
  • OutputAppSink -> Output

Do not introduce new public docs/examples using legacy symbols.

Policy​

  • New user-facing docs must use canonical names.
  • Legacy terms are allowed only in migration notes, compatibility comments, or clearly marked deprecation sections.
  • CI enforces this via scripts/ci/check_naming_and_conflicts.sh.