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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Ml::Candidate, factory_default: :keep, feature_category: :mlops do
let_it_be(:candidate) { create(:ml_candidates, :with_metrics_and_params, :with_artifact, name: 'candidate0') }
let_it_be(:candidate2) do
create(:ml_candidates, experiment: candidate.experiment, user: create(:user), name: 'candidate2')
end
let(:project) { candidate.experiment.project }
describe 'associations' do
it { is_expected.to belong_to(:experiment) }
it { is_expected.to belong_to(:project) }
it { is_expected.to belong_to(:user) }
it { is_expected.to belong_to(:package) }
it { is_expected.to have_many(:params) }
it { is_expected.to have_many(:metrics) }
it { is_expected.to have_many(:metadata) }
end
describe 'default values' do
it { expect(described_class.new.iid).to be_present }
end
describe '.artifact_root' do
subject { candidate.artifact_root }
it { is_expected.to eq("/ml_candidate_#{candidate.id}/-/") }
end
describe '.package_name' do
subject { candidate.package_name }
it { is_expected.to eq("ml_candidate_#{candidate.id}") }
end
describe '.package_version' do
subject { candidate.package_version }
it { is_expected.to eq('-') }
end
describe '.iid' do
let_it_be(:eid) { SecureRandom.uuid }
let_it_be(:candidate3) do
build(:ml_candidates, :with_metrics_and_params, name: 'candidate0', eid: eid)
end
subject { candidate3.iid }
it { is_expected.to eq(eid) }
end
describe '.artifact' do
let(:tested_candidate) { candidate }
subject { tested_candidate.artifact }
context 'when has logged artifacts' do
it 'returns the package' do
expect(subject.name).to eq(tested_candidate.package_name)
end
end
context 'when does not have logged artifacts' do
let(:tested_candidate) { candidate2 }
it { is_expected.to be_nil }
end
end
describe '#by_project_id_and_iid' do
let(:project_id) { candidate.experiment.project_id }
let(:iid) { candidate.iid }
subject { described_class.with_project_id_and_iid(project_id, iid) }
context 'when iid exists', 'and belongs to project' do
it { is_expected.to eq(candidate) }
end
context 'when iid exists', 'and does not belong to project' do
let(:project_id) { non_existing_record_id }
it { is_expected.to be_nil }
end
context 'when iid does not exist' do
let(:iid) { 'a' }
it { is_expected.to be_nil }
end
end
describe "#latest_metrics" do
let_it_be(:candidate3) { create(:ml_candidates, experiment: candidate.experiment) }
let_it_be(:metric1) { create(:ml_candidate_metrics, candidate: candidate3) }
let_it_be(:metric2) { create(:ml_candidate_metrics, candidate: candidate3 ) }
let_it_be(:metric3) { create(:ml_candidate_metrics, name: metric1.name, candidate: candidate3) }
subject { candidate3.latest_metrics }
it 'fetches only the last metric for the name' do
expect(subject).to match_array([metric2, metric3] )
end
end
describe "#including_relationships" do
subject { described_class.including_relationships.find_by(id: candidate.id) }
it 'loads latest metrics and params', :aggregate_failures do
expect(subject.association_cached?(:latest_metrics)).to be(true)
expect(subject.association_cached?(:params)).to be(true)
expect(subject.association_cached?(:user)).to be(true)
end
end
describe '#by_name' do
let(:name) { candidate.name }
subject { described_class.by_name(name) }
context 'when name matches' do
it 'gets the correct candidates' do
expect(subject).to match_array([candidate])
end
end
context 'when name matches partially' do
let(:name) { 'andidate' }
it 'gets the correct candidates' do
expect(subject).to match_array([candidate, candidate2])
end
end
context 'when name does not match' do
let(:name) { non_existing_record_id.to_s }
it 'does not fetch any candidate' do
expect(subject).to match_array([])
end
end
end
describe '#order_by_metric' do
let_it_be(:auc_metrics) do
create(:ml_candidate_metrics, name: 'auc', value: 0.4, candidate: candidate)
create(:ml_candidate_metrics, name: 'auc', value: 0.8, candidate: candidate2)
end
let(:direction) { 'desc' }
subject { described_class.order_by_metric('auc', direction) }
it 'orders correctly' do
expect(subject).to eq([candidate2, candidate])
end
context 'when direction is asc' do
let(:direction) { 'asc' }
it 'orders correctly' do
expect(subject).to eq([candidate, candidate2])
end
end
end
describe '#candidate_id_for_package' do
using RSpec::Parameterized::TableSyntax
subject { described_class.candidate_id_for_package(package_name) }
where(:package_name, :id) do
'ml_candidate_1234' | 1234
'ml_candidate_1234abc' | nil
'ml_candidate_abc' | nil
'ml_candidate_' | nil
'blah' | nil
'1234' | nil
end
with_them do
it { is_expected.to be(id) }
end
end
describe '#find_from_package_name' do
let(:package_name) { candidate.package_name }
subject { described_class.find_from_package_name(package_name) }
context 'when package_name is ml_candidates_{id} and the candidate exists' do
it { is_expected.to eq(candidate) }
end
context 'when package_name is ml_candidates_{id} and candidate does not exist' do
let(:package_name) { "ml_candidate_#{non_existing_record_id}" }
it { is_expected.to be_nil }
end
context 'when package_name is not in the format ml_candidates_{id}' do
let(:package_name) { "ml_candidate#{candidate.id}" }
it { is_expected.to be_nil }
end
end
end
|
