Class: OCI::DataScience::Models::Metadata

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

Overview

Defines properties of each model metadata.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Metadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :key (String) —

    The value to assign to the #key property

  • :value (String) —

    The value to assign to the #value property

  • :description (String) —

    The value to assign to the #description property

  • :category (String) —

    The value to assign to the #category property

  • :keywords (Array<String>) —

    The value to assign to the #keywords property

  • :has_artifact (BOOLEAN) —

    The value to assign to the #has_artifact property



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/oci/data_science/models/metadata.rb', line 97

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.key = attributes[:'key'] if attributes[:'key']

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

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

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

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

  self.has_artifact = attributes[:'hasArtifact'] unless attributes[:'hasArtifact'].nil?
  self.has_artifact = false if has_artifact.nil? && !attributes.key?(:'hasArtifact') # rubocop:disable Style/StringLiterals

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

  self.has_artifact = attributes[:'has_artifact'] unless attributes[:'has_artifact'].nil?
  self.has_artifact = false if has_artifact.nil? && !attributes.key?(:'hasArtifact') && !attributes.key?(:'has_artifact') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#category ⇒ String

Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,Reports,Readme,other".

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/data_science/models/metadata.rb', line 47

def category
  @category
end

#description ⇒ String

Description of model metadata

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/data_science/models/metadata.rb', line 43

def description
  @description
end

#has_artifact ⇒ BOOLEAN

Is there any artifact present for the metadata.

Returns:

  • (BOOLEAN) 


55
56
57
 
# File 'lib/oci/data_science/models/metadata.rb', line 55

def has_artifact
  @has_artifact
end

#key ⇒ String

Key of the model Metadata. The key can either be user defined or OCI defined. List of OCI defined keys: * useCaseType * libraryName * libraryVersion * estimatorClass * hyperParameters * testArtifactresults * fineTuningConfiguration * deploymentConfiguration * readme * license * evaluationConfiguration

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/data_science/models/metadata.rb', line 26

def key
  @key
end

#keywords ⇒ Array<String>

list of keywords for searching

Returns:

  • (Array<String>) 


51
52
53
 
# File 'lib/oci/data_science/models/metadata.rb', line 51

def keywords
  @keywords
end

#value ⇒ String

Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other

Allowed values for libraryName: scikit-learn, xgboost, tensorflow, pytorch, mxnet, keras, lightGBM, pymc3, pyOD, spacy, prophet, sktime, statsmodels, cuml, oracle_automl, h2o, transformers, nltk, emcee, pystan, bert, gensim, flair, word2vec, ensemble, other

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/data_science/models/metadata.rb', line 39

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/data_science/models/metadata.rb', line 58

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'value': :'value',
    'description': :'description',
    'category': :'category',
    'keywords': :'keywords',
    'has_artifact': :'hasArtifact'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/data_science/models/metadata.rb', line 72

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'value': :'String',
    'description': :'String',
    'category': :'String',
    'keywords': :'Array<String>',
    'has_artifact': :'BOOLEAN'
    # 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



129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/oci/data_science/models/metadata.rb', line 129

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

  self.class == other.class &&
    key == other.key &&
    value == other.value &&
    description == other.description &&
    category == other.category &&
    keywords == other.keywords &&
    has_artifact == other.has_artifact
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



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

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


144
145
146
 
# File 'lib/oci/data_science/models/metadata.rb', line 144

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



153
154
155
 
# File 'lib/oci/data_science/models/metadata.rb', line 153

def hash
  [key, value, description, category, keywords, has_artifact].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/data_science/models/metadata.rb', line 197

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



191
192
193
 
# File 'lib/oci/data_science/models/metadata.rb', line 191

def to_s
  to_hash.to_s
end