Transformers.js 文档

utils/core

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

并获得增强的文档体验

开始使用

utils/core

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

这些只在内部使用,这意味着最终用户不应该需要访问这里的任何东西。


utils/core.reverseDictionary(data) ⇒ Object

反转对象的键和值。

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

参数量类型描述
数据对象

要反转的对象。


utils/core.escapeRegExp(string) ⇒ string

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

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

参数量类型描述
字符串字符串

要转义的字符串。


utils/core.isTypedArray(val) ⇒ boolean

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

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

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

参数量类型描述
*

要检查的值。


utils/core.isIntegralNumber(x) ⇒ boolean

检查值是否为整数。

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

参数量类型描述
x*

要检查的值。


utils/core.isNullishDimension(x) ⇒ boolean

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

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

参数量类型描述
x*

要检查的值。


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

计算嵌套数组的维度。

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

参数量类型描述
arrArray.<any>

要计算维度的嵌套数组。


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

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

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

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

要弹出的对象。

字符串

要弹出的键。

defaultValue*

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


utils/core.mergeArrays(arrs) ⇒ Array

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

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

参数量类型描述
arrsArray.<Array>

要合并的数组。


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

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

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

参数量类型描述
i数字

索引。

w数字

窗口大小。


utils/core.saveBlob(path, blob)

在 web 上保存 blob 文件。

类型utils/core 的静态方法

参数量类型描述
路径字符串

保存 blob 的路径。

blobBlob

要保存的 blob。


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

类型utils/core 的静态方法

参数量类型
o对象
属性Array.<string>

utils/core.len(s) ⇒ number

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

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

参数量类型描述
s字符串

要计算长度的字符串。


utils/core.count(arr, value)

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

类型utils/core 的静态方法

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

要搜索的数组或字符串。

任何

要计数的数值。


utils/core~InitiateProgressInfo : Object

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

名称类型描述
状态'initiate'
名称字符串

模型 ID 或目录路径。

文件字符串

文件名。


utils/core~DownloadProgressInfo : Object

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

名称类型描述
状态'download'
名称字符串

模型 ID 或目录路径。

文件字符串

文件名。


utils/core~ProgressStatusInfo : Object

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

名称类型描述
状态'progress'
名称字符串

模型 ID 或目录路径。

文件字符串

文件名。

进度数字

一个介于 0 到 100 之间的数字。

已加载数字

已加载的字节数。

总计数字

要加载的总字节数。


utils/core~DoneProgressInfo : Object

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

名称类型描述
状态'done'
名称字符串

模型 ID 或目录路径。

文件字符串

文件名。


utils/core~ReadyProgressInfo : Object

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

名称类型描述
状态'ready'
任务字符串

已加载的任务。

模型字符串

已加载的模型。


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

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


utils/core~ProgressCallback ⇒ void

一个回调函数,用于接收进度信息。

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

参数量类型
进度信息进度信息

< > 在 GitHub 上更新