Stable API

TokLang.jl follows semantic versioning. Its public API is what the reference pages of this manual list:

  • the names exported from TokLang: Independent core;
  • the functions and types of the modules TokLang.Engine, TokLang.Sim and TokLang.Fit on the pages Engine, Native simulation and Calibration, reached through the module (TokLang.Engine.check);
  • the fit_bayes function of TokLang.Fit, available when Turing.jl is loaded.

Within 1.x, a public function keeps working with the same arguments and keyword arguments, and the fields of its documented result stay. New functions, new keyword arguments and new fields can be added in a minor version. Everything else (names that are not listed in the reference, including the modules TokLang.JSON and TokLang.Stats and the fields of SimModel) is internal and may change in any release.

The text of diagnostic messages and the exact numbers of a simulation with a given seed are not part of the API; the diagnostic codes are. The language itself has its own compatibility promise, which holds for every release 1.x.