Applications

A Marigold application is a declared set of models plus the code that uses them, packaged as one archive and run against a shared platform. It is a directory holding:

  • marigold.toml: the application’s name and how it runs;
  • one or more models.yaml files: the models it uses;
  • its code, data and a README.md.

An application holds no model weights. The platform downloads the declared models into a cache shared by every application on the host.

Three layers

Layer What it is How many
Platform model cache, catalogue, worker and API one per host
Application an archive installed into the cache by name any number
Instance an application’s code running in its own container one or more per application

An instance reaches the platform only through the API. Many instances share one cache and one worker, which is what lets a set of applications run on a single local GPU, and the same application run unchanged on larger hardware.

What applications are for

Anything that drives models through the API:

  • an agent loop around an instruct model;
  • a document pipeline: extract text, embed, classify, summarise;
  • a benchmark that records timing, tokens and power per request;
  • a conformance test for the platform itself.

Models are not limited to text: see Model types.

What is stable

An application depends on four interfaces. They are what a port or a new application is written against:

Interface Where Status
marigold.toml and models.yaml Building stable; new keys are additions
The instance contract: mounts, environment, network Building stable
The API: submit, poll, outputs, OpenAI-compatible endpoints API stable routes; new model types are additions
The registry index, protocol: 1 Publishing stable; a breaking change takes a new protocol number
Manifests and digests Manifests stable

From source to running

Step Command Page
Write the application marigold.toml, models.yaml, code Building
Package it marigold application create Building
Publish a registry marigold registry build, GitHub Actions Publishing
Find applications marigold application search, a catalogue Finding
Install one marigold application install <name> Installing
Download its models marigold cache populate <name> Installing
Run it marigold application start <name> Installing

Source of this page on GitHub