语言

ExpressionEstimator 类

定义

此估算器将用户提供的表达式(指定为字符串)应用于输入列值,以生成新的输出列值。

public sealed class ExpressionEstimator : Microsoft.ML.IEstimator<Microsoft.ML.Transforms.ExpressionTransformer>
type ExpressionEstimator = class
    interface IEstimator<ExpressionTransformer>
Public NotInheritable Class ExpressionEstimator
Implements IEstimator(Of ExpressionTransformer)
继承
ExpressionEstimator
实现

注解

估算器特征

此估算器是否需要查看数据来训练其参数? 否
输入列数据类型 float、double、int、long、bool 或 text。
输出列数据类型 可以是 float、double、int、long、bool 或文本,具体取决于表达式。

生成的 ExpressionTransformer 将创建一个新列,该列在输出列名称参数中指定,其中表达式应用于输入值。 大多数输入列之一可以是 VectorDataViewType 类型,当输入包含向量列时,表达式将独立计算在向量的每个元素上,以创建长度与该输入相同的矢量输出。

表达式语言

表达式估算器的语言应该适用于广泛的用户。 它与一些常用语言有着许多相似之处。 它区分大小写,支持多种类型,并具有一组丰富的运算符和函数。 纯功能,从某种意义上说,语言中没有可变值或改变操作。 它没有任何异常机制,而是在正常值不合适时生成 NA 值。 它是静态类型化,但所有类型都由编译器推断。

语法

lambda 的语法由参数列表组成,后跟冒号(:)或箭头(=>)后跟表达式。 参数列表可以是单个标识符,也可以是用括号括起来的一个或多个标识符的逗号分隔列表。

lambda:

  • parameter-list : 表达式
  • parameter-list => 表达式

parameter-list:

  • 标识符
  • (参数名称)

parameter-names:

  • 标识符
  • identifier , parameter-names

表达式可以使用参数、文本、运算符、带表达式和函数。

Literals

  • 布尔文本为 true 和 false。
  • 整数文本可以是十进制或十六进制(例如,0x1234ABCD)。 它们可以与你或 U 后缀,指示未签名,以及 l 或 L,指示 long (Int64)。 使用你或 U 是罕见的,仅影响某些 32 位十六进制值的提升,确定常量是被视为负 Int32 值还是正 Int64 值。
  • 浮点文本使用标准语法,包括指数表示法(123.45e-37)。 它们可以后缀为 f 或 F,指示单精度,或 d 或 D,表示双精度。 与 C# 不同,浮点文本的默认精度是单精度。 若要指定双精度,请追加 d 或 D。
  • 文本文本括在双引号中,并支持标准转义机制。

Operators

表达式语言的运算符按预报顺序在下表中列出。 除非另有说明,否则二进制运算符保持关联并传播 NA 值(如果任一操作数值为 NA,则结果为 NA)。 通常,整数值的溢出会生成 NA,而浮点值的溢出会产生无穷大。

运算符 含义 Arity 注释
​? : conditional 三元 表达式条件? value1 :如果条件为 true,value2 解析为 value1;如果条件为 false,则解析为 value2。 条件必须为布尔值,而 value1 和 value2 必须兼容类型。
​?? coalesce 二进制 表达式 x ?? 如果 x 不是 NA,则 y 解析为 x,否则解析为 y。 操作数必须是 Singles,或两个双精度数。 此运算符是右关联运算符。
| |或 逻辑或 二进制 操作数和结果为布尔值。 如果一个操作数为 true,则结果为 true,否则为 false。
&& 和 逻辑和 二进制 操作数和结果为布尔值。 如果一个操作数为 false,则结果为 false,否则为 true。
​==, =
!=, <>
<, <=
>, >=
等于
不等于
小于等于
大于等于
Multiple - 比较运算符是多 arity,这意味着它们可以应用于两个或多个操作数。 例如,如果 a、b 和 c 的值相同,则 == b == c 将产生 true。 不相等运算符要求所有操作数都不同,因此 1 != 2 != 1 为 false。 若要测试 x 是否为非负但小于 10,请使用 0 <= x < 10。 无需写入 0 <= x && x < 10,这样做将无法正常运行。 在同一行中列出的运算符可以在单个表达式中组合,因此 > b >= c 是合法的,但 < b >= c 不是。
- 等于和不等于应用于任何操作数类型,而有序运算符需要数值操作数。
​+ - 加法和减法 二进制 使用 NA 传播进行数值加法和减法。
* / % 乘法、除法和模数 二 进 制 具有 NA 传播的数字乘法、除法和模数。
​- ! 不 数值求反和逻辑非 元 这些是一元前缀运算符,求反(-)需要数值操作数,而不是 (!)需要布尔操作数。
​^ 电源 二进制 这是正确的关联指数。 它需要数值操作数。 对于整数操作数,0^0 生成 1。
​( ) 括号分组 一元 标准含义。

With 表达式

with-expression 的语法为:

with-expression:

  • with( assignment-list ; expression )

assignment-list:

  • 分配
  • assignment,assignment-list

工作分配:

  • 标识符 = 表达式

with-expression 引入了一个或多个命名值。 例如,以下表达式将 celcius 温度转换为华氏度,然后根据华氏度是否过低或过高生成消息。

c => with(f = c * 9 / 5 + 32 ; f < 60 ? "Too Cold!" : f > 90 ? "Too Hot!" : "Just Right!")

一个赋值表达式可以引用先前赋值引入的标识符,如此示例中返回 -1、0 或 1 而不是消息:

c : with(f = c * 9 / 5 + 32, cold = f < 60, hot = f > 90 ; -float(cold) + float(hot))

如上所述,在较大的表达式中多次需要表达式值时,with-expression 非常有用。 处理复杂或重大常量时,它还很有用:

    ticks => with(
        ticksPerSecond = 10000000L,
        ticksPerHour = ticksPerSecond \* 3600,
        ticksPerDay = ticksPerHour \* 24,
        day = ticks / ticksPerDay,
        dayEpoch = 1 ;
        (day + dayEpoch) % 7)

这将计算自标准 .Net DateTime 纪元(01/01/0001 在理想化公历中为 Int64)以来的一周中的一天。 工作分配用于秒中的刻度数、一小时内的刻度数、一年内的刻度数以及纪元的一周日期。 在此示例中,我们希望将星期日映射到零,因此,由于纪元是星期一,因此,我们将 dayEpoch 设置为 1。 如果纪元已更改,或者我们想将一周的不同一天映射到零,我们只需更改 dayEpoch。 请注意,ticksPerSecond 定义为 100000000L,使其成为 Int64 值(8 字节整数)。 如果没有 L 后缀,ticksPerDay 将溢出 Int32 的范围。

Functions

表达式转换支持许多有用的函数。

下表中列出了可接受任何类型的操作数的常规一元函数。

名称 含义 批注
isna 测试 na 返回一个布尔值,该值指示操作数是否为 NA 值。
na na 值 返回与操作数(浮点数或双精度)相同的类型的 NA 值。 请注意,这不会计算操作数,它只使用操作数来确定要返回的 NA 类型,并在编译时进行确定。
默认 默认值 返回与操作数相同的类型的默认值。 例如,若要将 NA 值映射到默认值,请使用 x ?? default(x)。 请注意,这不会计算操作数,它只使用操作数来确定要返回的默认值的类型,并在编译时进行确定。 对于数值类型,默认值为零。 对于布尔值,默认值为 false。 对于文本,默认值为空。

下表中列出了一元转换函数。 NA 操作数生成 NA,如果类型不支持 NA,则引发该操作数。 失败或溢出的转换也会导致 NA 或异常。 最常见的情况是从使用标准转换分析的文本进行转换。 从浮点值(浮点值或双精度值)转换为整数值(Int32 或 Int64)时,转换将执行截断运算(向零舍入)。

名称 含义 评论
bool 转换为布尔值 操作数必须是文本或布尔值。
Int 转换为 Int32 输入可以是任何类型的。
long 转换为 Int64 输入可以是任何类型的。
single、float 转换为 Single 输入可以是任何类型的。
double 转换为 Double 输入可以是任何类型的。
text 转换为 文本 输入可以是任何类型的。 这会生成默认文本表示形式。

下表中列出了需要数值操作数的一元函数。 结果类型与操作数类型相同。 NA 操作数值生成 NA。

名称 含义 评论
abs 绝对值 生成操作数的绝对值。
sign sign (-1, 0, 1) 根据操作数是负数、零还是正数,生成 -1、0 或 1。

下表中列出了需要数值操作数的二进制函数。 当操作数类型不相同时,操作数将提升为适当的类型。 结果类型与提升的操作数类型相同。 NA 操作数值生成 NA。

名称 含义 批注
min minimum 生成操作数的最小值。
max maximum 生成操作数的最大值。

下表中列出了需要浮点操作数的一元函数。 结果类型与操作数类型相同。 溢出产生无穷大。 无效的输入值生成 NA。

名称 意义 批注
sqrt 平方根 负操作数生成 NA。
trunc、truncate 截断为整数 将零舍入为最接近的整数值。
floor floor 将负无穷大舍入到最接近的整数值。
ceil,天花板 天花板 将正无穷大舍入到最接近的整数值。
round 无偏见舍入 舍入为最接近的整数值。 当操作数在两个整数值之间的一半时,这会产生偶数。
exp 指数 将 e 引发到操作数。
ln、log 对数 生成自然 (base e) 对数。 还有两个操作数版本的日志用于使用不同的基础。
deg、degrees 弧度到度 从弧度到度的地图。
rad,弧度 度到弧度 从度到弧度映射。
sin,sind sine 采用角度的正弦值。 sin 函数假定操作数为弧度,而 sind 函数假定操作数为度。
cos、cosd 余弦值 采用角度的余弦值。 cos 函数假定操作数为弧度,而 cosd 函数假定操作数为度。
tan、tand tangent 采用角度的正切值。 tan 函数假定操作数为弧度,而 tand 函数假定操作数为度。
sinh 双曲正弦值 获取其操作数的双曲正弦值。
cosh 双曲余弦值 获取其操作数的双曲余弦值。
tanh 双曲正切值 获取其操作数的双曲正切值。
asin 反正弦值 取其操作数的反正弦值。
acos 反余弦值 取其操作数的反余弦值。
atan 反正切值 取其操作数的反正切值。

下表中列出了需要浮点操作数的二进制函数。 当操作数类型不相同时,操作数将提升为适当的类型。 结果类型与提升的操作数类型相同。 NA 操作数值生成 NA。

名字 含义 批注
log 具有给定基数的对数 第二个操作数是基数。 第一个是取对数的值。
atan2、atanyx 确定角度 从给定的 y 和 x 值确定 -pi 和 pi 之间的角度。 请注意,y 是第一个操作数。

下表中列出了文本函数。

名称 意义 批注
len(x) 文本长度 操作数必须是文本。 结果是指示操作数长度的 I4。 如果操作数为 NA,则结果为 NA。
lower(x),upper(x) 小写或大写 将文本映射到小写或大写。
left(x, k), right(x, k) substring 第一个操作数必须是文本,第二个操作数必须是 Int32。 如果第二个操作数为负数,则被视为与文本末尾的偏移量。 然后,此调整后的索引固定为 0 到 len(x)。 结果是结果位置左侧或右侧的字符。
mid(x、a、b) substring 第一个操作数必须是文本,其他两个操作数必须是 Int32。 索引的转换方式与左右函数的转换方式相同:负值被视为与文本末尾的偏移量;这些调整后的索引固定为 0 到 len(x)。 第二个固定索引也固定在下面的第一个固定索引。 结果是这两个固定索引之间的字符。
concat(x1, x2, ..., xn) 串联 这接受任意数量的操作数(包括零)。 所有操作数都必须为文本。 结果是所有操作数的串联顺序。

方法

名称 说明
Fit(IDataView)

此估算器将用户提供的表达式(指定为字符串)应用于输入列值,以生成新的输出列值。

GetOutputSchema(SchemaShape)

此估算器将用户提供的表达式(指定为字符串)应用于输入列值,以生成新的输出列值。

扩展方法

名称 说明
AppendCacheCheckpoint<TTrans>(IEstimator<TTrans>, IHostEnvironment)

将“缓存检查点”追加到估算器链。 这将确保根据缓存的数据训练下游估算器。 在执行多个数据传递的训练器之前,拥有缓存检查点会很有帮助。

WithOnFitDelegate<TTransformer>(IEstimator<TTransformer>, Action<TTransformer>)

给定估算器后,返回一个包装对象,该对象将调用委托一次 Fit(IDataView) 。 估算器通常必须返回有关拟合情况的信息,这就是为什么 Fit(IDataView) 该方法返回特定类型化对象的原因,而不仅仅是常规 ITransformer对象。 但是,同时, IEstimator<TTransformer> 通常形成成包含许多对象的管道,因此我们可能需要通过 EstimatorChain<TLastTransformer> 估算器链来生成一个估算器链,而我们想要获取转换器的估算器被埋在此链中的某个位置。 对于这种情况,我们可以通过此方法附加一个委托,该委托将在调用拟合后调用。

适用于

另请参阅