objective_base#

所有目标的基类。

模块内容#

类总结#

ObjectiveBase

所有目标的基类。

内容#

class evalml.objectives.objective_base.ObjectiveBase[source]#

所有目标的基类。

属性

problem_types

None

方法

calculate_percent_difference

计算分数之间的百分比差异。

expected_range

返回目标的预期范围,这不一定是可能的范围。

greater_is_better

返回一个布尔值,指示更高的分数是否表示更好的模型性能。

is_bounded_like_percentage

返回此目标是否包含在 0 到 1 之间(含)。

is_defined_for_problem_type

返回目标是否已为问题类型定义。

name

返回描述目标的名称。

objective_function

根据指定指标计算提供的预测值与实际标签值的相对值。

perfect_score

返回通过在完美模型上评估此目标获得的分数。

positive_only

如果为 True,则此目标仅对正数数据有效。默认为 False。

score

返回一个数值分数,根据预测值和实际值之间的差异来指示性能。

score_needs_proba

返回一个布尔值,指示 score() 方法是否需要概率估计。

validate_inputs

基于一些简单检查验证输入。

classmethod calculate_percent_difference(cls, score, baseline_score)[source]#

计算分数之间的百分比差异。

参数
  • score (float) – 一个分数。此目标 score 方法的输出。

  • baseline_score (float) – 一个分数。此目标 score 方法的输出。实际上,这是使用基线评估器在此目标上获得的分数。

返回

分数之间的百分比差异。请注意,对于可解释为

百分比的目标,这将是参考分数和分数之间的差异。对于所有其他目标,差异将由参考分数进行标准化。

返回类型

float

property expected_range(cls)#

返回目标的预期范围,这不一定是可能的范围。

例如,我们预期的 R2 范围是 [-1, 1],尽管实际范围是 (-inf, 1]。

property greater_is_better(cls)#

返回一个布尔值,指示更高的分数是否表示更好的模型性能。

property is_bounded_like_percentage(cls)#

返回此目标是否包含在 0 到 1 之间(含)。

classmethod is_defined_for_problem_type(cls, problem_type)[source]#

返回目标是否已为问题类型定义。

property name(cls)#

返回描述目标的名称。

abstract classmethod objective_function(cls, y_true, y_predicted, y_train=None, X=None, sample_weight=None)[source]#

根据指定指标计算提供的预测值与实际标签值的相对值。

参数
  • y_predicted (pd.Series) – 预测值,长度为 [n_samples]

  • y_true (pd.Series) – 实际类别标签,长度为 [n_samples]

  • y_train (pd.Series) – 观察到的训练值,长度为 [n_samples]

  • X (pd.DataFramenp.ndarray) – 用于计算分数所需的额外数据,形状为 [n_samples, n_features]

  • sample_weight (pd.DataFramenp.ndarray) – 用于计算目标值结果的样本权重

返回

用于计算分数的数值

property perfect_score(cls)#

返回通过在完美模型上评估此目标获得的分数。

positive_only(cls)#

如果为 True,则此目标仅对正数数据有效。默认为 False。

score(self, y_true, y_predicted, y_train=None, X=None, sample_weight=None)[source]#

返回一个数值分数,根据预测值和实际值之间的差异来指示性能。

参数
  • y_predicted (pd.Series) – 预测值,长度为 [n_samples]

  • y_true (pd.Series) – 实际类别标签,长度为 [n_samples]

  • y_train (pd.Series) – 观察到的训练值,长度为 [n_samples]

  • X (pd.DataFramenp.ndarray) – 用于计算分数所需的额外数据,形状为 [n_samples, n_features]

  • sample_weight (pd.DataFramenp.ndarray) – 用于计算目标值结果的样本权重

返回

score

property score_needs_proba(cls)#

返回一个布尔值,指示 score() 方法是否需要概率估计。

对于处理预测概率的目标(如对数损失或 AUC),此项应为 True;对于比较预测类别标签与实际标签的目标(如 F1 或相关系数),此项应为 False。

validate_inputs(self, y_true, y_predicted)[source]#

基于一些简单检查验证输入。

参数
  • y_predicted (pd.Seriespd.DataFrame) – 预测值,长度为 [n_samples]。

  • y_true (pd.Series) – 实际类别标签,长度为 [n_samples]。

抛出

ValueError – 如果输入格式不正确。