Skip to content

Spec

ModelParams

Bases: MaterialParams

Model parameters.

Source code in digitalhub_ml/entities/model/spec.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
class ModelParams(MaterialParams):
    """
    Model parameters.
    """

    path: str
    """Path to the model."""

    framework: str = None
    """Model framework (e.g. 'pytorch')."""

    algorithm: str = None
    """Model algorithm (e.g. 'resnet')."""

    base_model: str = None
    """Base model."""

    parameters: dict = None
    """Model parameters."""

    metrics: dict = None
    """Model metrics."""

algorithm: str = None

Model algorithm (e.g. 'resnet').

base_model: str = None

Base model.

framework: str = None

Model framework (e.g. 'pytorch').

metrics: dict = None

Model metrics.

parameters: dict = None

Model parameters.

path: str

Path to the model.

ModelParamsHuggingface

Bases: ModelParams

Huggingface model parameters.

Source code in digitalhub_ml/entities/model/spec.py 
138
139
140
141
142
143
144
145
146
class ModelParamsHuggingface(ModelParams):
    """
    Huggingface model parameters.
    """

    model_id: str = None
    """Huggingface model id. Optional. If not specified, the model is loaded from the model path"""
    model_revision: str = None
    """Huggingface model revision. Optional."""

model_id: str = None

Huggingface model id. Optional. If not specified, the model is loaded from the model path

model_revision: str = None

Huggingface model revision. Optional.

ModelParamsMlflow

Bases: ModelParams

Mlflow model parameters.

Source code in digitalhub_ml/entities/model/spec.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
class ModelParamsMlflow(ModelParams):
    """
    Mlflow model parameters.
    """

    flavor: str = None
    """Mlflow model flavor."""
    model_config: dict = None
    """Mlflow model config."""
    input_datasets: list[Dataset] = None
    """Mlflow input datasets."""
    signature: Signature = None
    """Mlflow model signature."""

flavor: str = None

Mlflow model flavor.

input_datasets: list[Dataset] = None

Mlflow input datasets.

model_config: dict = None

Mlflow model config.

signature: Signature = None

Mlflow model signature.

ModelParamsModel

Bases: ModelParams

Model parameters.

Source code in digitalhub_ml/entities/model/spec.py 
59
60
61
62
class ModelParamsModel(ModelParams):
    """
    Model parameters.
    """

ModelParamsSklearn

Bases: ModelParams

SKLearn model parameters.

Source code in digitalhub_ml/entities/model/spec.py 
111
112
113
114
class ModelParamsSklearn(ModelParams):
    """
    SKLearn model parameters.
    """

ModelSpec

Bases: MaterialSpec

Model specifications.

Source code in digitalhub_ml/entities/model/spec.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
class ModelSpec(MaterialSpec):
    """
    Model specifications.
    """

    def __init__(
        self,
        path: str,
        framework: str | None = None,
        algorithm: str | None = None,
        base_model: str | None = None,
        parameters: dict | None = None,
        metrics: dict | None = None,
    ) -> None:
        self.path = path
        self.framework = framework
        self.algorithm = algorithm
        self.base_model = base_model
        self.parameters = parameters
        self.metrics = metrics

ModelSpecHuggingface

Bases: ModelSpec

Huggingface model specifications.

Source code in digitalhub_ml/entities/model/spec.py 
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
class ModelSpecHuggingface(ModelSpec):
    """
    Huggingface model specifications.
    """

    def __init__(
        self,
        path: str,
        framework: str | None = None,
        algorithm: str | None = None,
        base_model: str | None = None,
        parameters: dict | None = None,
        metrics: dict | None = None,
        model_id: str | None = None,
        model_revision: str = None,
    ) -> None:
        super().__init__(path, framework, algorithm, base_model, parameters, metrics)
        self.model_id = model_id
        self.model_revision = model_revision

ModelSpecMlflow

Bases: ModelSpec

Mlflow model specifications.

Source code in digitalhub_ml/entities/model/spec.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
class ModelSpecMlflow(ModelSpec):
    """
    Mlflow model specifications.
    """

    def __init__(
        self,
        path: str,
        framework: str | None = None,
        algorithm: str | None = None,
        base_model: str | None = None,
        parameters: dict | None = None,
        metrics: dict | None = None,
        flavor: str | None = None,
        model_config: dict | None = None,
        input_datasets: list[Dataset] | None = None,
        signature: Signature = None,
    ) -> None:
        super().__init__(path, framework, algorithm, base_model, parameters, metrics)
        self.flavor = flavor
        self.model_config = model_config
        self.input_datasets = input_datasets
        self.signature = signature

ModelSpecModel

Bases: ModelSpec

Model specifications.

Source code in digitalhub_ml/entities/model/spec.py 
53
54
55
56
class ModelSpecModel(ModelSpec):
    """
    Model specifications.
    """

ModelSpecSklearn

Bases: ModelSpec

SKLearn model specifications.

Source code in digitalhub_ml/entities/model/spec.py 
105
106
107
108
class ModelSpecSklearn(ModelSpec):
    """
    SKLearn model specifications.
    """