torsh-tensor 0.1.2

Tensor implementation for ToRSh with PyTorch-compatible API
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
//! Core Tensor Serialization Implementation
//!
//! This module provides the main tensor serialization and deserialization
//! implementations that dispatch to format-specific modules based on the
//! requested serialization format.

#[cfg(feature = "serialize-arrow")]
use super::data_science;
#[cfg(feature = "serialize-onnx")]
use super::ml_formats;
use super::{
    binary,
    common::{SerializationFormat, SerializationOptions},
    text_formats,
};
// Note: scientific module contains HDF5 support which requires H5Type bound.
// Direct usage via scientific::hdf5::serialize_hdf5/deserialize_hdf5 requires H5Type.
#[allow(unused_imports)]
#[cfg(feature = "serialize-hdf5")]
use super::scientific;
use crate::{Tensor, TensorElement};
use std::path::Path;
use torsh_core::error::{Result, TorshError};

/// Main serialization implementation for Tensor (with serialize feature)
/// Note: HDF5 support requires the `serialize-hdf5` feature and hdf5::H5Type bound
#[cfg(feature = "serialize")]
impl<T: TensorElement + serde::Serialize + for<'a> serde::Deserialize<'a>> Tensor<T> {
    /// Serialize tensor to bytes using the specified format
    ///
    /// # Arguments
    /// * `format` - Serialization format to use
    /// * `options` - Serialization options
    ///
    /// # Returns
    /// * `Result<Vec<u8>>` - Serialized bytes or error
    pub fn serialize_to_bytes(
        &self,
        format: SerializationFormat,
        options: &SerializationOptions,
    ) -> Result<Vec<u8>> {
        let mut buffer = Vec::new();

        match format {
            SerializationFormat::Binary => {
                binary::serialize_binary(self, &mut buffer, options)?;
            }
            SerializationFormat::Json => {
                text_formats::serialize_json(self, &mut buffer, options)?;
            }
            SerializationFormat::Numpy => {
                text_formats::numpy::serialize_numpy(self, &mut buffer)?;
            }
            #[cfg(feature = "serialize-hdf5")]
            SerializationFormat::Hdf5 => {
                return Err(TorshError::SerializationError(
                    "HDF5 format requires file path, use serialize_to_file instead".to_string(),
                ));
            }
            #[cfg(feature = "serialize-arrow")]
            SerializationFormat::Arrow | SerializationFormat::Parquet => {
                return Err(TorshError::SerializationError(
                    "Arrow/Parquet format requires file path, use serialize_to_file instead"
                        .to_string(),
                ));
            }
            #[cfg(feature = "serialize-onnx")]
            SerializationFormat::Onnx => {
                return Err(TorshError::SerializationError(
                    "ONNX format requires file path, use serialize_to_file instead".to_string(),
                ));
            }
        }

        Ok(buffer)
    }

    /// Serialize tensor to file using the specified format
    ///
    /// # Arguments
    /// * `path` - Output file path
    /// * `format` - Serialization format to use
    /// * `options` - Serialization options
    ///
    /// # Returns
    /// * `Result<()>` - Ok if successful, error otherwise
    pub fn serialize_to_file<P: AsRef<Path>>(
        &self,
        path: P,
        format: SerializationFormat,
        options: &SerializationOptions,
    ) -> Result<()> {
        let path = path.as_ref();

        match format {
            SerializationFormat::Binary
            | SerializationFormat::Json
            | SerializationFormat::Numpy => {
                // For formats that support byte serialization, write to file
                let bytes = self.serialize_to_bytes(format, options)?;
                std::fs::write(path, bytes).map_err(|e| {
                    TorshError::SerializationError(format!("Failed to write file: {}", e))
                })?;
            }
            #[cfg(feature = "serialize-hdf5")]
            SerializationFormat::Hdf5 => {
                // HDF5 serialization requires T: H5Type trait bound
                // This generic impl cannot have that bound, so return an error
                return Err(TorshError::SerializationError(
                    "HDF5 format requires hdf5::H5Type trait bound. Use binary or numpy format instead, or call scientific::hdf5::serialize_hdf5 directly with H5Type-compatible types".to_string(),
                ));
            }
            #[cfg(feature = "serialize-arrow")]
            SerializationFormat::Arrow => {
                data_science::arrow::serialize_arrow(self, path, options)?;
            }
            #[cfg(feature = "serialize-arrow")]
            SerializationFormat::Parquet => {
                data_science::parquet::serialize_parquet(self, path, options)?;
            }
            #[cfg(feature = "serialize-onnx")]
            SerializationFormat::Onnx => {
                ml_formats::onnx::serialize_onnx(self, path, options)?;
            }
        }

        Ok(())
    }

    /// Deserialize tensor from bytes using the specified format
    ///
    /// # Arguments
    /// * `data` - Serialized bytes
    /// * `format` - Serialization format used
    ///
    /// # Returns
    /// * `Result<Tensor<T>>` - Deserialized tensor or error
    pub fn deserialize_from_bytes(data: &[u8], format: SerializationFormat) -> Result<Tensor<T>> {
        let mut cursor = std::io::Cursor::new(data);

        match format {
            SerializationFormat::Binary => binary::deserialize_binary(&mut cursor),
            SerializationFormat::Json => text_formats::deserialize_json(&mut cursor),
            SerializationFormat::Numpy => text_formats::numpy::deserialize_numpy(&mut cursor),
            #[cfg(feature = "serialize-hdf5")]
            SerializationFormat::Hdf5 => Err(TorshError::SerializationError(
                "HDF5 format requires file path, use deserialize_from_file instead".to_string(),
            )),
            #[cfg(feature = "serialize-arrow")]
            SerializationFormat::Arrow | SerializationFormat::Parquet => {
                Err(TorshError::SerializationError(
                    "Arrow/Parquet format requires file path, use deserialize_from_file instead"
                        .to_string(),
                ))
            }
            #[cfg(feature = "serialize-onnx")]
            SerializationFormat::Onnx => Err(TorshError::SerializationError(
                "ONNX format requires file path, use deserialize_from_file instead".to_string(),
            )),
        }
    }

    /// Deserialize tensor from file using the specified format
    ///
    /// # Arguments
    /// * `path` - Input file path
    /// * `format` - Serialization format used
    ///
    /// # Returns
    /// * `Result<Tensor<T>>` - Deserialized tensor or error
    pub fn deserialize_from_file<P: AsRef<Path>>(
        path: P,
        format: SerializationFormat,
    ) -> Result<Tensor<T>> {
        let path = path.as_ref();

        match format {
            SerializationFormat::Binary
            | SerializationFormat::Json
            | SerializationFormat::Numpy => {
                // For formats that support byte deserialization, read from file
                let bytes = std::fs::read(path).map_err(|e| {
                    TorshError::SerializationError(format!("Failed to read file: {}", e))
                })?;
                Self::deserialize_from_bytes(&bytes, format)
            }
            #[cfg(feature = "serialize-hdf5")]
            SerializationFormat::Hdf5 => {
                // HDF5 deserialization requires T: H5Type trait bound
                Err(TorshError::SerializationError(
                    "HDF5 format requires hdf5::H5Type trait bound. Use binary or numpy format instead, or call scientific::hdf5::deserialize_hdf5 directly with H5Type-compatible types".to_string(),
                ))
            }
            #[cfg(feature = "serialize-arrow")]
            SerializationFormat::Arrow => data_science::arrow::deserialize_arrow(path),
            #[cfg(feature = "serialize-arrow")]
            SerializationFormat::Parquet => data_science::parquet::deserialize_parquet(path),
            #[cfg(feature = "serialize-onnx")]
            SerializationFormat::Onnx => ml_formats::onnx::deserialize_onnx(path),
        }
    }

    /// Auto-detect format from file extension and serialize
    ///
    /// # Arguments
    /// * `path` - Output file path (extension determines format)
    /// * `options` - Serialization options
    ///
    /// # Returns
    /// * `Result<()>` - Ok if successful, error otherwise
    pub fn save<P: AsRef<Path>>(&self, path: P, options: &SerializationOptions) -> Result<()> {
        let path = path.as_ref();
        let format = detect_format_from_path(path)?;
        self.serialize_to_file(path, format, options)
    }

    /// Auto-detect format from file extension and deserialize
    ///
    /// # Arguments
    /// * `path` - Input file path (extension determines format)
    ///
    /// # Returns
    /// * `Result<Tensor<T>>` - Deserialized tensor or error
    pub fn load<P: AsRef<Path>>(path: P) -> Result<Tensor<T>> {
        let path = path.as_ref();
        let format = detect_format_from_path(path)?;
        Self::deserialize_from_file(path, format)
    }
}

/// Implementation for when serialize feature is not enabled
#[cfg(not(feature = "serialize"))]
impl<T: TensorElement> Tensor<T> {
    /// Serialize tensor to bytes using the specified format
    pub fn serialize_to_bytes(
        &self,
        format: SerializationFormat,
        options: &SerializationOptions,
    ) -> Result<Vec<u8>> {
        let mut buffer = Vec::new();

        match format {
            SerializationFormat::Binary => {
                binary::serialize_binary(self, &mut buffer, options)?;
            }
            SerializationFormat::Json => {
                return Err(TorshError::SerializationError(
                    "JSON serialization requires the 'serialize' feature to be enabled".to_string(),
                ));
            }
            SerializationFormat::Numpy => {
                text_formats::numpy::serialize_numpy(self, &mut buffer)?;
            }
            #[cfg(feature = "serialize-hdf5")]
            SerializationFormat::Hdf5 => {
                return Err(TorshError::SerializationError(
                    "HDF5 format requires file path, use serialize_to_file instead".to_string(),
                ));
            }
            #[cfg(feature = "serialize-arrow")]
            SerializationFormat::Arrow | SerializationFormat::Parquet => {
                return Err(TorshError::SerializationError(
                    "Arrow/Parquet format requires file path, use serialize_to_file instead"
                        .to_string(),
                ));
            }
            #[cfg(feature = "serialize-onnx")]
            SerializationFormat::Onnx => {
                return Err(TorshError::SerializationError(
                    "ONNX format requires file path, use serialize_to_file instead".to_string(),
                ));
            }
        }

        Ok(buffer)
    }

    /// Serialize tensor to file using the specified format
    pub fn serialize_to_file<P: AsRef<Path>>(
        &self,
        path: P,
        format: SerializationFormat,
        options: &SerializationOptions,
    ) -> Result<()> {
        let path = path.as_ref();

        match format {
            SerializationFormat::Binary | SerializationFormat::Numpy => {
                // These formats don't require the serialize feature
                let bytes = self.serialize_to_bytes(format, options)?;
                std::fs::write(path, bytes).map_err(|e| {
                    TorshError::SerializationError(format!("Failed to write file: {}", e))
                })?;
            }
            SerializationFormat::Json => {
                return Err(TorshError::SerializationError(
                    "JSON serialization requires the 'serialize' feature to be enabled".to_string(),
                ));
            }
            #[cfg(feature = "serialize-hdf5")]
            SerializationFormat::Hdf5 => {
                // HDF5 serialization requires T: H5Type trait bound
                return Err(TorshError::SerializationError(
                    "HDF5 format requires hdf5::H5Type trait bound. Use binary or numpy format instead, or call scientific::hdf5::serialize_hdf5 directly with H5Type-compatible types".to_string(),
                ));
            }
            #[cfg(feature = "serialize-arrow")]
            SerializationFormat::Arrow => {
                data_science::arrow::serialize_arrow(self, path, options)?;
            }
            #[cfg(feature = "serialize-arrow")]
            SerializationFormat::Parquet => {
                data_science::parquet::serialize_parquet(self, path, options)?;
            }
            #[cfg(feature = "serialize-onnx")]
            SerializationFormat::Onnx => {
                ml_formats::onnx::serialize_onnx(self, path, options)?;
            }
        }

        Ok(())
    }

    /// Deserialize tensor from bytes using the specified format
    pub fn deserialize_from_bytes(data: &[u8], format: SerializationFormat) -> Result<Tensor<T>> {
        let mut cursor = std::io::Cursor::new(data);

        match format {
            SerializationFormat::Binary => binary::deserialize_binary(&mut cursor),
            SerializationFormat::Json => Err(TorshError::SerializationError(
                "JSON deserialization requires the 'serialize' feature to be enabled".to_string(),
            )),
            SerializationFormat::Numpy => text_formats::numpy::deserialize_numpy(&mut cursor),
            #[cfg(feature = "serialize-hdf5")]
            SerializationFormat::Hdf5 => Err(TorshError::SerializationError(
                "HDF5 format requires file path, use deserialize_from_file instead".to_string(),
            )),
            #[cfg(feature = "serialize-arrow")]
            SerializationFormat::Arrow | SerializationFormat::Parquet => {
                Err(TorshError::SerializationError(
                    "Arrow/Parquet format requires file path, use deserialize_from_file instead"
                        .to_string(),
                ))
            }
            #[cfg(feature = "serialize-onnx")]
            SerializationFormat::Onnx => Err(TorshError::SerializationError(
                "ONNX format requires file path, use deserialize_from_file instead".to_string(),
            )),
        }
    }

    /// Deserialize tensor from file using the specified format
    pub fn deserialize_from_file<P: AsRef<Path>>(
        path: P,
        format: SerializationFormat,
    ) -> Result<Tensor<T>> {
        let path = path.as_ref();

        match format {
            SerializationFormat::Binary | SerializationFormat::Numpy => {
                let bytes = std::fs::read(path).map_err(|e| {
                    TorshError::SerializationError(format!("Failed to read file: {}", e))
                })?;
                Self::deserialize_from_bytes(&bytes, format)
            }
            SerializationFormat::Json => Err(TorshError::SerializationError(
                "JSON deserialization requires the 'serialize' feature to be enabled".to_string(),
            )),
            #[cfg(feature = "serialize-hdf5")]
            SerializationFormat::Hdf5 => {
                // HDF5 deserialization requires T: H5Type trait bound
                Err(TorshError::SerializationError(
                    "HDF5 format requires hdf5::H5Type trait bound. Use binary or numpy format instead, or call scientific::hdf5::deserialize_hdf5 directly with H5Type-compatible types".to_string(),
                ))
            }
            #[cfg(feature = "serialize-arrow")]
            SerializationFormat::Arrow => data_science::arrow::deserialize_arrow(path),
            #[cfg(feature = "serialize-arrow")]
            SerializationFormat::Parquet => data_science::parquet::deserialize_parquet(path),
            #[cfg(feature = "serialize-onnx")]
            SerializationFormat::Onnx => ml_formats::onnx::deserialize_onnx(path),
        }
    }

    /// Auto-detect format from file extension and serialize
    pub fn save<P: AsRef<Path>>(&self, path: P, options: &SerializationOptions) -> Result<()> {
        let path = path.as_ref();
        let format = detect_format_from_path(path)?;
        self.serialize_to_file(path, format, options)
    }

    /// Auto-detect format from file extension and deserialize
    pub fn load<P: AsRef<Path>>(path: P) -> Result<Tensor<T>> {
        let path = path.as_ref();
        let format = detect_format_from_path(path)?;
        Self::deserialize_from_file(path, format)
    }
}

/// Detect serialization format from file path extension
///
/// # Arguments
/// * `path` - File path to analyze
///
/// # Returns
/// * `Result<SerializationFormat>` - Detected format or error
fn detect_format_from_path(path: &Path) -> Result<SerializationFormat> {
    let extension = path
        .extension()
        .and_then(|ext| ext.to_str())
        .ok_or_else(|| {
            TorshError::SerializationError(
                "Cannot detect format: file has no extension".to_string(),
            )
        })?;

    match extension.to_lowercase().as_str() {
        "trsh" | "bin" => Ok(SerializationFormat::Binary),
        "json" => Ok(SerializationFormat::Json),
        "npy" => Ok(SerializationFormat::Numpy),
        #[cfg(feature = "serialize-hdf5")]
        "h5" | "hdf5" => Ok(SerializationFormat::Hdf5),
        #[cfg(feature = "serialize-arrow")]
        "arrow" => Ok(SerializationFormat::Arrow),
        #[cfg(feature = "serialize-arrow")]
        "parquet" => Ok(SerializationFormat::Parquet),
        #[cfg(feature = "serialize-onnx")]
        "onnx" => Ok(SerializationFormat::Onnx),
        _ => Err(TorshError::SerializationError(format!(
            "Unsupported file extension: .{}",
            extension
        ))),
    }
}

/// Validate serialization format compatibility
///
/// # Arguments
/// * `format` - Format to validate
///
/// # Returns
/// * `Result<()>` - Ok if format is available, error otherwise
pub fn validate_format_support(format: SerializationFormat) -> Result<()> {
    match format {
        SerializationFormat::Binary | SerializationFormat::Numpy => {
            // Always supported
            Ok(())
        }
        SerializationFormat::Json => {
            #[cfg(feature = "serialize")]
            {
                Ok(())
            }
            #[cfg(not(feature = "serialize"))]
            {
                Err(TorshError::SerializationError(
                    "JSON format requires the 'serialize' feature".to_string(),
                ))
            }
        }
        #[cfg(feature = "serialize-hdf5")]
        SerializationFormat::Hdf5 => Ok(()),
        #[cfg(feature = "serialize-arrow")]
        SerializationFormat::Arrow | SerializationFormat::Parquet => Ok(()),
        #[cfg(feature = "serialize-onnx")]
        SerializationFormat::Onnx => Ok(()),
    }
}