Module: Cnvrg::Helpers

Extended by:
Helpers
Included in:
Helpers
Defined in:
lib/cnvrg/helpers.rb

Instance Method Summary collapse

Instance Method Details

#checkmark ⇒ Object 



9
10
11
12
 
# File 'lib/cnvrg/helpers.rb', line 9

def checkmark
  checkmark = "\u2713"
  return checkmark.encode('utf-8')
end

#cnvrgignore_content ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/cnvrg/helpers.rb', line 147

def cnvrgignore_content
  #TODO: cnvrg ignore add .conflict
  %{
# cnvrg ignore: Ignore the following directories and files
# for example:
# some_dir/
# some_file.txt
.git*
.gitignore
*.conflict
*.deleted
        }.strip
end

#cpu_time ⇒ Object

cpu



243
244
245
 
# File 'lib/cnvrg/helpers.rb', line 243

def cpu_time
  Process.clock_gettime(Process::CLOCK_PROCESS_CPUTIME_ID, :microsecond)
end

#decrypt(key, iv, str) ⇒ Object 



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/cnvrg/helpers.rb', line 251

def decrypt(key,iv,str)
  begin

  cipher = OpenSSL::Cipher.new("aes-256-cbc").decrypt
  cipher.key = key
  cipher.iv = Base64.decode64 iv.encode('utf-8')

  result = Base64.decode64 (str.encode('utf-8'))
  result = cipher.update(result)
  result << cipher.final
  return result.force_encoding('utf-8')

  # return result
  rescue => e
    puts e


  end


end

#get_config ⇒ Object 



40
41
42
43
44
45
46
47
48
49
 
# File 'lib/cnvrg/helpers.rb', line 40

def get_config
  home_dir = File.expand_path('~')
  config = {}
  begin
    if File.exist? home_dir+"/.cnvrg/config.yml"
      config = YAML.load_file(home_dir+"/.cnvrg/config.yml")
    end
  end
  return config
end

#get_mem(pid) ⇒ Object

memory



275
276
 
# File 'lib/cnvrg/helpers.rb', line 275

def get_mem(pid)
end

#get_s3_props(files) ⇒ Object

will return client and decryptor



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/cnvrg/helpers.rb', line 278

def get_s3_props(files) #will return client and decryptor
  sts_path = files["path_sts"]
  retries = 0
  success= false
  while !success and retries < 20
    begin
      if !Helpers.is_verify_ssl
        body = open(sts_path, {ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE}).read
      else
        body = open(sts_path).read
      end
      success = true
    rescue => e
      retries +=1
      sleep(5)

    end
  end
  if !success
    return Cnvrg::Result.new(false,"couldn't download some files", "error in sts", "" )
  end
  split = body.split("\n")
  key = split[0]
  iv = split[1]

  access =  Cnvrg::Helpers.decrypt(key, iv, files["sts_a"])

  secret =  Cnvrg::Helpers.decrypt(key,iv, files["sts_s"])

  session =  Cnvrg::Helpers.decrypt(key,iv, files["sts_st"])
  region =  Cnvrg::Helpers.decrypt(key,iv, files["region"])

  bucket =  Cnvrg::Helpers.decrypt(key,iv, files["bucket"])
  is_s3 = files["is_s3"]
  server_side_encryption =files["server_side_encryption"]

  if is_s3 or is_s3.nil?
    client = Aws::S3::Client.new(
        :access_key_id =>access,
        :secret_access_key => secret,
        :session_token => session,
        :region => region,
        :http_open_timeout => 60, :retry_limit => 20)
    use_accelerate_endpoint = true
  else

    endpoint = Cnvrg::Helpers.decrypt(key,iv, files["endpoint"])
    client = Aws::S3::Client.new(
        :access_key_id =>access,
        :secret_access_key => secret,
        :region => region,
        :endpoint=> endpoint,:force_path_style=> true,:ssl_verify_peer=>false,
        :http_open_timeout => 60, :retry_limit => 20)
    use_accelerate_endpoint = false
  end

  if !server_side_encryption
    upload_options = {:use_accelerate_endpoint => use_accelerate_endpoint}
  else
    upload_options = {:use_accelerate_endpoint => use_accelerate_endpoint, :server_side_encryption => server_side_encryption}
  end
  return {client: client, key: key, iv: iv, bucket: bucket, upload_options: upload_options}
end

#hyper_content ⇒ Object 



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
 
# File 'lib/cnvrg/helpers.rb', line 161

def hyper_content
  %{# Hyperparameter Optimization is the process of choosing a set of parameters for a learning algorithm, usually with the goal of optimizing a measure of the algorithm's performance on an independent data set.

# Below is the list of parameters that will be used in the optimization process. Each parameter has a param_name that should match the argument that is feeded to the experiment s.t kernel => --kernel='rbf'

parameters:
  # Integer parameter is a range of possible values between a minimum (inclusive)
  # and maximum (not inclusive) values. Values are floored (0.7 => 0)
- param_name: "learning_rate"
  type: "integer" 
  min: 0 # inclusive
  max: 10 # not inclusive
  scale: "linear"
  steps: 4 # The number of linear steps to produce.


# Float parameter is a range of possible values between a minimum (inclusive)
# and maximum (not inclusive) values.
#
- param_name: "learning_rate"
  type: "float" # precision is 9 after period
  min: 0.00001
  max: 0.1
  scale: "log2" # Could be log10 as well
  steps: 2

# Discrete parameter is an array of numerical values.
#
- param_name: "c"
  type: "discrete"
  values: [0, 0.1 ,0.001]

# Categorical parameter is an array of string values
#
- param_name: "kernel"
  type: "categorical"
  values: ["linear", "poly", "rbf"] 

}
end

#internet_connection? ⇒ Boolean

Returns:

  • (Boolean) 


14
15
16
17
18
19
20
 
# File 'lib/cnvrg/helpers.rb', line 14

def internet_connection?
  begin
    true if open("http://www.google.com/")
  rescue
    false
  end
end

#is_verify_ssl ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/cnvrg/helpers.rb', line 92

def is_verify_ssl
  home_dir = File.expand_path('~')
  config = ""
  begin
    if File.exist? home_dir+"/.cnvrg/config.yml"
      config = YAML.load_file(home_dir+"/.cnvrg/config.yml")
    else
     return true

    end

  rescue
    return true
  end
  if !config or config.empty? or config.to_h[:verify_ssl].nil?
    return true
  else
    return config.to_h[:verify_ssl]
  end
end

#linux? ⇒ Boolean

Returns:

  • (Boolean) 


138
139
140
 
# File 'lib/cnvrg/helpers.rb', line 138

def linux?
  not mac? and not windows?
end

#look_for_in_path(path, name) ⇒ Object 



231
232
233
234
235
236
237
238
239
 
# File 'lib/cnvrg/helpers.rb', line 231

def look_for_in_path(path, name)
  url_split = path.split("/")
  url_split.each_with_index do |u, i|
    if u == name
      return i
    end
  end
  return -1
end

#mac? ⇒ Boolean

Returns:

  • (Boolean) 


134
135
136
 
# File 'lib/cnvrg/helpers.rb', line 134

def mac?
  !!(RUBY_PLATFORM =~ /-darwin\d/)
end

#netrc_domain ⇒ Object 



227
228
229
 
# File 'lib/cnvrg/helpers.rb', line 227

def netrc_domain
  "cnvrg.io"
end

#os ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/cnvrg/helpers.rb', line 113

def os

  if windows?
    return "windows"
  elsif mac?
    return "mac"
  elsif ubuntu?
    return "ubuntu"
  elsif linux?

    return "linux"
  else

    return "N/A"
  end
end

#parallel_threads ⇒ Object 



6
7
8
 
# File 'lib/cnvrg/helpers.rb', line 6

def parallel_threads()
  return ParallelThreads
end

#readme_content ⇒ Object 



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/cnvrg/helpers.rb', line 202

def readme_content
  %{
        # README

        This README would normally contain some context and description about the project. 

        Things you may want to cover:

        * Data description

        * Benchmark and measurement guidelines

        * Used algorithms

        * Scores

        * Configurations

        * Requirements

        * How to run the experiments

        * ...}.strip
end

#remote_url ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/cnvrg/helpers.rb', line 58

def remote_url
  home_dir = File.expand_path('~')
  config = ""
  begin
    if File.exist? home_dir+"/.cnvrg/config.yml"
      config = YAML.load_file(home_dir+"/.cnvrg/config.yml")
    else
      return "https://app.cnvrg.io"
    end

  rescue
    return "https://app.cnvrg.io"
  end
  if !config or config.empty? or config.to_h[:api].nil?
    return "https://app.cnvrg.io"
  else
    return config.to_h[:api].gsub("/api", "")
  end
end

#server_version ⇒ Object 



78
79
80
81
 
# File 'lib/cnvrg/helpers.rb', line 78

def server_version
  config = self.get_config
  config[:version].try(:to_i) || 0
end

#set_config(config) ⇒ Object 



51
52
53
54
55
 
# File 'lib/cnvrg/helpers.rb', line 51

def set_config(config)
  home_dir = File.expand_path('~')
  File.open("#{home_dir}/.cnvrg/config.yml", "w"){|f| f.write config.to_yaml }
  return config
end

#try_until_success(tries: 5) ⇒ Object

Raises:

  • (StandardError) 


22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/cnvrg/helpers.rb', line 22

def try_until_success(tries: 5)
  (0..tries).each do |i|
    begin
      yield
      return true
    rescue Exception => e
      Cnvrg::Logger.log_info("Error while trying for the #{i} time")
      Cnvrg::Logger.log_error(e)
      sleep(5)
    rescue => e
      Cnvrg::Logger.log_info("Error while trying for the #{i} time")
      Cnvrg::Logger.log_error(e)
      sleep(5)
    end
  end
  raise StandardError.new("Failed")
end

#ubuntu? ⇒ Boolean

Returns:

  • (Boolean) 


142
143
144
145
 
# File 'lib/cnvrg/helpers.rb', line 142

def ubuntu?
  unix = `if [ -f  /etc/lsb-release ];  then echo "ubuntu"; fi`
  return unix.include? "ubuntu"
end

#update_version(version) ⇒ Object 



83
84
85
86
87
88
89
90
 
# File 'lib/cnvrg/helpers.rb', line 83

def update_version(version)
  config = self.get_config
  if config[:version].to_s.eql? version
    return
  end
  config[:version] = version
  self.set_config(config)
end

#wall_time ⇒ Object 



247
248
249
 
# File 'lib/cnvrg/helpers.rb', line 247

def wall_time
  Process.clock_gettime(Process::CLOCK_MONOTONIC, :microsecond)
end

#windows? ⇒ Boolean

Returns:

  • (Boolean) 


130
131
132
 
# File 'lib/cnvrg/helpers.rb', line 130

def windows?
  !!(RUBY_PLATFORM =~ /mswin32|mingw32/)
end