.. _auto_mathmodel_save:

*SAVED MATHMODELS TO THE DATABASE*
==================================

Persists a trained ML model (or multi-model CSV manifest) to the d3VIEW Mathmodel database, attaching the model file and recording its input/target schema and overall score. Accepts a single model path, a comma-separated list of .pkl paths, or inline CSV content produced by an ML_PREDICT worker. Use this worker whenever a trained model needs to be registered and made available for downstream prediction or reporting workflows.

When to use
-----------

Tagged: ``attachment``, ``mathmodel``, ``ml``, ``ml_predict``, ``model_registry``, ``persist``, ``pkl``, ``save``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Name
     - name
     - text
     - —
     - ✓
     - Unique display name for the mathmodel record; must not already exist in the database — the worker will error if a model with this name is found.
   * - Model Path
     - model_path
     - textarea
     - —
     - ✓
     - Path to the trained model artifact; accepts (1) a single .pkl or CSV manifest file path, (2) a comma-separated list of .pkl file paths, or (3) raw inline CSV content (with newlines) as produced by an ML_PREDICT worker — the correct shape is detected automatically.
   * - Type
     - type
     - text
     - —
     - 
     - Optional free-text label describing the model or dataset type (e.g. 'regression', 'classifier', 'surrogate'); stored as metadata and does not affect execution.
   * - Description
     - description
     - textarea
     - —
     - 
     - Optional human-readable description of the model's purpose, training data, or usage notes; stored as metadata on the mathmodel record.
   * - Tags
     - tags
     - text
     - —
     - 
     - Optional comma-separated list of searchable tags to associate with the mathmodel record (e.g. 'crash,frontal,v1'); used for filtering in the model library.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - Mathmodel
     - mathmodel_id
     - integer
     - Integer primary-key ID of the newly created Mathmodel database record; pass this to downstream workers (e.g. ML_PREDICT, reporter) that reference a registered mathmodel.

Disciplines
-----------

- ai_ml.supervised.classification
- ai_ml.supervised.regression
- ai_ml.surrogate
- platform.integration

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>platform</code> schema. Worker id: <code>mathmodel_save</code>. Schema hash: <code>197820861ebe</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>