modelpackage.h

Go to the documentation of this file.

#pragma once
 
#include "transcription/transcriptiontypes.h"
 
#include <QJsonObject>
 
#include <optional>
#include <vector>
 
struct ModelCompatibilityMarker {
    QString engine;
    QString modelFormat;
};
 
struct ModelAssetMetadata {
    QString role;
    QString relativePath;
    QString sha256;
    qint64 sizeBytes = 0;
};
 
struct ModelPackageManifest {
    QString format;
    int schemaVersion = 0;
    ModelMetadata metadata;
    std::vector<ModelCompatibilityMarker> compatibleEngines;
    std::vector<ModelAssetMetadata> assets;
    QString sourceArtifact;
};
 
struct ValidatedModelPackage {
    QString packageRootPath;
    QString manifestPath;
    QString sourcePath;
    QString weightsPath;
    ModelPackageManifest manifest;
 
    [[nodiscard]] const ModelMetadata &metadata() const { return manifest.metadata; }
 
    [[nodiscard]] bool isLegacyCompatibility() const { return manifest.metadata.legacyCompatibility; }
 
    [[nodiscard]] QString description() const;
};
 
[[nodiscard]] QString cpuReferenceEngineName();
 
[[nodiscard]] QString cpuReferenceModelFormat();
 
[[nodiscard]] QString legacyWhisperEngineName();
 
[[nodiscard]] QString legacyWhisperModelFormat();
 
[[nodiscard]] bool modelPackageSupportsCompatibility(const ModelPackageManifest &manifest,
                                                     QStringView engine,
                                                     QStringView modelFormat);
 
[[nodiscard]] QString defaultModelPackageDirectory();
 
[[nodiscard]] QString sanitizePackageId(const QString &value);
 
[[nodiscard]] QJsonObject modelPackageManifestToJson(const ModelPackageManifest &manifest);
 
[[nodiscard]] std::optional<ModelPackageManifest> modelPackageManifestFromJson(const QJsonObject &root, QString *errorMessage = nullptr);