Class: OCI::DataScience::Models::ModelProvenance

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_science/models/model_provenance.rb

Overview

Model provenance gives data scientists information about the origin of their model. This information allows data scientists to reproduce the development environment in which the model was trained.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ModelProvenance

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :repository_url (String) —

    The value to assign to the #repository_url property

  • :git_branch (String) —

    The value to assign to the #git_branch property

  • :git_commit (String) —

    The value to assign to the #git_commit property

  • :script_dir (String) —

    The value to assign to the #script_dir property

  • :training_script (String) —

    The value to assign to the #training_script property

  • :training_id (String) —

    The value to assign to the #training_id property



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
 
# File 'lib/oci/data_science/models/model_provenance.rb', line 76

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.repository_url = attributes[:'repositoryUrl'] if attributes[:'repositoryUrl']

  raise 'You cannot provide both :repositoryUrl and :repository_url' if attributes.key?(:'repositoryUrl') && attributes.key?(:'repository_url')

  self.repository_url = attributes[:'repository_url'] if attributes[:'repository_url']

  self.git_branch = attributes[:'gitBranch'] if attributes[:'gitBranch']

  raise 'You cannot provide both :gitBranch and :git_branch' if attributes.key?(:'gitBranch') && attributes.key?(:'git_branch')

  self.git_branch = attributes[:'git_branch'] if attributes[:'git_branch']

  self.git_commit = attributes[:'gitCommit'] if attributes[:'gitCommit']

  raise 'You cannot provide both :gitCommit and :git_commit' if attributes.key?(:'gitCommit') && attributes.key?(:'git_commit')

  self.git_commit = attributes[:'git_commit'] if attributes[:'git_commit']

  self.script_dir = attributes[:'scriptDir'] if attributes[:'scriptDir']

  raise 'You cannot provide both :scriptDir and :script_dir' if attributes.key?(:'scriptDir') && attributes.key?(:'script_dir')

  self.script_dir = attributes[:'script_dir'] if attributes[:'script_dir']

  self.training_script = attributes[:'trainingScript'] if attributes[:'trainingScript']

  raise 'You cannot provide both :trainingScript and :training_script' if attributes.key?(:'trainingScript') && attributes.key?(:'training_script')

  self.training_script = attributes[:'training_script'] if attributes[:'training_script']

  self.training_id = attributes[:'trainingId'] if attributes[:'trainingId']

  raise 'You cannot provide both :trainingId and :training_id' if attributes.key?(:'trainingId') && attributes.key?(:'training_id')

  self.training_id = attributes[:'training_id'] if attributes[:'training_id']
end

Instance Attribute Details

#git_branch ⇒ String

For model reproducibility purposes. Branch of the git repository associated with model training.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/data_science/models/model_provenance.rb', line 17

def git_branch
  @git_branch
end

#git_commit ⇒ String

For model reproducibility purposes. Commit ID of the git repository associated with model training.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/data_science/models/model_provenance.rb', line 21

def git_commit
  @git_commit
end

#repository_url ⇒ String

For model reproducibility purposes. URL of the git repository associated with model training.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/data_science/models/model_provenance.rb', line 13

def repository_url
  @repository_url
end

#script_dir ⇒ String

For model reproducibility purposes. Path to model artifacts.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/data_science/models/model_provenance.rb', line 25

def script_dir
  @script_dir
end

#training_id ⇒ String

The OCID of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/data_science/models/model_provenance.rb', line 34

def training_id
  @training_id
end

#training_script ⇒ String

For model reproducibility purposes. Path to the python script or notebook in which the model was trained."

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/data_science/models/model_provenance.rb', line 30

def training_script
  @training_script
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/data_science/models/model_provenance.rb', line 37

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'repository_url': :'repositoryUrl',
    'git_branch': :'gitBranch',
    'git_commit': :'gitCommit',
    'script_dir': :'scriptDir',
    'training_script': :'trainingScript',
    'training_id': :'trainingId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/data_science/models/model_provenance.rb', line 51

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'repository_url': :'String',
    'git_branch': :'String',
    'git_commit': :'String',
    'script_dir': :'String',
    'training_script': :'String',
    'training_id': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/data_science/models/model_provenance.rb', line 126

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    repository_url == other.repository_url &&
    git_branch == other.git_branch &&
    git_commit == other.git_commit &&
    script_dir == other.script_dir &&
    training_script == other.training_script &&
    training_id == other.training_id
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/data_science/models/model_provenance.rb', line 161

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


141
142
143
 
# File 'lib/oci/data_science/models/model_provenance.rb', line 141

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



150
151
152
 
# File 'lib/oci/data_science/models/model_provenance.rb', line 150

def hash
  [repository_url, git_branch, git_commit, script_dir, training_script, training_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



194
195
196
197
198
199
200
201
202
203
 
# File 'lib/oci/data_science/models/model_provenance.rb', line 194

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



188
189
190
 
# File 'lib/oci/data_science/models/model_provenance.rb', line 188

def to_s
  to_hash.to_s
end