Model catalog and documentation

Models on the Timefold Platform help solve specific planning problems. Here we explain what documentation is available, mention demo data, how models are versioned, and which maturity levels we define.

Documentation

Each model has a Documentation section that helps you understand if they are the right solution for you, as well as how to use the model.

  • The Information page explains what type of problems the model can be used for and which features it supports.

  • The Documentation pages include documentation that show you how to get started and explain the features of a model.

  • The OpenAPI Spec interface gives a complete overview of the model’s API. Models use the OpenAPI standards.

Demo data

Each model comes with demo data. You can fetch this demo data via the model’s API, or you can use the platform’s UI to start a run with demo data. Doing a run with this demo data will give you good insight into the models' working and the supported constraints. The visualization of the model will show you the optimized planning solution. Demo data is an ideal way to get to know a model.