Module: API::Ml::Mlflow::ApiHelpers

Defined in:
lib/api/ml/mlflow/api_helpers.rb

Constant Summary collapse

OUTER_QUOTES_REGEXP = 
/^("|')|("|')?$/
GITLAB_TAG_PREFIX = 
'gitlab.'

Instance Method Summary collapse

Instance Method Details

#candidate ⇒ Object 



54
55
56
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 54

def candidate
  @candidate ||= find_candidate!(params[:run_id])
end

#candidate_repository ⇒ Object 



46
47
48
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 46

def candidate_repository
  ::Ml::ExperimentTracking::CandidateRepository.new(user_project, current_user)
end

#candidates_order_params(params) ⇒ Object 



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
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 58

def candidates_order_params(params)
  find_params = {
    order_by: nil,
    order_by_type: nil,
    sort: nil
  }

  return find_params if params[:order_by].blank?

  order_by_split = params[:order_by].split(' ')
  order_by_column_split = order_by_split[0].split('.')
  if order_by_column_split.size == 1
    order_by_column = order_by_column_split[0]
    order_by_column_type = 'column'
  elsif order_by_column_split[0] == 'metrics'
    order_by_column = order_by_column_split[1]
    order_by_column_type = 'metric'
  else
    order_by_column = nil
    order_by_column_type = nil
  end

  order_by_sort = order_by_split[1]

  {
    order_by: order_by_column,
    order_by_type: order_by_column_type,
    sort: order_by_sort
  }
end

#check_api_model_registry_read! ⇒ Object 



18
19
20
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 18

def check_api_model_registry_read!
  not_found! unless can?(current_user, :read_model_registry, user_project)
end

#check_api_model_registry_write! ⇒ Object 



22
23
24
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 22

def check_api_model_registry_write!
  unauthorized! unless can?(current_user, :write_model_registry, user_project)
end

#check_api_read! ⇒ Object 



10
11
12
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 10

def check_api_read!
  not_found! unless can?(current_user, :read_model_experiments, user_project)
end

#check_api_write! ⇒ Object 



14
15
16
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 14

def check_api_write!
  unauthorized! unless can?(current_user, :write_model_experiments, user_project)
end

#custom_version ⇒ Object 



132
133
134
135
136
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 132

def custom_version
  return unless gitlab_tags

  gitlab_tags['version']
end

#experiment ⇒ Object 



50
51
52
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 50

def experiment
  @experiment ||= find_experiment!(params[:experiment_id], params[:experiment_name])
end

#experiment_repository ⇒ Object 



42
43
44
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 42

def experiment_repository
  ::Ml::ExperimentTracking::ExperimentRepository.new(user_project, current_user)
end

#find_candidate!(eid) ⇒ Object 



142
143
144
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 142

def find_candidate!(eid)
  candidate_repository.by_eid(eid) || resource_not_found!
end

#find_experiment!(iid, name) ⇒ Object 



138
139
140
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 138

def find_experiment!(iid, name)
  experiment_repository.by_iid_or_name(iid: iid, name: name) || resource_not_found!
end

#find_model(project, name) ⇒ Object 



146
147
148
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 146

def find_model(project, name)
  ::Ml::FindModelService.new(project, name).execute || resource_not_found!
end

#find_model_artifact(project, version, file_path) ⇒ Object 



154
155
156
157
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 154

def find_model_artifact(project, version, file_path)
  package = ::Ml::ModelVersion.by_project_id_and_id(project, version).package
  ::Packages::PackageFileFinder.new(package, file_path).execute || resource_not_found!
end

#find_model_version(project, name, version) ⇒ Object 



150
151
152
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 150

def find_model_version(project, name, version)
  ::Ml::ModelVersions::GetModelVersionService.new(project, name, version).execute || resource_not_found!
end

#gitlab_tags ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 117

def gitlab_tags
  return unless params[:tags].present?

  tags = params[:tags]
  gitlab_params = {}

  tags.each do |tag|
    key, value = tag.values_at(:key, :value)

    gitlab_params[key.delete_prefix(GITLAB_TAG_PREFIX)] = value if key&.starts_with?(GITLAB_TAG_PREFIX)
  end

  gitlab_params
end

#invalid_parameter!(message = nil) ⇒ Object 



34
35
36
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 34

def invalid_parameter!(message = nil)
  render_structured_api_error!({ error_code: 'INVALID_PARAMETER_VALUE', message: message }, 400)
end

#list_model_artifacts(project, version) ⇒ Object 



159
160
161
162
163
164
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 159

def list_model_artifacts(project, version)
  model_version = ::Ml::ModelVersion.by_project_id_and_id(project, version)
  resource_not_found! unless model_version && model_version.package

  model_version.package.installable_package_files
end

#model ⇒ Object 



166
167
168
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 166

def model
  @model ||= find_model(user_project, params[:name])
end

#model_filter_params(params) ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 105

def model_filter_params(params)
  return {} if params[:filter].blank?

  param, filter = params[:filter].split('=')

  return {} unless param == 'name'

  filter.gsub!(OUTER_QUOTES_REGEXP, '') unless filter.blank?

  { name: filter }
end

#model_order_params(params) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 89

def model_order_params(params)
  if params[:order_by].blank?
    order_by = 'name'
    sort = 'asc'
  else
    order_by, sort = params[:order_by].downcase.split(' ')
    order_by = 'updated_at' if order_by == 'last_updated_timestamp'
    sort ||= 'asc'
  end

  {
    order_by: order_by,
    sort: sort
  }
end

#resource_already_exists! ⇒ Object 



30
31
32
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 30

def resource_already_exists!
  render_structured_api_error!({ error_code: 'RESOURCE_ALREADY_EXISTS' }, 400)
end

#resource_not_found! ⇒ Object 



26
27
28
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 26

def resource_not_found!
  render_structured_api_error!({ error_code: 'RESOURCE_DOES_NOT_EXIST' }, 404)
end

#update_failed! ⇒ Object 



38
39
40
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 38

def update_failed!
  render_structured_api_error!({ error_code: 'UPDATE_FAILED' }, 400)
end