# tensorplay.serialization API

Source: https://www.tensorplay.cn/docs/api/tensorplay.serialization.html

## Functions 21

[#](#api-tensorplay.serialization.add_safe_globals)

### add_safe_globals

function[Full reference ↗](/docs/generated/tensorplay.serialization.add_safe_globals.html)

```python
tensorplay.serialization.add_safe_globals(values) → None
```

[#](#api-tensorplay.serialization.clear_safe_globals)

### clear_safe_globals

function[Full reference ↗](/docs/generated/tensorplay.serialization.clear_safe_globals.html)

```python
tensorplay.serialization.clear_safe_globals() → None
```

[#](#api-tensorplay.serialization.convert_model)

### convert_model

function[Full reference ↗](/docs/generated/tensorplay.serialization.convert_model.html)

```python
tensorplay.serialization.convert_model(model_dir, output_dir=None, **kwargs)
```

Convert a model directory or a supported checkpoint into MEGA.

[#](#api-tensorplay.serialization.convert_to_mega)

### convert_to_mega

function[Full reference ↗](/docs/generated/tensorplay.serialization.convert_to_mega.html)

```python
tensorplay.serialization.convert_to_mega(model_dir, output_dir=None, **kwargs)
```

Convert a model directory or a supported checkpoint into MEGA.

[#](#api-tensorplay.serialization.default_restore_location)

### default_restore_location

function[Full reference ↗](/docs/generated/tensorplay.serialization.default_restore_location.html)

```python
tensorplay.serialization.default_restore_location(storage, location)
```

[#](#api-tensorplay.serialization.get_crc32_options)

### get_crc32_options

function[Full reference ↗](/docs/generated/tensorplay.serialization.get_crc32_options.html)

```python
tensorplay.serialization.get_crc32_options() → bool
```

[#](#api-tensorplay.serialization.get_default_load_endianness)

### get_default_load_endianness

function[Full reference ↗](/docs/generated/tensorplay.serialization.get_default_load_endianness.html)

```python
tensorplay.serialization.get_default_load_endianness() → LoadEndianness | None
```

[#](#api-tensorplay.serialization.get_default_mmap_options)

### get_default_mmap_options

function[Full reference ↗](/docs/generated/tensorplay.serialization.get_default_mmap_options.html)

```python
tensorplay.serialization.get_default_mmap_options() → int | None
```

[#](#api-tensorplay.serialization.get_safe_globals)

### get_safe_globals

function[Full reference ↗](/docs/generated/tensorplay.serialization.get_safe_globals.html)

```python
tensorplay.serialization.get_safe_globals() → list[Any]
```

[#](#api-tensorplay.serialization.get_unsafe_globals_in_checkpoint)

### get_unsafe_globals_in_checkpoint

function[Full reference ↗](/docs/generated/tensorplay.serialization.get_unsafe_globals_in_checkpoint.html)

```python
tensorplay.serialization.get_unsafe_globals_in_checkpoint(f) → list[str]
```

[#](#api-tensorplay.serialization.inspect_checkpoint)

### inspect_checkpoint

function[Full reference ↗](/docs/generated/tensorplay.serialization.inspect_checkpoint.html)

```python
tensorplay.serialization.inspect_checkpoint(f, *, verify_checksums: bool = False) → dict
```

[#](#api-tensorplay.serialization.load)

### load

function[Full reference ↗](/docs/generated/tensorplay.serialization.load.html)

```python
tensorplay.serialization.load(f, map_location=None, pickle_module=None, *, weights_only: bool = True, mmap: bool | None = None, **pickle_load_args) → Any
```

[#](#api-tensorplay.serialization.location_tag)

### location_tag

function[Full reference ↗](/docs/generated/tensorplay.serialization.location_tag.html)

```python
tensorplay.serialization.location_tag(storage)
```

[#](#api-tensorplay.serialization.normalize_storage_type)

### normalize_storage_type

function[Full reference ↗](/docs/generated/tensorplay.serialization.normalize_storage_type.html)

```python
tensorplay.serialization.normalize_storage_type(storage_type)
```

[#](#api-tensorplay.serialization.parse_mega_header)

### parse_mega_header

function[Full reference ↗](/docs/generated/tensorplay.serialization.parse_mega_header.html)

```python
tensorplay.serialization.parse_mega_header(path: str | PathLike[str]) → dict
```

Read MEGA metadata and tensor ranges without materializing tensors.

[#](#api-tensorplay.serialization.register_package)

### register_package

function[Full reference ↗](/docs/generated/tensorplay.serialization.register_package.html)

```python
tensorplay.serialization.register_package(priority: int, tagger, deserializer)
```

[#](#api-tensorplay.serialization.resolve_map_location)

### resolve_map_location

function[Full reference ↗](/docs/generated/tensorplay.serialization.resolve_map_location.html)

```python
tensorplay.serialization.resolve_map_location(map_location: Any, location: str, nbytes: int = 0)
```

Resolve one saved storage location.

None means that the saved location should be used by the caller.
A callable may return a device, a destination tensor, or None.

[#](#api-tensorplay.serialization.save)

### save

function[Full reference ↗](/docs/generated/tensorplay.serialization.save.html)

```python
tensorplay.serialization.save(obj: Any, f, pickle_module=<module 'pickle' from '/opt/hostedtoolcache/Python/3.12.15/x64/lib/python3.12/pickle.py'>, pickle_protocol: int = 2, _use_new_zipfile_serialization: bool = True, _disable_byteorder_record: bool = False, *, metadata: Mapping[str, ~typing.Any] | None=None, alignment: int = 4096, checksum: str = 'crc32') &#x2192; None
```

[#](#api-tensorplay.serialization.set_crc32_options)

### set_crc32_options

function[Full reference ↗](/docs/generated/tensorplay.serialization.set_crc32_options.html)

```python
tensorplay.serialization.set_crc32_options(compute_crc32: bool)
```

[#](#api-tensorplay.serialization.set_default_load_endianness)

### set_default_load_endianness

function[Full reference ↗](/docs/generated/tensorplay.serialization.set_default_load_endianness.html)

```python
tensorplay.serialization.set_default_load_endianness(endianness)
```

[#](#api-tensorplay.serialization.storage_to_tensor_type)

### storage_to_tensor_type

function[Full reference ↗](/docs/generated/tensorplay.serialization.storage_to_tensor_type.html)

```python
tensorplay.serialization.storage_to_tensor_type(storage)
```

## Classes 4

[#](#api-tensorplay.serialization.LoadEndianness)

### LoadEndianness

class[Full reference ↗](/docs/generated/tensorplay.serialization.LoadEndianness.html)

```python
class tensorplay.serialization.LoadEndianness(*values)
```

[#](#api-tensorplay.serialization.safe_globals)

### safe_globals

class[Full reference ↗](/docs/generated/tensorplay.serialization.safe_globals.html)

```python
class tensorplay.serialization.safe_globals(values)
```

[#](#api-tensorplay.serialization.set_default_mmap_options)

### set_default_mmap_options

class[Full reference ↗](/docs/generated/tensorplay.serialization.set_default_mmap_options.html)

```python
class tensorplay.serialization.set_default_mmap_options(flags: int)
```

[#](#api-tensorplay.serialization.skip_data)

### skip_data

class[Full reference ↗](/docs/generated/tensorplay.serialization.skip_data.html)

```python
class tensorplay.serialization.skip_data(materialize_fake_tensors: bool = False)
```

## Attributes 1

[#](#api-tensorplay.serialization.StorageType)

### StorageType

attribute[Full reference ↗](/docs/generated/tensorplay.serialization.StorageType.html)

```python
tensorplay.serialization.StorageType
```

alias of _StorageType