Transformers.js 文档

utils/core

您正在查看 main 版本,该版本需要从源码安装。如果您想要常规的 npm 安装,请查看最新的稳定版本 (v3.0.0)。
Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

utils/core

Transformers.js 的核心实用工具函数/类。

这些仅在内部使用,意味着最终用户不应需要访问此处的任何内容。


utils/core.reverseDictionary(data) ⇒ <code> Object </code>

反转对象的键和值。

类型utils/core 的静态方法
返回值Object - 反转后的对象。
参见https://ultimatecourses.com/blog/reverse-object-keys-and-values-in-javascript

参数类型描述
dataObject

要反转的对象。


utils/core.escapeRegExp(string) ⇒ <code> string </code>

通过将字符串中的正则表达式特殊字符替换为它们的转义对应物来转义它们。

类型utils/core 的静态方法
返回值string - 转义后的字符串。

参数类型描述
stringstring

要转义的字符串。


utils/core.isTypedArray(val) ⇒ <code> boolean </code>

检查值是否为类型化数组。

类型utils/core 的静态方法
返回值boolean - 如果值是 TypedArray,则为 true,否则为 false。

改编自 https://stackoverflow.com/a/71091338/13989043

参数类型描述
val*

要检查的值。


utils/core.isIntegralNumber(x) ⇒ <code> boolean </code>

检查值是否为整数。

类型utils/core 的静态方法
返回值boolean - 如果值是字符串,则为 true,否则为 false。

参数类型描述
x*

要检查的值。


utils/core.isNullishDimension(x) ⇒ <code> boolean </code>

确定提供的宽度或高度是否为空值。

类型utils/core 的静态方法
返回值boolean - 如果值为 nullundefined-1,则为 true,否则为 false。

参数类型描述
x*

要检查的值。


utils/core.calculateDimensions(arr) ⇒ <code> Array. < number > </code>

计算嵌套数组的维度。

类型utils/core 的静态方法
返回值Array.<number> - 包含输入数组维度的数组。

参数类型描述
arrArray.<any>

要计算维度的嵌套数组。


utils/core.pop(obj, key, defaultValue) ⇒ <code> * </code>

复制 python 的 .pop() 对象方法。

类型utils/core 的静态方法
返回值* - 弹出的键的值。
抛出:

  • Error 如果键不存在且未提供默认值。
参数类型描述
objObject

要从中弹出的对象。

keystring

要弹出的键。

defaultValue*

如果键不存在,则返回的默认值。


utils/core.mergeArrays(arrs) ⇒ <code> Array </code>

高效地合并数组,创建新副本。改编自 https://stackoverflow.com/a/6768642/13989043

类型utils/core 的静态方法
返回值Array - 合并后的数组。

参数类型描述
arrsArray.<Array>

要合并的数组。


utils/core.calculateReflectOffset(i, w) ⇒ <code> number </code>

计算给定索引和窗口大小的索引偏移量。

类型utils/core 的静态方法
返回值number - 索引偏移量。

参数类型描述
inumber

索引。

wnumber

窗口大小。


utils/core.saveBlob(path, blob)

在 Web 上保存 blob 文件。

类型utils/core 的静态方法

参数类型描述
pathstring

保存 blob 的路径

blobBlob

要保存的 blob


utils/core.pick(o, props) ⇒ <code> Object </code>

类型utils/core 的静态方法

参数类型
oObject
propsArray.<string>

utils/core.len(s) ⇒ <code> number </code>

计算字符串的长度,考虑多字节字符。这模仿了 Python 的 len 函数的行为。

类型utils/core 的静态方法
返回值number - 字符串的长度。

参数类型描述
sstring

要计算长度的字符串。


utils/core.count(arr, value)

计算数组或字符串中值的出现次数。这模仿了 Python 的 count 方法的行为。

类型utils/core 的静态方法

参数类型描述
arrArray<any> | string

要搜索的数组或字符串。

valueany

要计数的值。


utils/core~InitiateProgressInfo : <code> Object </code>

类型utils/core 的内部类型定义
属性

名称类型描述
status'initiate'
namestring

模型 ID 或目录路径。

filestring

文件名。


utils/core~DownloadProgressInfo : <code> Object </code>

类型utils/core 的内部类型定义
属性

名称类型描述
status'download'
namestring

模型 ID 或目录路径。

filestring

文件名。


utils/core~ProgressStatusInfo : <code> Object </code>

类型utils/core 的内部类型定义
属性

名称类型描述
status'progress'
namestring

模型 ID 或目录路径。

filestring

文件名。

progressnumber

介于 0 和 100 之间的数字。

loadednumber

已加载的字节数。

totalnumber

要加载的总字节数。


utils/core~DoneProgressInfo : <code> Object </code>

类型utils/core 的内部类型定义
属性

名称类型描述
status'done'
namestring

模型 ID 或目录路径。

filestring

文件名。


utils/core~ReadyProgressInfo : <code> Object </code>

类型utils/core 的内部类型定义
属性

名称类型描述
status'ready'
taskstring

加载的任务。

modelstring

加载的模型。


utils/core~ProgressInfo : <code> InitiateProgressInfo </code> | <code> DownloadProgressInfo </code> | <code> ProgressStatusInfo </code> | <code> DoneProgressInfo </code> | <code> ReadyProgressInfo </code>

类型utils/core 的内部类型定义


utils/core~ProgressCallback ⇒ <code> void </code>

一个回调函数,当进度信息更新时会被调用。

类型utils/core 的内部类型定义

参数类型
progressInfoProgressInfo

< > 在 GitHub 上更新