# general

Python API: `modelconverter.utils.general`

modelconverter 共享的通用辅助函数。

包含适合其他地方的小型实用程序：将模型名称清理为转换工具接受的名称，以及格式化或解析用于报告和限制磁盘缓存的字节大小。

## 函数

### dir_stats

```python
def dir_stats(path: Path) -> tuple[int, int]:
```

返回 `path` 下的总大小（字节）和文件数。

无法统计的条目将被跳过：如果在其入口点 chown 挂载之前容器运行被终止，则会留下 root 拥有的文件，并且报告缓存或将其保持在预算范围内都不能成为中断的原因。

### human_size

```python
def human_size(num: float) -> str:
```

格式化字节数以供显示。

> **示例**
> ```pycon
>>> human_size(1536)
'1.5 KiB'
>>> human_size(5 * 1024**3)
'5.0 GiB'
```

参数

 * `num` (`float`): 大小（字节）。

返回

 * `str`: 具有一位小数和二进制单位的大小，例如 `"1.5 GiB"`。

### parse_size

```python
def parse_size(value: str | int) -> int:
```

将人类编写的字节大小（例如 `"50GiB"`）解析为字节。

单位是可选的，其前缀是二进制的，与 [human_size](/software-v3/ai-inference/conversion/rvc-conversion/offline/modelconverter/modelconverter-api-reference/utils/general.md) 的输出和 Docker 自己的字节值输入相匹配：`50G`、`50GB` 和 `50GiB` 都表示相同的 50 * 1024^3 字节，而裸数字表示字节数。

> **示例**
> ```pycon
>>> parse_size("50GiB")
53687091200
>>> parse_size("50GB")
53687091200
>>> parse_size("512m")
536870912
>>> parse_size(1024)
1024
```

参数

 * `value` (`str | int`): 要解析的大小。整数将保持不变。

返回

 * `int`: 大小（字节）。

引发

 * `ValueError`: 如果 `value` 不是大小。

### sanitize_net_name

```python
def sanitize_net_name(name: str, with_suffix: bool = False) -> str:
```

清理网络名称或路径。

如果输入是路径，则只清理基本名称。如果输入是名称，则清理整个字符串。折叠多个下划线。

> **示例**
> ```pycon
>>> sanitize_net_name("my model!.onnx")
'my_model_onnx'
>>> sanitize_net_name("my model!.onnx", with_suffix=True)
'my_model_.onnx'
>>> sanitize_net_name("a/b/my model!.onnx")
'a/b/my_model_onnx'
```

参数

 * `name` (`str`): 要清理的名称或路径。
 * `with_suffix` (`bool`): 如果为 `True`，则保留后缀（文件扩展名）且不进行清理。

返回

 * `str`: 清理后的名称或路径。
