safetensors 0.1.0-aarch64-linux

Sign up to get free protection for your applications and to get access to all the features.
data/LICENSE.txt ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,67 @@
1
+ # Safetensors Ruby
2
+
3
+ :slightly_smiling_face: Simple, [safe way](https://github.com/huggingface/safetensors) to store and distribute tensors
4
+
5
+ Supports [Torch.rb](https://github.com/ankane/torch.rb) and [Numo](https://github.com/ruby-numo/numo-narray)
6
+
7
+ [![Build Status](https://github.com/ankane/safetensors-ruby/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/safetensors-ruby/actions)
8
+
9
+ ## Installation
10
+
11
+ Add this line to your application’s Gemfile:
12
+
13
+ ```ruby
14
+ gem "safetensors"
15
+ ```
16
+
17
+ ## Getting Started
18
+
19
+ Save tensors
20
+
21
+ ```ruby
22
+ tensors = {
23
+ "weight1" => Torch.zeros([1024, 1024]),
24
+ "weight2" => Torch.zeros([1024, 1024])
25
+ }
26
+ Safetensors::Torch.save_file(tensors, "model.safetensors")
27
+ ```
28
+
29
+ Load tensors
30
+
31
+ ```ruby
32
+ tensors = Safetensors::Torch.load_file("model.safetensors")
33
+ # or
34
+ tensors = {}
35
+ Safetensors.safe_open("model.safetensors", framework: "torch", device: "cpu") do |f|
36
+ f.keys.each do |key|
37
+ tensors[key] = f.get_tensor(key)
38
+ end
39
+ end
40
+ ```
41
+
42
+ ## API
43
+
44
+ This library follows the [Safetensors Python API](https://huggingface.co/docs/safetensors/index). You can follow Python tutorials and convert the code to Ruby in many cases. Feel free to open an issue if you run into problems.
45
+
46
+ ## History
47
+
48
+ View the [changelog](https://github.com/ankane/safetensors-ruby/blob/master/CHANGELOG.md)
49
+
50
+ ## Contributing
51
+
52
+ Everyone is encouraged to help improve this project. Here are a few ways you can help:
53
+
54
+ - [Report bugs](https://github.com/ankane/safetensors-ruby/issues)
55
+ - Fix bugs and [submit pull requests](https://github.com/ankane/safetensors-ruby/pulls)
56
+ - Write, clarify, or fix documentation
57
+ - Suggest or add new features
58
+
59
+ To get started with development:
60
+
61
+ ```sh
62
+ git clone https://github.com/ankane/safetensors-ruby.git
63
+ cd safetensors-ruby
64
+ bundle install
65
+ bundle exec rake compile
66
+ bundle exec rake test
67
+ ```
Binary file
Binary file
Binary file
@@ -0,0 +1,93 @@
1
+ module Safetensors
2
+ module Numo
3
+ DTYPES = {
4
+ "DFloat" => "float64",
5
+ "SFloat" => "float32"
6
+ }
7
+
8
+ TYPES = {
9
+ "F64" => :DFloat,
10
+ "F32" => :SFloat,
11
+ "I64" => :Int64,
12
+ "U64" => :UInt64,
13
+ "I32" => :Int32,
14
+ "U32" => :UInt32,
15
+ "I16" => :Int16,
16
+ "U16" => :UInt16,
17
+ "I8" => :Int8,
18
+ "U8" => :UInt8
19
+ }
20
+
21
+ class << self
22
+ def save(tensor_dict, metadata: nil)
23
+ Safetensors.serialize(_flatten(tensor_dict), metadata: metadata)
24
+ end
25
+
26
+ def save_file(tensor_dict, filename, metadata: nil)
27
+ Safetensors.serialize_file(_flatten(tensor_dict), filename, metadata: metadata)
28
+ end
29
+
30
+ def load(data)
31
+ flat = Safetensors.deserialize(data)
32
+ _view2numo(flat)
33
+ end
34
+
35
+ def load_file(filename)
36
+ result = {}
37
+ Safetensors.safe_open(filename, framework: "numo") do |f|
38
+ f.keys.each do |k|
39
+ result[k] = f.get_tensor(k)
40
+ end
41
+ end
42
+ result
43
+ end
44
+
45
+ private
46
+
47
+ def _flatten(tensors)
48
+ if !tensors.is_a?(Hash)
49
+ raise ArgumentError, "Expected a hash of [String, Numo::NArray] but received #{tensors.class.name}"
50
+ end
51
+
52
+ tensors.each do |k, v|
53
+ if !v.is_a?(::Numo::NArray)
54
+ raise ArgumentError, "Key `#{k}` is invalid, expected Numo::NArray but received #{v.class.name}"
55
+ end
56
+ end
57
+
58
+ tensors.to_h do |k, v|
59
+ [
60
+ k.is_a?(Symbol) ? k.to_s : k,
61
+ {
62
+ "dtype" => DTYPES.fetch(v.class.name.split("::").last),
63
+ "shape" => v.shape,
64
+ "data" => _tobytes(v)
65
+ }
66
+ ]
67
+ end
68
+ end
69
+
70
+ def _tobytes(tensor)
71
+ if Safetensors.big_endian?
72
+ raise "Not yet implemented"
73
+ end
74
+
75
+ tensor.to_binary
76
+ end
77
+
78
+ def _getdtype(dtype_str)
79
+ TYPES.fetch(dtype_str)
80
+ end
81
+
82
+ def _view2numo(safeview)
83
+ result = {}
84
+ safeview.each do |k, v|
85
+ dtype = _getdtype(v["dtype"])
86
+ arr = ::Numo.const_get(dtype).from_binary(v["data"], v["shape"])
87
+ result[k] = arr
88
+ end
89
+ result
90
+ end
91
+ end
92
+ end
93
+ end
@@ -0,0 +1,141 @@
1
+ module Safetensors
2
+ module Torch
3
+ TYPES = {
4
+ "F64" => :float64,
5
+ "F32" => :float32,
6
+ "F16" => :float16,
7
+ "BF16" => :bfloat16,
8
+ "I64" => :int64,
9
+ "U64" => :uint64,
10
+ "I32" => :int32,
11
+ "U32" => :uint32,
12
+ "I16" => :int16,
13
+ "U16" => :uint16,
14
+ "I8" => :int8,
15
+ "U8" => :uint8,
16
+ "BOOL" => :bool,
17
+ "F8_E4M3" => :float8_e4m3fn,
18
+ "F8_E5M2" => :float8_e5m2
19
+ }
20
+
21
+ class << self
22
+ def save(tensors, metadata: nil)
23
+ Safetensors.serialize(_flatten(tensors), metadata: metadata)
24
+ end
25
+
26
+ def save_file(tensors, filename, metadata: nil)
27
+ Safetensors.serialize_file(_flatten(tensors), filename, metadata: metadata)
28
+ end
29
+
30
+ def load_file(filename, device: "cpu")
31
+ result = {}
32
+ Safetensors.safe_open(filename, framework: "torch", device: device) do |f|
33
+ f.keys.each do |k|
34
+ result[k] = f.get_tensor(k)
35
+ end
36
+ end
37
+ result
38
+ end
39
+
40
+ def load(data)
41
+ flat = Safetensors.deserialize(data)
42
+ _view2torch(flat)
43
+ end
44
+
45
+ private
46
+
47
+ def _find_shared_tensors(state_dict)
48
+ # TODO
49
+ []
50
+ end
51
+
52
+ def _getdtype(dtype_str)
53
+ TYPES.fetch(dtype_str)
54
+ end
55
+
56
+ def _view2torch(safeview)
57
+ result = {}
58
+ safeview.each do |k, v|
59
+ dtype = _getdtype(v["dtype"])
60
+ options = ::Torch.send(:tensor_options, dtype: dtype)
61
+ arr = ::Torch._from_blob_ref(v["data"], v["shape"], options)
62
+ if Safetensors.big_endian?
63
+ # TODO
64
+ raise "not yet implemented"
65
+ end
66
+ result[k] = arr
67
+ end
68
+ result
69
+ end
70
+
71
+ def _tobytes(tensor, name)
72
+ if tensor.layout != :strided
73
+ raise ArgumentError, "You are trying to save a sparse tensor: `#{name}` which this library does not support. You can make it a dense tensor before saving with `.to_dense()` but be aware this might make a much larger file than needed."
74
+ end
75
+
76
+ if !tensor.contiguous?
77
+ raise ArgumentError, "You are trying to save a non contiguous tensor: `#{name}` which is not allowed. It either means you are trying to save tensors which are reference of each other in which case it's recommended to save only the full tensors, and reslice at load time, or simply call `.contiguous()` on your tensor to pack it before saving."
78
+ end
79
+
80
+ if tensor.device != "cpu"
81
+ # Moving tensor to cpu before saving
82
+ tensor = tensor.to("cpu")
83
+ end
84
+
85
+ if Safetensors.big_endian?
86
+ # TODO
87
+ raise "not yet implemented"
88
+ end
89
+
90
+ tensor._data_str
91
+ end
92
+
93
+ def _flatten(tensors)
94
+ if !tensors.is_a?(Hash)
95
+ raise ArgumentError, "Expected a hash of [String, Torch::Tensor] but received #{tensors.class.name}"
96
+ end
97
+
98
+ invalid_tensors = []
99
+ tensors.each do |k, v|
100
+ if !v.is_a?(::Torch::Tensor)
101
+ raise ArgumentError, "Key `#{k}` is invalid, expected Torch::Tensor but received #{v.class.name}"
102
+ end
103
+
104
+ if v.layout != :strided
105
+ invalid_tensors << k
106
+ end
107
+ end
108
+ if invalid_tensors.any?
109
+ raise ArgumentError, "You are trying to save a sparse tensors: `#{invalid_tensors}` which this library does not support. You can make it a dense tensor before saving with `.to_dense()` but be aware this might make a much larger file than needed."
110
+ end
111
+
112
+ shared_pointers = _find_shared_tensors(tensors)
113
+ failing = []
114
+ shared_pointers.each do |names|
115
+ if names.length > 1
116
+ failing << names
117
+ end
118
+ end
119
+
120
+ if failing.any?
121
+ raise <<~MSG
122
+ Some tensors share memory, this will lead to duplicate memory on disk and potential differences when loading them again: #{failing}.
123
+ A potential way to correctly save your model is to use `save_model`.
124
+ More information at https://huggingface.co/docs/safetensors/torch_shared_tensors
125
+ MSG
126
+ end
127
+
128
+ tensors.to_h do |k, v|
129
+ [
130
+ k.is_a?(Symbol) ? k.to_s : k,
131
+ {
132
+ "dtype" => v.dtype.to_s,
133
+ "shape" => v.shape,
134
+ "data" => _tobytes(v, k)
135
+ }
136
+ ]
137
+ end
138
+ end
139
+ end
140
+ end
141
+ end
@@ -0,0 +1,3 @@
1
+ module Safetensors
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,37 @@
1
+ # ext
2
+ begin
3
+ require "safetensors/#{RUBY_VERSION.to_f}/safetensors"
4
+ rescue LoadError
5
+ require "safetensors/safetensors"
6
+ end
7
+
8
+ # modules
9
+ require_relative "safetensors/numo"
10
+ require_relative "safetensors/torch"
11
+ require_relative "safetensors/version"
12
+
13
+ module Safetensors
14
+ class Error < StandardError; end
15
+
16
+ def self.serialize(tensor_dict, metadata: nil)
17
+ _serialize(tensor_dict, metadata)
18
+ end
19
+
20
+ def self.serialize_file(tensor_dict, filename, metadata: nil)
21
+ _serialize_file(tensor_dict, filename, metadata)
22
+ end
23
+
24
+ def self.safe_open(filename, framework:, device: "cpu")
25
+ f = SafeOpen.new(filename, framework, device)
26
+ if block_given?
27
+ yield f
28
+ else
29
+ f
30
+ end
31
+ end
32
+
33
+ # private
34
+ def self.big_endian?
35
+ [1].pack("i") == [1].pack("i!>")
36
+ end
37
+ end
metadata ADDED
@@ -0,0 +1,58 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: safetensors
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: aarch64-linux
6
+ authors:
7
+ - Andrew Kane
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2024-02-25 00:00:00.000000000 Z
12
+ dependencies: []
13
+ description:
14
+ email: andrew@ankane.org
15
+ executables: []
16
+ extensions: []
17
+ extra_rdoc_files: []
18
+ files:
19
+ - CHANGELOG.md
20
+ - Cargo.lock
21
+ - Cargo.toml
22
+ - LICENSE-THIRD-PARTY.txt
23
+ - LICENSE.txt
24
+ - README.md
25
+ - lib/safetensors.rb
26
+ - lib/safetensors/3.1/safetensors.so
27
+ - lib/safetensors/3.2/safetensors.so
28
+ - lib/safetensors/3.3/safetensors.so
29
+ - lib/safetensors/numo.rb
30
+ - lib/safetensors/torch.rb
31
+ - lib/safetensors/version.rb
32
+ homepage: https://github.com/ankane/safetensors-ruby
33
+ licenses:
34
+ - Apache-2.0
35
+ metadata: {}
36
+ post_install_message:
37
+ rdoc_options: []
38
+ require_paths:
39
+ - lib
40
+ required_ruby_version: !ruby/object:Gem::Requirement
41
+ requirements:
42
+ - - ">="
43
+ - !ruby/object:Gem::Version
44
+ version: '3.1'
45
+ - - "<"
46
+ - !ruby/object:Gem::Version
47
+ version: 3.4.dev
48
+ required_rubygems_version: !ruby/object:Gem::Requirement
49
+ requirements:
50
+ - - ">="
51
+ - !ruby/object:Gem::Version
52
+ version: '0'
53
+ requirements: []
54
+ rubygems_version: 3.4.4
55
+ signing_key:
56
+ specification_version: 4
57
+ summary: Simple, safe way to store and distribute tensors
58
+ test_files: []