Models installation¶

The Models component provides the analytical and predictive model services used by CVDLink.

Responsible team: Jad.

Status of this page¶

Installation instructions for this component are not yet available. The component is maintained by a separate team, and its installation material has not been provided to the documentation.

This page is a placeholder so that the component appears in its correct position in the installation sequence. It will be completed when the material is received.

Information required¶

To complete this page, the following is needed from the responsible team.

Packaging. Whether the component is distributed as a Docker image, and if so its name, tag, and registry, or the location of an exported archive for installations without registry access.

Prerequisites. Any requirement beyond Docker Engine and Compose, in particular hardware requirements where the models require a graphics processor or a substantial amount of memory.

Configuration. The environment variables or configuration files the component requires, including how it is pointed at the database and at the Metadata component, and which values differ between central and standalone deployments.

Network. The ports the component listens on, and which other components initiate connections to it.

Installation procedure. The sequence of commands needed to install and start the component, including any initialisation step such as downloading model weights or preparing a schema.

Verification. A command or request that confirms a correct installation, together with the expected result.

Dependencies. Whether this component must be installed before or after the Metadata component, and whether the other components require configuration changes once it is present.

Integration. How the Metadata component is configured to use the models, and whether the models require any database schema of their own.

Interim guidance¶

Until this page is completed, installations requiring the Models component should request instructions directly from the responsible team. The remaining components function without it.