Class: OCI::DataScience::Models::CreateModelProvenanceDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_science/models/create_model_provenance_details.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 = {}) ⇒ CreateModelProvenanceDetails

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



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

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']
end

Instance Attribute Details

#git_branchString

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

Returns:

  • (String)


16
17
18
# File 'lib/oci/data_science/models/create_model_provenance_details.rb', line 16

def git_branch
  @git_branch
end

#git_commitString

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

Returns:

  • (String)


20
21
22
# File 'lib/oci/data_science/models/create_model_provenance_details.rb', line 20

def git_commit
  @git_commit
end

#repository_urlString

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

Returns:

  • (String)


12
13
14
# File 'lib/oci/data_science/models/create_model_provenance_details.rb', line 12

def repository_url
  @repository_url
end

#script_dirString

For model reproducibility purposes. Path to model artifacts.

Returns:

  • (String)


24
25
26
# File 'lib/oci/data_science/models/create_model_provenance_details.rb', line 24

def script_dir
  @script_dir
end

#training_scriptString

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

Returns:

  • (String)


29
30
31
# File 'lib/oci/data_science/models/create_model_provenance_details.rb', line 29

def training_script
  @training_script
end

Class Method Details

.attribute_mapObject

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



32
33
34
35
36
37
38
39
40
41
42
# File 'lib/oci/data_science/models/create_model_provenance_details.rb', line 32

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

.swagger_typesObject

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
55
# File 'lib/oci/data_science/models/create_model_provenance_details.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'repository_url': :'String',
    'git_branch': :'String',
    'git_commit': :'String',
    'script_dir': :'String',
    'training_script': :'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



112
113
114
115
116
117
118
119
120
121
# File 'lib/oci/data_science/models/create_model_provenance_details.rb', line 112

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
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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'lib/oci/data_science/models/create_model_provenance_details.rb', line 146

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


126
127
128
# File 'lib/oci/data_science/models/create_model_provenance_details.rb', line 126

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



135
136
137
# File 'lib/oci/data_science/models/create_model_provenance_details.rb', line 135

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



179
180
181
182
183
184
185
186
187
188
# File 'lib/oci/data_science/models/create_model_provenance_details.rb', line 179

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



173
174
175
# File 'lib/oci/data_science/models/create_model_provenance_details.rb', line 173

def to_s
  to_hash.to_s
end