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

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

Instance Method Summary collapse

Instance Method Details

#candidate ⇒ Object 



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

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

#candidate_repository ⇒ Object 



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

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

#candidates_order_params(params) ⇒ Object 



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

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_read! ⇒ Object 



7
8
9
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 7

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

#check_api_write! ⇒ Object 



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

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

#experiment ⇒ Object 



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

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

#experiment_repository ⇒ Object 



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

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

#find_candidate!(eid) ⇒ Object 



78
79
80
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 78

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

#find_experiment!(iid, name) ⇒ Object 



74
75
76
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 74

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

#invalid_parameter!(message = nil) ⇒ Object 



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

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

#packages_url ⇒ Object 



82
83
84
85
86
87
88
89
 
# File 'lib/api/ml/mlflow/api_helpers.rb', line 82

def packages_url
  path = api_v4_projects_packages_generic_package_version_path(
    id: user_project.id, package_name: '', file_name: ''
  )
  path = path.delete_suffix('/package_version')

  expose_url(path)
end

#resource_already_exists! ⇒ Object 



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

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

#resource_not_found! ⇒ Object 



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

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