文档反馈

问题文档片段

问题文档片段包含公式时，显示为空格。

提交类型

issue

有点复杂...

找人问问吧。

PR

小问题，全程线上修改...

一键搞定！

请选择提交类型

问题类型

规范和低错类

- 规范和低错类：

- 错别字或拼写错误，标点符号使用错误、公式错误或显示异常。

- 链接错误、空单元格、格式错误。

- 英文中包含中文字符。

- 界面和描述不一致，但不影响操作。

- 表述不通顺，但不影响理解。

- 版本号不匹配：如软件包名称、界面版本号。

易用性

- 易用性：

- 关键步骤错误或缺失，无法指导用户完成任务。

- 缺少主要功能描述、关键词解释、必要前提条件、注意事项等。

- 描述内容存在歧义指代不明、上下文矛盾。

- 逻辑不清晰，该分类、分项、分步骤的没有给出。

正确性

- 正确性：

- 技术原理、功能、支持平台、参数类型、异常报错等描述和软件实现不一致。

- 原理图、架构图等存在错误。

- 命令、命令参数等错误。

- 代码片段错误。

- 命令无法完成对应功能。

- 界面错误，无法指导操作。

- 代码样例运行报错、运行结果不符。

风险提示

- 风险提示：

- 对重要数据或系统存在风险的操作，缺少安全提示。

内容合规

- 内容合规：

- 违反法律法规，涉及政治、领土主权等敏感词。

- 内容侵权。

请选择问题类型

问题描述

点击输入详细问题描述，以帮助我们快速定位问题。

提交

文档反馈

mindspore.train.RootMeanSquareDistance

class mindspore.train.RootMeanSquareDistance(symmetric=False, distance_metric='euclidean')

计算从 y_pred 到 y 的均方根表面距离。

给定两个集合A和B，S(A)表示A的表面像素，任意v到S(A)的最短距离定义为：

$$\text{dis}(v,S(A))=\underset{s_A\in S(A)}{\text{min }}\Vert v-s_A\Vert$$

从集合B到集合A的均方根表面距离（Root Mean Square Surface Distance）为：

$$RmsSurDis(B\to A)=\sqrt{\frac{\sum _{s_B\in S(B)}^{}{\text{dis}}^2(s_B,S(A))}{|S(B)|}}$$

其中， ||*|| 表示距离度量， |*| 表示元素的数量。

从集合B到集合A，以及从集合A到集合B的表面距离平均值为：

$$RmsSurDis(A\leftrightarrow B)=\sqrt{\frac{\sum _{s_A\in S(A)}^{}\text{dis}{(s_A,S(B))}^2+\sum _{s_B\in S(B)}^{}\text{dis}{(s_B,S(A))}^2}{|S(A)|+|S(B)|}}$$

参数：

• distance_metric (str) - 支持如下三种距离计算方法： "euclidean" （欧式距离）、 "chessboard" （棋盘距离、切比雪夫距离） 或 "taxicab" （出租车距离、曼哈顿距离）。默认值： "euclidean" 。

• symmetric (bool) - 是否计算 y_pred 和 y 之间的对称平均平面距离。如果为 False ，计算方式为 $RmsSurDis(y\mathrm{\_}pred,y)$ ；如果为 True ，计算方式为 $RmsSurDis(y\mathrm{\_}pred\leftrightarrow y)$ 。默认值： False 。

支持平台：

Ascend GPU CPU

样例：

>>> import numpy as np
>>> from mindspore import Tensor
>>> from mindspore.train import RootMeanSquareDistance
>>>
>>> x = Tensor(np.array([[3, 0, 1], [1, 3, 0], [1, 0, 2]]))
>>> y = Tensor(np.array([[0, 2, 1], [1, 2, 1], [0, 0, 1]]))
>>> metric = RootMeanSquareDistance(symmetric=False, distance_metric="euclidean")
>>> metric.clear()
>>> metric.update(x, y, 0)
>>> root_mean_square_distance = metric.eval()
>>> print(root_mean_square_distance)
1.0000000000000002

clear()

内部评估结果清零。

eval()

计算均方根表面距离。

返回：

numpy.float64，计算得到的均方根表面距离值。

异常：

• RuntimeError - 如果没有先调用update方法，则会报错。

update(*inputs)

使用 y_pred、 y 和 label_idx 更新内部评估结果。

参数：

• inputs - y_pred、 y 和 label_idx。 y_pred 和 y 为Tensor、list或numpy.ndarray。 y_pred 是预测的二值图像。 y 是实际的二值图像。 label_idx 数据类型为int或float，表示像素点的类别值。

异常：

• ValueError - 输入的数量不等于3。

• TypeError - label_idx 的数据类型不是int或float。

• ValueError - label_idx 的值不在 y_pred 或 y 中。

• ValueError - y_pred 和 y 的shape不同。