Class: OCI::GenerativeAi::Models::HuggingFaceModel

Inherits:
ModelDataSource show all
Defined in:
lib/oci/generative_ai/models/hugging_face_model.rb

Overview

Configuration for importing a model from Hugging Face. Requires the model ID and a reference to the token stored in a vault for authenticated access.

Constant Summary

Constants inherited from ModelDataSource

ModelDataSource::SOURCE_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ModelDataSource

#source_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ModelDataSource

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ HuggingFaceModel

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :model_id (String) —

    The value to assign to the #model_id property

  • :access_token (String) —

    The value to assign to the #access_token property

  • :branch (String) —

    The value to assign to the #branch property

  • :commit (String) —

    The value to assign to the #commit property



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
 
# File 'lib/oci/generative_ai/models/hugging_face_model.rb', line 75

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

  attributes['sourceType'] = 'HUGGING_FACE_MODEL'

  super(attributes)

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

  self.model_id = attributes[:'modelId'] if attributes[:'modelId']

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

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

  self.access_token = attributes[:'accessToken'] if attributes[:'accessToken']

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

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

  self.branch = attributes[:'branch'] if attributes[:'branch']
  self.branch = "main" if branch.nil? && !attributes.key?(:'branch') # rubocop:disable Style/StringLiterals

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

Instance Attribute Details

#access_token ⇒ String

Hugging Face access token to authenticate requests for restricted models. This token will be securely stored in OCI Vault.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/generative_ai/models/hugging_face_model.rb', line 24

def access_token
  @access_token
end

#branch ⇒ String

The name of the branch in the Hugging Face repository to import the model from. If not specified, "main" will be used by default. If you provide both a branch and a commit hash, the model will be imported from the specified commit.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/generative_ai/models/hugging_face_model.rb', line 31

def branch
  @branch
end

#commit ⇒ String

The commit hash in the Hugging Face repository to import the model from. If both a branch and a commit are provided, the commit hash will be used.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/generative_ai/models/hugging_face_model.rb', line 37

def commit
  @commit
end

#model_id ⇒ String

[Required] The full model OCID from Hugging Face, typically in the format "org/model-name" (e.g., "meta-llama/Llama-2-7b").

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/generative_ai/models/hugging_face_model.rb', line 18

def model_id
  @model_id
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/oci/generative_ai/models/hugging_face_model.rb', line 40

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'source_type': :'sourceType',
    'model_id': :'modelId',
    'access_token': :'accessToken',
    'branch': :'branch',
    'commit': :'commit'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/generative_ai/models/hugging_face_model.rb', line 53

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'source_type': :'String',
    'model_id': :'String',
    'access_token': :'String',
    'branch': :'String',
    'commit': :'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



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/generative_ai/models/hugging_face_model.rb', line 110

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

  self.class == other.class &&
    source_type == other.source_type &&
    model_id == other.model_id &&
    access_token == other.access_token &&
    branch == other.branch &&
    commit == other.commit
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



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

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


124
125
126
 
# File 'lib/oci/generative_ai/models/hugging_face_model.rb', line 124

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



133
134
135
 
# File 'lib/oci/generative_ai/models/hugging_face_model.rb', line 133

def hash
  [source_type, model_id, access_token, branch, commit].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/generative_ai/models/hugging_face_model.rb', line 177

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



171
172
173
 
# File 'lib/oci/generative_ai/models/hugging_face_model.rb', line 171

def to_s
  to_hash.to_s
end