class OCI::DataScience::Models::ModelProvenance

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.

Attributes

git_branch[RW]

For model reproducibility purposes. Branch of the git repository associated with model training. @return [String]

git_commit[RW]

For model reproducibility purposes. Commit ID of the git repository associated with model training. @return [String]

repository_url[RW]

For model reproducibility purposes. URL of the git repository associated with model training. @return [String]

script_dir[RW]

For model reproducibility purposes. Path to model artifacts. @return [String]

training_id[RW]

The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes. @return [String]

training_script[RW]

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

@return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/data_science/models/model_provenance.rb, line 36
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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :repository_url The value to assign to the {#repository_url} property @option attributes [String] :git_branch The value to assign to the {#git_branch} property @option attributes [String] :git_commit The value to assign to the {#git_commit} property @option attributes [String] :script_dir The value to assign to the {#script_dir} property @option attributes [String] :training_script The value to assign to the {#training_script} property @option attributes [String] :training_id The value to assign to the {#training_id} property

# File lib/oci/data_science/models/model_provenance.rb, line 75
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
swagger_types() click to toggle source

Attribute type mapping.

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

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/data_science/models/model_provenance.rb, line 125
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/data_science/models/model_provenance.rb, line 160
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/data_science/models/model_provenance.rb, line 140
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/data_science/models/model_provenance.rb, line 149
def hash
  [repository_url, git_branch, git_commit, script_dir, training_script, training_id].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/data_science/models/model_provenance.rb, line 193
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/data_science/models/model_provenance.rb, line 187
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/data_science/models/model_provenance.rb, line 210
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end