-
Notifications
You must be signed in to change notification settings - Fork 14
/
service.py
168 lines (133 loc) · 6.04 KB
/
service.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# This Software (Dioptra) is being made available as a public service by the
# National Institute of Standards and Technology (NIST), an Agency of the United
# States Department of Commerce. This software was developed in part by employees of
# NIST and in part by NIST contractors. Copyright in portions of this software that
# were developed by NIST contractors has been licensed or assigned to NIST. Pursuant
# to Title 17 United States Code Section 105, works of NIST employees are not
# subject to copyright protection in the United States. However, NIST may hold
# international copyright in software created by its employees and domestic
# copyright (or licensing rights) in portions of software that were assigned or
# licensed to NIST. To the extent that NIST holds copyright in this software, it is
# being made available under the Creative Commons Attribution 4.0 International
# license (CC BY 4.0). The disclaimers of the CC BY 4.0 license apply to all parts
# of the software developed or licensed by NIST.
#
# ACCESS THE FULL CC BY 4.0 LICENSE HERE:
# https://creativecommons.org/licenses/by/4.0/legalcode
"""The server-side functions that perform experiment endpoint operations."""
import datetime
from typing import List, Optional
import structlog
from injector import inject
from mlflow.exceptions import RestException
from structlog.stdlib import BoundLogger
from mitre.securingai.restapi.app import db
from mitre.securingai.restapi.shared.mlflow_tracking.service import (
MLFlowTrackingService,
)
from .errors import (
ExperimentAlreadyExistsError,
ExperimentMLFlowTrackingAlreadyExistsError,
ExperimentMLFlowTrackingDoesNotExistError,
ExperimentMLFlowTrackingRegistrationError,
)
from .model import (
Experiment,
ExperimentRegistrationForm,
ExperimentRegistrationFormData,
)
from .schema import ExperimentRegistrationFormSchema
LOGGER: BoundLogger = structlog.stdlib.get_logger()
class ExperimentService(object):
@inject
def __init__(
self,
experiment_registration_form_schema: ExperimentRegistrationFormSchema,
mlflow_tracking_service: MLFlowTrackingService,
) -> None:
self._experiment_registration_form_schema = experiment_registration_form_schema
self._mlflow_tracking_service = mlflow_tracking_service
def create(
self,
experiment_registration_form_data: ExperimentRegistrationFormData,
**kwargs,
) -> Experiment:
log: BoundLogger = kwargs.get("log", LOGGER.new())
experiment_name: str = experiment_registration_form_data["name"]
if self.get_by_name(experiment_name, log=log) is not None:
raise ExperimentAlreadyExistsError
timestamp = datetime.datetime.now()
experiment_id: int = self.create_mlflow_experiment(experiment_name)
new_experiment: Experiment = Experiment(
experiment_id=experiment_id,
name=experiment_name,
created_on=timestamp,
last_modified=timestamp,
)
db.session.add(new_experiment)
db.session.commit()
log.info(
"Experiment registration successful",
experiment_id=new_experiment.experiment_id,
)
return new_experiment
def create_mlflow_experiment(self, experiment_name: str) -> int:
try:
experiment_id: Optional[
str
] = self._mlflow_tracking_service.create_experiment(experiment_name)
except RestException as exc:
raise ExperimentMLFlowTrackingRegistrationError from exc
if experiment_id is None:
raise ExperimentMLFlowTrackingAlreadyExistsError
return int(experiment_id)
def delete_experiment(self, experiment_id: int, **kwargs) -> List[int]:
log: BoundLogger = kwargs.get("log", LOGGER.new()) # noqa: F841
experiment: Optional[Experiment] = self.get_by_id(experiment_id=experiment_id)
if experiment is None:
return []
reply: Optional[bool] = self._mlflow_tracking_service.delete_experiment(
experiment_id=experiment_id
)
if reply is None:
raise ExperimentMLFlowTrackingDoesNotExistError
experiment.update(changes={"is_deleted": True})
db.session.commit()
return [experiment_id]
def rename_experiment(
self, experiment: Experiment, new_name: str, **kwargs
) -> Experiment:
log: BoundLogger = kwargs.get("log", LOGGER.new()) # noqa: F841
reply: Optional[bool] = self._mlflow_tracking_service.rename_experiment(
experiment_id=experiment.experiment_id, new_name=new_name
)
if reply is None:
raise ExperimentMLFlowTrackingDoesNotExistError
experiment.update(changes={"name": new_name})
db.session.commit()
return experiment
@staticmethod
def get_all(**kwargs) -> List[Experiment]:
log: BoundLogger = kwargs.get("log", LOGGER.new()) # noqa: F841
return Experiment.query.filter_by(is_deleted=False).all() # type: ignore
@staticmethod
def get_by_id(experiment_id: int, **kwargs) -> Optional[Experiment]:
log: BoundLogger = kwargs.get("log", LOGGER.new()) # noqa: F841
return Experiment.query.filter_by( # type: ignore
experiment_id=experiment_id, is_deleted=False
).first()
@staticmethod
def get_by_name(experiment_name: str, **kwargs) -> Optional[Experiment]:
log: BoundLogger = kwargs.get("log", LOGGER.new())
log.info("Lookup experiment by unique name", experiment_name=experiment_name)
return Experiment.query.filter_by( # type: ignore
name=experiment_name, is_deleted=False
).first()
def extract_data_from_form(
self, experiment_registration_form: ExperimentRegistrationForm, **kwargs
) -> ExperimentRegistrationFormData:
log: BoundLogger = kwargs.get("log", LOGGER.new()) # noqa: F841
data: ExperimentRegistrationFormData = (
self._experiment_registration_form_schema.dump(experiment_registration_form)
)
return data