!37910 modify the Chinese API files
Merge pull request !37910 from 宦晓玲/code_docs_0712
This commit is contained in:
Gitee
commit
331de15f22
|
|
@ -10,7 +10,6 @@ mindspore.dataset.audio.AmplitudeToDB
|
|||
参数：
|
||||
- **stype** ( :class:`mindspore.dataset.audio.utils.ScaleType` , 可选) - 输入音频的原始标度，取值可为ScaleType.MAGNITUDE或ScaleType.POWER，默认值：ScaleType.POWER。
|
||||
- **ref_value** (float, 可选) - 系数参考值，默认值：1.0，用于计算分贝系数 `db_multiplier` ，公式为
|
||||
|
||||
:math:`db\_multiplier = Log10(max(ref\_value, amin))`。
|
||||
|
||||
- **amin** (float, 可选) - 波形取值下界，低于该值的波形将会被裁切，取值必须大于0，默认值：1e-10。
|
||||
|
|
|
|||
|
|
@ -5,9 +5,8 @@
|
|||
|
||||
在训练过程中管理联邦学习。
|
||||
|
||||
**参数：**
|
||||
|
||||
- **model** (nn.Cell) - 用于联邦训练的模型。
|
||||
参数：
|
||||
- **model** (nn.Cell) - 一个用于联邦训练的模型。
|
||||
- **sync_frequency** (int) - 联邦学习中的参数同步频率。
|
||||
需要注意在数据下沉模式中，频率的单位是epoch的数量。否则，频率的单位是step的数量。
|
||||
在自适应同步频率模式下为初始同步频率，在固定频率模式下为同步频率。
|
||||
|
|
@ -20,7 +19,8 @@
|
|||
取值范围：大于等于0.0。默认值：1.1。
|
||||
- **min_consistent_rate_at_round** (int) - 最小一致性比率阈值的轮数，该值越大同步频率提升难度越大。
|
||||
取值范围：大于等于0。默认值：0。
|
||||
- **ema_alpha** (float) - 梯度一致性平滑系数，该值越小越会根据当前轮次的梯度分叉情况来判断频率是否需要改变，反之则会更加根据历史梯度分叉情况来判断。
|
||||
- **ema_alpha** (float) - 梯度一致性平滑系数，该值越小越会根据当前轮次的梯度分叉情况来判断频率是否
|
||||
需要改变，反之则会更加根据历史梯度分叉情况来判断。
|
||||
取值范围：(0.0, 1.0)。默认值：0.5。
|
||||
- **observation_window_size** (int) - 观察时间窗的轮数，该值越大同步频率减小难度越大。
|
||||
取值范围：大于0。默认值：5。
|
||||
|
|
@ -36,6 +36,5 @@
|
|||
|
||||
在step结束时同步参数。如果 `sync_type` 是"adaptive"，同步频率会在这里自适应的调整。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **run_context** (RunContext) - 包含模型的相关信息。
|
||||
|
|
@ -106,12 +106,11 @@ Federated-Server
|
|||
| | download_compress_type | server |
|
||||
+-------------------------+---------------------------------+-----------------------------+
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **enable_fl** (bool) - 是否启用联邦学习训练模式。默认值：False。
|
||||
- **server_mode** (str) - 描述服务器模式，它必须是'FEDERATED_LEARNING'和'HYBRID_TRAINING'中的一个。
|
||||
- **ms_role** (str) - 进程在联邦学习模式中的角色，
|
||||
它必须是'MS_SERVER'、'MS_WORKER'和'MS_SCHED'中的一个。
|
||||
必须是'MS_SERVER'、'MS_WORKER'和'MS_SCHED'中的一个。
|
||||
- **worker_num** (int) - 云侧训练进程的数量。
|
||||
- **server_num** (int) - 联邦学习服务器的数量。默认值：0。
|
||||
- **scheduler_ip** (str) - 调度器IP。默认值：'0.0.0.0'。
|
||||
|
|
@ -127,12 +126,13 @@ Federated-Server
|
|||
- **client_batch_size** (int) - 客户端训练数据batch数。默认值：32。
|
||||
- **client_learning_rate** (float) - 客户端训练学习率。默认值：0.001。
|
||||
- **worker_step_num_per_iteration** (int) - 端云联邦中，云侧训练进程在与服务器通信之前的独立训练步数。默认值：65。
|
||||
- **encrypt_type** (str) - 用于联邦学习的安全策略，支持['NOT_ENCRYPT'、'DP_ENCRYPT'、'PW_ENCRYPT'、'STABLE_PW_ENCRYPT', 'SIGNDS']。 默认值：'NOT_ENCRYPT'。
|
||||
如果是'DP_ENCRYPT'，则将对客户端应用差分隐私模式，隐私保护效果将由dp_eps、dp_delta、dp_norm_clip确定；
|
||||
如果是'PW_ENCRYPT'，则将应用成对（pairwise，PW）安全聚合来保护客户端模型在跨设备场景中不被窃取；
|
||||
如果是'STABLE_PW_ENCRYPT'，则将应用成对安全聚合来保护客户端模型在云云联邦场景中免受窃取；
|
||||
如果是'SIGNDS'，则将在于客户端上使用SignDS策略。
|
||||
SignDS的介绍可以参照：`SignDS-FL: Local Differentially Private Federated Learning with Sign-based Dimension Selection <https://dl.acm.org/doi/abs/10.1145/3517820>`_。
|
||||
- **encrypt_type** (str) - 用于联邦学习的安全策略，可以是'NOT_ENCRYPT'、'DP_ENCRYPT'、
|
||||
'PW_ENCRYPT'、'STABLE_PW_ENCRYPT'或'SIGNDS'。如果是'DP_ENCRYPT'，则将对客户端应用差分隐私模式，
|
||||
隐私保护效果将由上面所述的dp_eps、dp_delta、dp_norm_clip确定。如果'PW_ENCRYPT'，则将应用成对（pairwise，PW）安全聚合
|
||||
来保护客户端模型在跨设备场景中不被窃取。如果'STABLE_PW_ENCRYPT'，则将应用成对安全聚合来保护客户端模型在云云联邦场景中
|
||||
免受窃取。如果'SIGNDS'，则将在于客户端上使用SignDS策略。SignDS的介绍可以参照：
|
||||
`SignDS-FL: Local Differentially Private Federated Learning with Sign-based Dimension Selection <https://dl.acm.org/doi/abs/10.1145/3517820>`_。
|
||||
默认值：'NOT_ENCRYPT'。
|
||||
- **share_secrets_ratio** (float) - PW：参与秘密分享的客户端比例。默认值：1.0。
|
||||
- **cipher_time_window** (int) - PW：每个加密轮次的时间窗口持续时间，以毫秒为单位。默认值：300000。
|
||||
- **reconstruct_secrets_threshold** (int) - PW：秘密重建的阈值。默认值：2000。
|
||||
|
|
@ -144,18 +144,18 @@ Federated-Server
|
|||
- **sign_thr_ratio** (float) - SignDS：预期Top-k维度的阈值。建议取值范围在[0.5, 1]内。默认值：0.6。
|
||||
- **sign_global_lr** (float) - SignDS：分配给选定维的常量值。适度增大该值会提高收敛速度，但有可能让模型梯度爆炸。取值必须大于0。默认值：1。
|
||||
- **sign_dim_out** (int) - SignDS：输出维度的数量。建议取值范围在[0, 50]内。默认值：0。
|
||||
- **config_file_path** (str) - 用于集群容灾恢复的配置文件路径、认证相关参数以及文件路径、评价指标文件路径和运维相关文件路径。默认值：''。
|
||||
- **config_file_path** (str) - 用于集群容灾恢复的配置文件路径、认证相关参数以及文件路径、评价指标文件路径和运维相关文件路径。默认值：""。
|
||||
- **scheduler_manage_port** (int) - 用于扩容/缩容的调度器管理端口。默认值：11202。
|
||||
- **enable_ssl** (bool) - 设置联邦学习开启SSL安全通信。默认值：False。
|
||||
- **client_password** (str) - 解密客户端证书中存储的秘钥的密码。默认值：''。
|
||||
- **server_password** (str) - 解密服务器证书中存储的秘钥的密码。默认值：''。
|
||||
- **client_password** (str) - 解密客户端证书中存储的秘钥的密码。默认值：""。
|
||||
- **server_password** (str) - 解密服务器证书中存储的秘钥的密码。默认值：""。
|
||||
- **pki_verify** (bool) - 如果为True，则将打开服务器和客户端之间的身份验证。
|
||||
还应从`CBG PKI Download Management <https://pki.consumer.huawei.com/ca/>`_ 下载Root CA证书、Root CA G2证书和移动设备CRL证书。
|
||||
还应从https://pki.consumer.huawei.com/ca/下载Root CA证书、Root CA G2证书和移动设备CRL证书。
|
||||
需要注意的是，只有当客户端是具有HUKS服务的Android环境时，pki_verify可以为True。默认值：False。
|
||||
- **root_first_ca_path** (str) - Root CA证书的文件路径。当pki_verify为True时，需要设置该值。默认值：""。
|
||||
- **root_second_ca_path** (str) - Root CA G2证书的文件路径。当pki_verify为True时，需要设置该值。默认值：""。
|
||||
- **equip_crl_path** (str) - 移动设备CRL证书的文件路径。当pki_verify为True时，需要设置该值。默认值：""。
|
||||
- **replay_attack_time_diff** (int) - 证书时间戳验证的最大可容忍错误时间（毫秒）。默认值：600000。
|
||||
- **replay_attack_time_diff** (int) - 证书时间戳验证的最大可容忍错误（毫秒）。默认值：600000。
|
||||
- **http_url_prefix** (str) - 设置联邦学习端云通信的http路径。默认值：""。
|
||||
- **global_iteration_time_window** (int) - 一次迭代的全局时间窗口，轮次（ms）。默认值：3600000。
|
||||
- **checkpoint_dir** (str) - server读取和保存模型文件的目录。若没有设置则不读取和保存模型文件。默认值：""。
|
||||
|
|
@ -165,8 +165,7 @@ Federated-Server
|
|||
- **download_compress_type** (str) - 下载压缩方法。可以是'NO_COMPRESS'或'QUANT'。如果是'NO_COMPRESS'，则不对下载的模型进行压缩。
|
||||
如果是'QUANT'，则对下载的模型使用量化压缩策略。默认值：'NO_COMPRESS'。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - 如果输入key不是联邦学习模式context中的属性。
|
||||
|
||||
|
||||
|
|
@ -174,15 +173,13 @@ Federated-Server
|
|||
|
||||
根据key获取联邦学习模式context中的属性值。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **attr_key** (str) - 属性的key。
|
||||
请参考 `set_fl_context` 中的参数来决定应传递的key。
|
||||
|
||||
**返回：**
|
||||
|
||||
Object，表示给定属性key的值。
|
||||
|
||||
**异常：**
|
||||
返回：
|
||||
根据key返回属性值。
|
||||
|
||||
异常：
|
||||
- **ValueError** - 如果输入key不是联邦学习模式context中的属性。
|
||||
|
||||
|
|
|
|||
|
|
@ -6,13 +6,11 @@
|
|||
.. note::
|
||||
示例的详细信息，请参见 `转换CIFAR-10数据集 <https://www.mindspore.cn/tutorials/zh-CN/master/advanced/dataset/record.html#转换cifar-10数据集>`_。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **source** (str) - 待转换的CIFAR-100数据集文件所在目录的路径。
|
||||
- **destination** (str) - 转换生成的MindRecord文件路径，需提前创建目录并且目录下不能存在同名文件。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - 参数 `source` 或 `destination` 无效。
|
||||
|
||||
|
||||
|
|
@ -20,25 +18,20 @@
|
|||
|
||||
执行从CIFAR-100数据集到MindRecord格式数据集的转换。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **fields** (list[str]，可选) - 索引字段的列表，例如['fine_label', 'coarse_label']。默认值：None。
|
||||
索引字段的设置请参考函数 :func:`mindspore.mindrecord.FileWriter.add_index` 。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
MSRStatus，SUCCESS或FAILED。
|
||||
|
||||
|
||||
.. py:method:: transform(fields=None)
|
||||
|
||||
:func:`mindspore.mindrecord.Cifar100ToMR.run` 的包装函数来保证异常时正常退出。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **fields** (list[str]，可选) - 索引字段的列表，例如['fine_label', 'coarse_label']。默认值：None。
|
||||
索引字段的设置请参考函数 :func:`mindspore.mindrecord.FileWriter.add_index` 。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
MSRStatus，SUCCESS或FAILED。
|
||||
|
|
|
|||
|
|
@ -6,40 +6,32 @@
|
|||
.. note::
|
||||
示例的详细信息，请参见 `转换CIFAR-10数据集 <https://www.mindspore.cn/tutorials/zh-CN/master/advanced/dataset/record.html#转换cifar-10数据集>`_。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **source** (str) - 待转换的CIFAR-10数据集文件所在目录的路径。
|
||||
- **destination** (str) - 转换生成的MindRecord文件路径，需提前创建目录并且目录下不能存在同名文件。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - `source` 或 `destination` 无效。
|
||||
|
||||
|
||||
.. py:method:: run(fields=None)
|
||||
|
||||
执行从CIFAR-10数据集到MindRecord格式数据集的转换。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **fields** (list[str]，可选) - 索引字段的列表。默认值：None。
|
||||
索引字段的设置请参考函数 :func:`mindspore.mindrecord.FileWriter.add_index` 。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
MSRStatus，SUCCESS或FAILED。
|
||||
|
||||
|
||||
.. py:method:: transform(fields=None)
|
||||
|
||||
:func:`mindspore.mindrecord.Cifar10ToMR.run` 的包装函数来保证异常时正常退出。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **fields** (list[str]，可选) - 索引字段的列表。默认值：None。
|
||||
索引字段的设置请参考函数 :func:`mindspore.mindrecord.FileWriter.add_index` 。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
MSRStatus，SUCCESS或FAILED。
|
||||
|
||||
|
|
|
|||
|
|
@ -6,15 +6,13 @@
|
|||
.. note::
|
||||
示例的详细信息，请参见 `转换CSV数据集 <https://www.mindspore.cn/tutorials/zh-CN/master/advanced/dataset/record.html#转换csv数据集>`_。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **source** (str) - 待转换的CSV文件路径。
|
||||
- **destination** (str) - 转换生成的MindRecord文件路径，需提前创建目录并且目录下不能存在同名文件。
|
||||
- **columns_list** (list[str]，可选) - CSV中待读取数据列的列表。默认值：None，读取所有的数据列。
|
||||
- **partition_number** (int，可选) - 生成MindRecord的文件个数。默认值：1。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - 参数 `source` 、`destination` 、`partition_number` 无效。
|
||||
- **RuntimeError** - 参数 `columns_list` 无效。
|
||||
|
||||
|
|
@ -23,15 +21,12 @@
|
|||
|
||||
执行从CSV格式数据集到MindRecord格式数据集的转换。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
MSRStatus，SUCCESS或FAILED。
|
||||
|
||||
|
||||
.. py:method:: transform()
|
||||
|
||||
:func:`mindspore.mindrecord.CsvToMR.run` 的包装函数来保证异常时正常退出。
|
||||
|
||||
**返回：**
|
||||
|
||||
MSRStatus，SUCCESS或FAILED。
|
||||
返回：
|
||||
SRStatus，SUCCESS或FAILED。
|
||||
|
|
|
|||
|
|
@ -7,31 +7,25 @@
|
|||
- 如果 `file_name` 是文件路径的字符串，则会尝试加载同一批转换生成的所有MindRecord文件，如果缺少其中某个MindRecord文件，则会引发异常。
|
||||
- 如果 `file_name` 是文件路径组成的列表，则只加载列表中指定的MindRecord文件。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **file_name** (str, list[str]) - MindRecord格式的数据集文件路径或文件路径组成的列表。
|
||||
- **num_consumer** (int，可选) - 加载数据的并发数。默认值：4。不应小于1或大于处理器的核数。
|
||||
- **columns** (list[str]，可选) - MindRecord中待读取数据列的列表。默认值：None，读取所有的数据列。
|
||||
- **operator** (int，可选) - 保留参数。默认值：None。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ParamValueError** - `file_name` 、`num_consumer` 或 `columns` 无效。
|
||||
|
||||
|
||||
.. py:method:: close()
|
||||
|
||||
停止数据集加载并且关闭文件句柄。
|
||||
|
||||
|
||||
.. py:method:: get_next()
|
||||
|
||||
按列名一次返回下一批的数据。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
dict，下一批数据，键值与数据列名相同。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **MRMUnsupportedSchemaError** - 当schema无效。
|
||||
|
|
|
|||
|
|
@ -6,17 +6,14 @@
|
|||
.. note::
|
||||
生成MindRecord文件后，如果修改文件名，可能会导致读取文件失败。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **file_name** (str) - 转换生成的MindRecord文件路径。
|
||||
- **shard_num** (int，可选) - 生成MindRecord的文件个数。取值范围为[1, 1000]。默认值：1。
|
||||
- **overwrite** (bool，可选) - 当指定目录存在同名文件时是否覆盖写。默认值：False。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ParamValueError** - `file_name` 或 `shard_num` 无效。
|
||||
|
||||
|
||||
.. py:method:: add_index(index_fields)
|
||||
|
||||
指定schema中的字段作为索引来加速MindRecord文件的读取。schema可以通过 `add_schema` 来添加。
|
||||
|
|
@ -26,22 +23,18 @@
|
|||
- 如果不调用该函数，则默认将schema中所有的Primitive类型的字段设置为索引。
|
||||
请参考类的示例 :class:`mindspore.mindrecord.FileWriter` 。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **index_fields** (list[str]) - schema中的字段。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
MSRStatus，SUCCESS或FAILED。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ParamTypeError** - 索引字段无效。
|
||||
- **MRMDefineIndexError** - 索引字段不是Primitive类型。
|
||||
- **MRMAddIndexError** - 无法添加索引字段。
|
||||
- **MRMGetMetaError** - 未设置schema或无法获取schema。
|
||||
|
||||
|
||||
.. py:method:: add_schema(content, desc=None)
|
||||
|
||||
增加描述用户自定义数据的schema。
|
||||
|
|
@ -49,22 +42,18 @@
|
|||
.. note::
|
||||
请参考类的示例 :class:`mindspore.mindrecord.FileWriter` 。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **content** (dict) - schema内容的字典。
|
||||
- **desc** (str，可选) - schema的描述。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
int，schema ID。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **MRMInvalidSchemaError** - schema无效。
|
||||
- **MRMBuildSchemaError** - 构建schema失败。
|
||||
- **MRMAddSchemaError** - 添加schema失败。
|
||||
|
||||
|
||||
.. py:method:: commit()
|
||||
|
||||
将内存中的数据同步到磁盘，并生成相应的数据库文件。
|
||||
|
|
@ -72,12 +61,10 @@
|
|||
.. note::
|
||||
请参考类的示例 :class:`mindspore.mindrecord.FileWriter` 。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
MSRStatus，SUCCESS或FAILED。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **MRMOpenError** - 打开MindRecord文件失败。
|
||||
- **MRMSetHeaderError** - 设置MindRecord文件的header失败。
|
||||
- **MRMIndexGeneratorError** - 创建索引Generator失败。
|
||||
|
|
@ -89,73 +76,57 @@
|
|||
|
||||
打开MindRecord文件准备写入并且设置描述其meta信息的头部，该函数仅用于并行写入，并在 `write_raw_data` 函数之前调用。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
MSRStatus，SUCCESS或FAILED。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **MRMOpenError** - 打开MindRecord文件失败。
|
||||
- **MRMSetHeaderError** - 设置MindRecord文件的header失败。
|
||||
|
||||
|
||||
.. py:method:: open_for_append(file_name)
|
||||
|
||||
打开MindRecord文件，准备追加数据。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **file_name** (str) - MindRecord格式的数据集文件的路径。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
FileWriter，MindRecord文件的写对象。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ParamValueError** - `file_name` 无效。
|
||||
- **FileNameError** - MindRecord文件路径中包含无效字符。
|
||||
- **MRMOpenError** - 打开MindRecord文件失败。
|
||||
- **MRMOpenForAppendError** - 打开MindRecord文件追加数据失败。
|
||||
|
||||
|
||||
.. py:method:: set_header_size(header_size)
|
||||
|
||||
设置MindRecord文件的header，其中包含shard信息、schema信息、page的元信息等。
|
||||
header越大，MindRecord文件可以存储更多的元信息。如果header大于默认大小（16MB），需要调用本函数来设置合适的大小。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **header_size** (int) - header大小，可设置范围为16*1024(16KB)到128*1024*1024(128MB)。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
MSRStatus，SUCCESS或FAILED。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **MRMInvalidHeaderSizeError** - 设置header大小失败。
|
||||
|
||||
|
||||
.. py:method:: set_page_size(page_size)
|
||||
|
||||
设置存储数据的page大小，page分为两种类型：raw page和blob page。
|
||||
page越大，page可以存储更多的数据。如果单个样本大于默认大小（32MB），需要调用本函数来设置合适的大小。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **page_size** (int) - page大小，可设置范围为32*1024(32KB)到256*1024*1024(256MB)。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
MSRStatus，SUCCESS或FAILED。
|
||||
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **MRMInvalidPageSizeError** - 设置page大小失败。
|
||||
|
||||
|
||||
.. py:method:: write_raw_data(raw_data, parallel_writer=False)
|
||||
|
||||
根据schema校验用户自定义数据后，将数据转换为一系列连续的MindRecord格式的数据集文件。
|
||||
|
|
@ -163,17 +134,14 @@
|
|||
.. note::
|
||||
请参考类的示例 :class:`mindspore.mindrecord.FileWriter` 。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **raw_data** (list[dict]) - 用户自定义数据的列表。
|
||||
- **parallel_writer** (bool，可选) - 如果为True，则并行写入用户自定义数据。默认值：False。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
MSRStatus，SUCCESS或FAILED。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ParamTypeError** - 索引字段无效。
|
||||
- **MRMOpenError** - 打开MindRecord文件失败。
|
||||
- **MRMValidateDataError** - 数据校验失败。
|
||||
|
|
|
|||
|
|
@ -3,8 +3,7 @@
|
|||
|
||||
将ImageNet数据集转换为MindRecord格式数据集。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **map_file** (str) - 标签映射文件的路径。映射文件内容如下：
|
||||
|
||||
.. code-block::
|
||||
|
|
@ -18,23 +17,19 @@
|
|||
- **destination** (str) - 转换生成的MindRecord文件路径，需提前创建目录并且目录下不能存在同名文件。
|
||||
- **partition_number** (int，可选) - 生成MindRecord的文件个数。默认值：1。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - 参数 `map_file` 、`image_dir` 或 `destination` 无效。
|
||||
|
||||
.. py:method:: run()
|
||||
|
||||
执行从ImageNet数据集到MindRecord格式数据集的转换。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
MSRStatus，SUCCESS或FAILED。
|
||||
|
||||
|
||||
.. py:method:: transform()
|
||||
|
||||
:func:`mindspore.mindrecord.ImageNetToMR.run` 的包装函数来保证异常时正常退出。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
MSRStatus，SUCCESS或FAILED。
|
||||
|
|
|
|||
|
|
@ -3,24 +3,20 @@
|
|||
|
||||
以分页方式读取MindRecord文件的类。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **file_name** (Union[str, list[str]]) - MindRecord格式的数据集文件或文件列表。
|
||||
- **num_consumer** (int，可选) - 加载数据的并发数。默认值：4。不应小于1或大于处理器的核数。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ParamValueError** - `file_name` 、`num_consumer` 或 `columns` 无效。
|
||||
- **MRMInitSegmentError** - 初始化ShardSegment失败。
|
||||
|
||||
|
||||
.. py:method:: candidate_fields
|
||||
:property:
|
||||
|
||||
返回用于数据分组的候选category字段。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
list[str]，候选category 字段。
|
||||
|
||||
|
||||
|
|
@ -29,17 +25,14 @@
|
|||
|
||||
返回用于数据分组的category字段。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
list[str]，category字段。
|
||||
|
||||
|
||||
.. py:method:: get_category_fields()
|
||||
|
||||
返回用于数据分组的候选category字段。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
list[str]，候选category字段。
|
||||
|
||||
|
||||
|
|
@ -47,51 +40,41 @@
|
|||
|
||||
以分页方式按category ID进行查询。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **category_id** (int) - category ID，参考 `read_category_info` 函数的返回值。
|
||||
- **page** (int) - 分页的索引。
|
||||
- **num_row** (int) - 每个分页的行数。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
list[dict]，根据category ID查询的数据。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ParamValueError** - 参数无效。
|
||||
- **MRMFetchDataError** - 无法按category ID获取数据。
|
||||
- **MRMUnsupportedSchemaError** - schema无效。
|
||||
|
||||
|
||||
.. py:method:: read_at_page_by_name(category_name, page, num_row)
|
||||
|
||||
以分页方式按category字段进行查询。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **category_name** (str) - category字段对应的字符，参考 `read_category_info` 函数的返回值。
|
||||
- **page** (int) - 分页的索引。
|
||||
- **num_row** (int) - 每个分页的行数。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
list[dict]，根据category字段查询的数据。
|
||||
|
||||
|
||||
.. py:method:: read_category_info()
|
||||
|
||||
当数据按指定的category字段进行分组时，返回category信息。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
str，分组信息的描述。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **MRMReadCategoryInfoError** - 读取category信息失败。
|
||||
|
||||
|
||||
.. py:method:: set_category_field(category_field)
|
||||
|
||||
设置category字段。
|
||||
|
|
@ -99,10 +82,8 @@
|
|||
.. note::
|
||||
必须是候选category字段。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **category_field** (str) - category字段名称。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
MSRStatus，SUCCESS或FAILED
|
||||
|
|
|
|||
|
|
@ -3,30 +3,24 @@
|
|||
|
||||
将MNIST数据集转换为MindRecord格式数据集。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **source** (str) - 数据集目录路径，其包含t10k-images-idx3-ubyte.gz、train-images-idx3-ubyte.gz、t10k-labels-idx1-ubyte.gz和train-labels-idx1-ubyte.gz数据集文件。
|
||||
- **destination** (str) - 转换生成的MindRecord文件路径，需提前创建目录并且目录下不能存在同名文件。
|
||||
- **partition_number** (int，可选) - 生成MindRecord的文件个数。默认值：1。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - 参数 `source` 、 `destination` 、 `partition_number` 无效。
|
||||
|
||||
|
||||
.. py:method:: run()
|
||||
|
||||
执行从MNIST数据集到MindRecord格式数据集的转换。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
MSRStatus，MNIST数据集是否成功转换为MindRecord格式数据集。
|
||||
|
||||
|
||||
.. py:method:: transform()
|
||||
|
||||
:func:`mindspore.mindrecord.MnistToMR.run` 函数的包装函数来保证异常时正常退出。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
MSRStatus，SUCCESS或FAILED。
|
||||
|
|
|
|||
|
|
@ -6,51 +6,41 @@
|
|||
.. note::
|
||||
示例的详细信息，请参见 `转换TFRecord数据集 <https://www.mindspore.cn/tutorials/zh-CN/master/advanced/dataset/record.html#转换tfrecord数据集>`_。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **source** (str) - 待转换的TFRecord文件路径。
|
||||
- **destination** (str) - 转换生成的MindRecord文件路径，需提前创建目录并且目录下不能存在同名文件。
|
||||
- **feature_dict** (dict[str, FixedLenFeature]) - TFRecord的feature类别的字典，当前支持
|
||||
`FixedLenFeature <https://www.tensorflow.org/api_docs/python/tf/io/FixedLenFeature>`_ 类型。
|
||||
- **bytes_fields** (list[str]，可选) - `feature_dict` 中的字节字段，可以为字节类型的图像字段。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - 无效参数。
|
||||
- **Exception** - 找不到TensorFlow模块或其版本不正确。
|
||||
|
||||
|
||||
.. py:method:: run()
|
||||
|
||||
执行从TFRecord格式数据集到MindRecord格式数据集的转换。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
MSRStatus，SUCCESS或FAILED。
|
||||
|
||||
|
||||
.. py:method:: tfrecord_iterator()
|
||||
|
||||
生成一个字典，其key是schema中的字段，value是数据。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Dict，key与schema中字段名相同的数据字典。
|
||||
|
||||
|
||||
.. py:method:: tfrecord_iterator_oldversion()
|
||||
|
||||
生成一个字典，其中key是schema中的字段，value是数据。该函数适用于早于2.1.0版本的TensorFlow。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Dict，key与schema中字段名相同的数据字典。
|
||||
|
||||
|
||||
.. py:method:: transform()
|
||||
|
||||
:func:`mindspore.mindrecord.TFRecordToMR.run` 的包装函数来保证异常时正常退出。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
MSRStatus，SUCCESS或FAILED。
|
||||
|
|
|
|||
|
|
@ -5,8 +5,7 @@ mindspore.nn.probability.bijector.Bijector
|
|||
|
||||
Bijector类。Bijector描述了一种随机变量的映射方法，可以通过一个已有的随机变量 :math:`X` 和一个映射函数 :math:`g` 生成一个新的随机变量 :math:`Y = g(X)` 。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **is_constant_jacobian** (bool) - Bijector是否具有常数导数。默认值：False。
|
||||
- **is_injective** (bool) - Bijector是否为一对一映射。默认值：True。
|
||||
- **name** (str) - Bijector名称。默认值：None。
|
||||
|
|
@ -30,8 +29,7 @@ mindspore.nn.probability.bijector.Bijector
|
|||
|
||||
将输入中的 `para` 的数据类型转换为与 `value` 相同的类型，一般由Bijector的子类用于基于输入对自身参数进行数据类型变化。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输入数据。
|
||||
- **para** (Tensor) - Bijector参数。
|
||||
|
||||
|
|
@ -42,8 +40,7 @@ mindspore.nn.probability.bijector.Bijector
|
|||
.. note::
|
||||
支持的函数名称包括：'forward'、'inverse'、'forward_log_jacobian'、'inverse_log_jacobian'。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **name** (str) - 函数名称。
|
||||
- **args** (list) - 函数所需的位置参数列表。
|
||||
- **kwargs** (dict) - 函数所需的关键字参数字典。
|
||||
|
|
@ -52,54 +49,46 @@ mindspore.nn.probability.bijector.Bijector
|
|||
|
||||
正映射，计算输入随机变量 :math:`X = value` 经过映射后的值 :math:`Y = g(value)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输入随机变量的值。
|
||||
- **args** (list) - 函数所需的位置参数列表。
|
||||
- **kwargs** (dict) - 函数所需的关键字参数字典。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，输出随机变量的值。
|
||||
|
||||
.. py:method:: forward_log_jacobian(value, *args, **kwargs)
|
||||
|
||||
计算正映射导数的对数值，即 :math:`\log(dg(x) / dx)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输入随机变量的值。
|
||||
- **args** (list) - 函数所需的位置参数列表。
|
||||
- **kwargs** (dict) - 函数所需的关键字参数字典。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，正映射导数的对数值。
|
||||
|
||||
.. py:method:: inverse(value, *args, **kwargs)
|
||||
|
||||
逆映射，计算输出随机变量 :math:`Y = value` 时对应的输入随机变量的值 :math:`X = g^{-1}(value)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输出随机变量的值。
|
||||
- **args** (list) - 函数所需的位置参数列表。
|
||||
- **kwargs** (dict) - 函数所需的关键字参数字典。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，输入随机变量的值。
|
||||
|
||||
.. py:method:: inverse_log_jacobian(value, *args, **kwargs)
|
||||
|
||||
计算逆映射导数的对数值，即 :math:`\log(dg^{-1}(x) / dx)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输出随机变量的值。
|
||||
- **args** (list) - 函数所需的位置参数列表。
|
||||
- **kwargs** (dict) - 函数所需的关键字参数字典。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，逆映射导数的对数值。
|
||||
|
|
|
|||
|
|
@ -9,8 +9,7 @@ mindspore.nn.probability.bijector.Exp
|
|||
.. math::
|
||||
Y = \exp(x).
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **name** (str) - Bijector名称。默认值：'Exp'。
|
||||
|
||||
|
||||
|
|
@ -18,46 +17,38 @@ mindspore.nn.probability.bijector.Exp
|
|||
|
||||
正映射，计算输入随机变量 :math:`X = value` 经过映射后的值 :math:`Y = \exp(value)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输入随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，输出随机变量的值。
|
||||
|
||||
.. py:method:: forward_log_jacobian(value)
|
||||
|
||||
计算正映射导数的对数值，即 :math:`\log(d\exp(x) / dx)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输入随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，正映射导数的对数值。
|
||||
|
||||
.. py:method:: inverse(value)
|
||||
|
||||
正映射，计算输出随机变量 :math:`Y = value` 时对应的输入随机变量的值 :math:`X = \log(value)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输出随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，输入随机变量的值。
|
||||
|
||||
.. py:method:: inverse_log_jacobian(value)
|
||||
|
||||
计算逆映射导数的对数值，即 :math:`\log(d\log(x) / dx)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输出随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，逆映射导数的对数值。
|
||||
|
|
@ -9,8 +9,7 @@ mindspore.nn.probability.bijector.GumbelCDF
|
|||
.. math::
|
||||
Y = g(x) = \exp(-\exp(\frac{-(X - loc)}{scale}))
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (float, list, numpy.ndarray, Tensor) - 位移因子，即上述公式中的loc。默认值：0.0。
|
||||
- **scale** (float, list, numpy.ndarray, Tensor) - 比例因子，即上述公式中的scale。默认值：1.0。
|
||||
- **name** (str) - Bijector名称。默认值：'GumbelCDF'。
|
||||
|
|
@ -21,8 +20,7 @@ mindspore.nn.probability.bijector.GumbelCDF
|
|||
- `loc` 和 `scale` 中元素的数据类型必须为float。
|
||||
- 如果 `loc` 、 `scale` 作为numpy.ndarray或Tensor传入，则它们必须具有相同的数据类型，否则将引发错误。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **TypeError** - `loc` 或 `scale` 中元素的数据类型不为float，或 `loc` 和 `scale` 中元素的数据类型不相同。
|
||||
|
||||
.. py:method:: loc
|
||||
|
|
@ -30,8 +28,7 @@ mindspore.nn.probability.bijector.GumbelCDF
|
|||
|
||||
返回分布位置。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，分布的位置值。
|
||||
|
||||
.. py:method:: scale
|
||||
|
|
@ -39,54 +36,45 @@ mindspore.nn.probability.bijector.GumbelCDF
|
|||
|
||||
返回分布比例。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，分布的比例值。
|
||||
|
||||
.. py:method:: forward(value)
|
||||
|
||||
正映射，计算输入随机变量 :math:`X = value` 经过映射后的值 :math:`Y = g(value)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输入随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，输入随机变量的值。
|
||||
|
||||
.. py:method:: forward_log_jacobian(value)
|
||||
|
||||
计算正映射导数的对数值，即 :math:`\log(dg(x) / dx)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输入随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，正映射导数的对数值。
|
||||
|
||||
.. py:method:: inverse(value)
|
||||
|
||||
正映射，计算输出随机变量 :math:`Y = value` 时对应的输入随机变量的值 :math:`X = g(value)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输出随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，输出随机变量的值。
|
||||
|
||||
.. py:method:: inverse_log_jacobian(value)
|
||||
|
||||
计算逆映射导数的对数值，即 :math:`\log(dg^{-1}(x) / dx)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输出随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，逆映射导数的对数值。
|
||||
|
|
|
|||
|
|
@ -6,10 +6,9 @@ mindspore.nn.probability.bijector.Invert
|
|||
逆映射Bijector（Invert Bijector）。
|
||||
计算输入Bijector的逆映射。如果正向映射（下面的 `bijector` 输入)对应的映射函数为 :math:`Y = g(X)` ，那么对应的逆映射Bijector的映射函数为 :math:`Y = h(X) = g^{-1}(X)` 。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **bijector** (Bijector) - 基础Bijector（Base Bijector）。
|
||||
- **name** (str) - Bijector名称。默认值：""。当name设置为""时，它实际上是'Invert' + Bijector.name。
|
||||
- **name** (str) - Bijector名称。默认值：""。当name设置为""时，实际上是'Invert' + Bijector.name。
|
||||
|
||||
.. py:method:: bijector
|
||||
:property:
|
||||
|
|
@ -20,47 +19,39 @@ mindspore.nn.probability.bijector.Invert
|
|||
|
||||
计算基础Bijector的逆映射，即 :math:`Y = h(X) = g^{-1}(X)` 。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **x** (Tensor) - 基础Bijector的输出随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，基础Bijector的输入随机变量的值。
|
||||
|
||||
.. py:method:: forward_log_jacobian(x)
|
||||
|
||||
计算基础Bijector的逆映射导数的对数值，即 :math:`\log dg^{-1}(x) / dx` 。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **x** (Tensor) - 基础Bijector的输出随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，基类逆映射导数的对数值。
|
||||
|
||||
.. py:method:: inverse(y)
|
||||
|
||||
计算基础Bijector的正映射，即 :math:`Y = g(X)` 。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **y** (Tensor) - 基础Bijector的输入随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，基础Bijector的输出随机变量的值。
|
||||
|
||||
.. py:method:: inverse_log_jacobian(y)
|
||||
|
||||
计算基础Bijector的正映射导数的对数，即 :math:`Y = \log dg(x) / dx` 。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **y** (Tensor) - 基础Bijector的输入随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，基类正映射导数的对数值。
|
||||
|
||||
|
|
|
|||
|
|
@ -15,16 +15,14 @@ mindspore.nn.probability.bijector.PowerTransform
|
|||
|
||||
当 `c=0` 时，此Bijector等于 :class:`mindspore.nn.probability.bijector.Exp` Bijector。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **power** (float, list, numpy.ndarray, Tensor) - 比例因子。默认值：0。
|
||||
- **name** (str) - Bijector名称。默认值：'PowerTransform'。
|
||||
|
||||
.. note::
|
||||
`power` 中元素的数据类型必须为float。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - `power` 中元素小于0或静态未知。
|
||||
- **TypeError** - `power` 中元素的数据类型不是float。
|
||||
|
||||
|
|
@ -33,54 +31,45 @@ mindspore.nn.probability.bijector.PowerTransform
|
|||
|
||||
返回指数。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，Bijector的指数。
|
||||
|
||||
.. py:method:: forward(value)
|
||||
|
||||
正映射，计算输入随机变量 :math:`X = value` 经过映射后的值 :math:`Y = g(value)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输入随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，输入随机变量的值。
|
||||
|
||||
.. py:method:: forward_log_jacobian(value)
|
||||
|
||||
计算正映射导数的对数值，即 :math:`\log(dg(x) / dx)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输入随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，正映射导数的对数值。
|
||||
|
||||
.. py:method:: inverse(value)
|
||||
|
||||
正映射，计算输出随机变量 :math:`Y = value` 时对应的输入随机变量的值 :math:`X = g(value)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输出随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，输出随机变量的值。
|
||||
|
||||
.. py:method:: inverse_log_jacobian(value)
|
||||
|
||||
计算逆映射导数的对数值，即 :math:`\log(dg^{-1}(x) / dx)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输出随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，逆映射导数的对数值。
|
||||
|
|
|
|||
|
|
@ -11,8 +11,7 @@ mindspore.nn.probability.bijector.ScalarAffine
|
|||
|
||||
其中a是比例因子，b是移位因子。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **scale** (float, list, numpy.ndarray, Tensor) - 比例因子。默认值：1.0。
|
||||
- **shift** (float, list, numpy.ndarray, Tensor) - 移位因子。默认值：0.0。
|
||||
- **name** (str) - Bijector名称。默认值：'ScalarAffine'。
|
||||
|
|
@ -20,8 +19,7 @@ mindspore.nn.probability.bijector.ScalarAffine
|
|||
.. note::
|
||||
`shift` 和 `scale` 中元素的数据类型必须为float。如果 `shift` 、 `scale` 作为numpy.ndarray或Tensor传入，则它们必须具有相同的数据类型，否则将引发错误。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **TypeError** - `shift` 或 `scale` 中元素的数据类型不为float，或 `shift` 和 `scale` 的数据类型不相同。
|
||||
|
||||
.. py:method:: shift
|
||||
|
|
@ -29,8 +27,7 @@ mindspore.nn.probability.bijector.ScalarAffine
|
|||
|
||||
返回映射的位置。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，映射的位置值。
|
||||
|
||||
.. py:method:: scale
|
||||
|
|
@ -38,54 +35,45 @@ mindspore.nn.probability.bijector.ScalarAffine
|
|||
|
||||
返回映射的比例。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，映射的比例值。
|
||||
|
||||
.. py:method:: forward(value)
|
||||
|
||||
正映射，计算输入随机变量 :math:`X = value` 经过映射后的值 :math:`Y = g(value)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输入随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，输入随机变量的值。
|
||||
|
||||
.. py:method:: forward_log_jacobian(value)
|
||||
|
||||
计算正映射导数的对数值，即 :math:`\log(dg(x) / dx)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输入随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，正映射导数的对数值。
|
||||
|
||||
.. py:method:: inverse(value)
|
||||
|
||||
正映射，计算输出随机变量 :math:`Y = value` 时对应的输入随机变量的值 :math:`X = g(value)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输出随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，输出随机变量的值。
|
||||
|
||||
.. py:method:: inverse_log_jacobian(value)
|
||||
|
||||
计算逆映射导数的对数值，即 :math:`\log(dg^{-1}(x) / dx)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输出随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，逆映射导数的对数值。
|
||||
|
|
|
|||
|
|
@ -11,16 +11,14 @@ mindspore.nn.probability.bijector.Softplus
|
|||
|
||||
其中k是锐度因子。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **sharpness** (float, list, numpy.ndarray, Tensor) - 锐度因子，上述公式中的k。默认值：1.0。
|
||||
- **name** (str) - Bijector名称。默认值：'Softplus'。
|
||||
|
||||
.. note::
|
||||
`sharpness` 中元素的数据类型必须为float。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **TypeError** - sharpness中元素的数据类型不为float。
|
||||
|
||||
.. py:method:: sharpness
|
||||
|
|
@ -28,54 +26,45 @@ mindspore.nn.probability.bijector.Softplus
|
|||
|
||||
返回映射的锐度因子。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，映射的锐度因子。
|
||||
|
||||
.. py:method:: forward(value)
|
||||
|
||||
正映射，计算输入随机变量 :math:`X = value` 经过映射后的值 :math:`Y = g(value)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输入随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，输入随机变量的值。
|
||||
|
||||
.. py:method:: forward_log_jacobian(value)
|
||||
|
||||
计算正映射导数的对数值，即 :math:`\log(dg(x) / dx)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输入随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，正映射导数的对数值。
|
||||
|
||||
.. py:method:: inverse(value)
|
||||
|
||||
正映射，计算输出随机变量 :math:`Y = value` 时对应的输入随机变量的值 :math:`X = g(value)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输出随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，输出随机变量的值。
|
||||
|
||||
.. py:method:: inverse_log_jacobian(value)
|
||||
|
||||
计算逆映射导数的对数值，即 :math:`\log(dg^{-1}(x) / dx)`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 输出随机变量的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，逆映射导数的对数值。
|
||||
|
|
|
|||
|
|
@ -6,8 +6,7 @@ mindspore.nn.probability.distribution.Bernoulli
|
|||
伯努利分布（Bernoulli Distribution）。
|
||||
离散随机分布，取值范围为 :math:`\{0, 1\}` ，概率质量函数为 :math:`P(X = 0) = p, P(X = 1) = 1-p`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **probs** (float, list, numpy.ndarray, Tensor) - 结果是1的概率。默认值：None。
|
||||
- **seed** (int) - 采样时使用的种子。如果为None，则使用全局种子。默认值：None。
|
||||
- **dtype** (mindspore.dtype) - 采样结果的数据类型。默认值：mstype.int32.
|
||||
|
|
@ -16,8 +15,7 @@ mindspore.nn.probability.distribution.Bernoulli
|
|||
.. note::
|
||||
`probs` 中元素必须是合适的概率（0<p<1）。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - `probs` 中元素小于0或大于1。
|
||||
|
||||
.. py:method:: probs
|
||||
|
|
@ -25,185 +23,156 @@ mindspore.nn.probability.distribution.Bernoulli
|
|||
|
||||
返回结果为1的概率。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，结果为1的概率。
|
||||
|
||||
.. py:method:: cdf(value, probs1)
|
||||
|
||||
在给定值下计算累积分布函数（Cumulatuve Distribution Function, CDF）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的值。
|
||||
|
||||
.. py:method:: cross_entropy(dist, probs1_b, probs1_a)
|
||||
|
||||
计算分布a和b之间的交叉熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **probs1_b** (Tensor) - 对比分布的伯努利实验成功的概率。
|
||||
- **probs1_a** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，交叉熵的值。
|
||||
|
||||
.. py:method:: entropy(probs1)
|
||||
|
||||
计算熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **probs1** (Tensor) - 对比分布的伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，熵的值。
|
||||
|
||||
.. py:method:: kl_loss(dist, probs1_b, probs1_a)
|
||||
|
||||
计算KL散度，即KL(a||b)。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **probs1_b** (Tensor) - 对比分布的伯努利实验成功的概率。
|
||||
- **probs1_a** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，KL散度。
|
||||
|
||||
.. py:method:: log_cdf(value, probs1)
|
||||
|
||||
计算给定值对于的累积分布函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_prob(value, probs1)
|
||||
|
||||
计算给定值对应的概率的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_survival(value, probs1)
|
||||
|
||||
计算给定值对应的生存函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的对数。
|
||||
|
||||
.. py:method:: mean(probs1)
|
||||
|
||||
计算期望。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的期望。
|
||||
|
||||
.. py:method:: mode(probs1)
|
||||
|
||||
计算众数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的众数。
|
||||
|
||||
.. py:method:: prob(value, probs1)
|
||||
|
||||
计算给定值下的概率。对于离散分布是计算概率质量函数（Probability Mass Function）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率值。
|
||||
|
||||
.. py:method:: sample(shape, probs1)
|
||||
|
||||
采样函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **shape** (tuple) - 样本的shape。
|
||||
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，根据概率分布采样的样本。
|
||||
|
||||
.. py:method:: sd(probs1)
|
||||
|
||||
计算标准差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的标准差。
|
||||
|
||||
.. py:method:: survival_function(value, probs1)
|
||||
|
||||
计算给定值对应的生存函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的值。
|
||||
|
||||
.. py:method:: var(probs1)
|
||||
|
||||
计算方差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的方差。
|
||||
|
|
|
|||
|
|
@ -11,8 +11,7 @@ mindspore.nn.probability.distribution.Beta
|
|||
|
||||
其中 :math:`B` 为 Beta 函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **concentration1** (int, float, list, numpy.ndarray, Tensor) - Beta 分布的alpha。默认值：None。
|
||||
- **concentration0** (int, float, list, numpy.ndarray, Tensor) - Beta 分布的beta。默认值：None。
|
||||
- **seed** (int) - 采样时使用的种子。如果为None，则使用全局种子。默认值：None。
|
||||
|
|
@ -23,8 +22,7 @@ mindspore.nn.probability.distribution.Beta
|
|||
- `concentration1` 和 `concentration0` 中元素必须大于零。
|
||||
- `dtype` 必须是float，因为 Beta 分布是连续的。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - `concentration1` 或者 `concentration0` 中元素小于0。
|
||||
- **TypeError** - `dtype` 不是float的子类。
|
||||
|
||||
|
|
@ -33,8 +31,7 @@ mindspore.nn.probability.distribution.Beta
|
|||
|
||||
返回concentration0（也称为 Beta 分布的 beta）。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，concentration0 的值。
|
||||
|
||||
.. py:method:: concentration1
|
||||
|
|
@ -42,201 +39,172 @@ mindspore.nn.probability.distribution.Beta
|
|||
|
||||
返回concentration1（也称为 Beta 分布的 alpha）。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，concentration1 的值。
|
||||
|
||||
.. py:method:: cdf(value, concentration1, concentration0)
|
||||
|
||||
在给定值下计算累积分布函数（Cumulatuve Distribution Function, CDF）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值：None。
|
||||
- **concentration0** (Tensor) - Beta 分布的 beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的值。
|
||||
|
||||
.. py:method:: cross_entropy(dist, concentration1_b, concentration0_b, concentration1, concentration0)
|
||||
|
||||
计算分布a和b之间的交叉熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **concentration1_b** (Tensor) - 对比 Beta 分布的 alpha。
|
||||
- **concentration0_b** (Tensor) - 对比 Beta 分布的 beta。
|
||||
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值：None。
|
||||
- **concentration0** (Tensor) - Beta 分布的 beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，交叉熵的值。
|
||||
|
||||
.. py:method:: entropy(concentration1, concentration0)
|
||||
|
||||
计算熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值：None。
|
||||
- **concentration0** (Tensor) - Beta 分布的 beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，熵的值。
|
||||
|
||||
.. py:method:: kl_loss(dist, concentration1_b, concentration0_b, concentration1, concentration0)
|
||||
|
||||
计算KL散度，即KL(a||b)。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **concentration1_b** (Tensor) - 对比 Beta 分布的 alpha。
|
||||
- **concentration0_b** (Tensor) - 对比 Beta 分布的 beta。
|
||||
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值：None。
|
||||
- **concentration0** (Tensor) - Beta 分布的 beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，KL散度。
|
||||
|
||||
.. py:method:: log_cdf(value, concentration1, concentration0)
|
||||
|
||||
计算给定值对于的累积分布函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值：None。
|
||||
- **concentration0** (Tensor) - Beta 分布的 beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_prob(value, concentration1, concentration0)
|
||||
|
||||
计算给定值对应的概率的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值：None。
|
||||
- **concentration0** (Tensor) - Beta 分布的 beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_survival(value, concentration1, concentration0)
|
||||
|
||||
计算给定值对应的生存函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值：None。
|
||||
- **concentration0** (Tensor) - Beta 分布的 beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的对数。
|
||||
|
||||
.. py:method:: mean(concentration1, concentration0)
|
||||
|
||||
计算期望。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值：None。
|
||||
- **concentration0** (Tensor) - Beta 分布的 beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的期望。
|
||||
|
||||
.. py:method:: mode(concentration1, concentration0)
|
||||
|
||||
计算众数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值：None。
|
||||
- **concentration0** (Tensor) - Beta 分布的 beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的众数。
|
||||
|
||||
.. py:method:: prob(value, concentration1, concentration0)
|
||||
|
||||
计算给定值下的概率。对于连续是计算概率密度函数（Probability Density Function）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值：None。
|
||||
- **concentration0** (Tensor) - Beta 分布的 beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率值。
|
||||
|
||||
.. py:method:: sample(shape, concentration1, concentration0)
|
||||
|
||||
采样函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **shape** (tuple) - 样本的shape。
|
||||
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值：None。
|
||||
- **concentration0** (Tensor) - Beta 分布的 beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，根据概率分布采样的样本。
|
||||
|
||||
.. py:method:: sd(concentration1, concentration0)
|
||||
|
||||
计算标准差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值：None。
|
||||
- **concentration0** (Tensor) - Beta 分布的 beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的标准差。
|
||||
|
||||
.. py:method:: survival_function(value, concentration1, concentration0)
|
||||
|
||||
计算给定值对应的生存函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值：None。
|
||||
- **concentration0** (Tensor) - Beta 分布的 beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的值。
|
||||
|
||||
.. py:method:: var(concentration1, concentration0)
|
||||
|
||||
计算方差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值：None。
|
||||
- **concentration0** (Tensor) - Beta 分布的 beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的方差。
|
||||
|
|
|
|||
|
|
@ -6,8 +6,7 @@ mindspore.nn.probability.distribution.Categorical
|
|||
分类分布。
|
||||
离散随机分布，取值范围为 :math:`\{1, 2, ..., k\}` ，概率质量函数为 :math:`P(X = i) = p_i, i = 1, ..., k`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **probs** (Tensor, list, numpy.ndarray) - 事件概率。默认值：None。
|
||||
- **seed** (int) - 采样时使用的种子。如果为None，则使用全局种子。默认值：None。
|
||||
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值：mstype.int32.
|
||||
|
|
@ -16,8 +15,7 @@ mindspore.nn.probability.distribution.Categorical
|
|||
.. note::
|
||||
`probs` 的秩必须至少为1，值是合适的概率，并且总和为1。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - `probs` 的秩为0或者其中所有元素的和不等于1。
|
||||
|
||||
.. py:method:: probs
|
||||
|
|
@ -25,185 +23,156 @@ mindspore.nn.probability.distribution.Categorical
|
|||
|
||||
返回事件发生的概率。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，事件发生的概率。
|
||||
|
||||
.. py:method:: cdf(value, probs)
|
||||
|
||||
在给定值下计算累积分布函数（Cumulatuve Distribution Function, CDF）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **probs** (Tensor) - 事件发生的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的值。
|
||||
|
||||
.. py:method:: cross_entropy(dist, probs_b, probs)
|
||||
|
||||
计算分布a和b之间的交叉熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **probs_b** (Tensor) - 对比分布的事件发生的概率。
|
||||
- **probs** (Tensor) - 事件发生的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，交叉熵的值。
|
||||
|
||||
.. py:method:: entropy(probs)
|
||||
|
||||
计算熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **probs** (Tensor) - 事件发生的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，熵的值。
|
||||
|
||||
.. py:method:: kl_loss(dist, probs_b, probs)
|
||||
|
||||
计算KL散度，即KL(a||b)。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **probs_b** (Tensor) - 对比分布的事件发生的概率。
|
||||
- **probs** (Tensor) - 事件发生的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，KL散度。
|
||||
|
||||
.. py:method:: log_cdf(value, probs)
|
||||
|
||||
计算给定值对于的累积分布函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **probs** (Tensor) - 事件发生的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_prob(value, probs)
|
||||
|
||||
计算给定值对应的概率的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **probs** (Tensor) - 事件发生的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_survival(value, probs)
|
||||
|
||||
计算给定值对应的生存函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **probs** (Tensor) - 事件发生的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的对数。
|
||||
|
||||
.. py:method:: mean(probs)
|
||||
|
||||
计算期望。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **probs** (Tensor) - 事件发生的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的期望。
|
||||
|
||||
.. py:method:: mode(probs)
|
||||
|
||||
计算众数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **probs** (Tensor) - 事件发生的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的众数。
|
||||
|
||||
.. py:method:: prob(value, probs)
|
||||
|
||||
计算给定值下的概率。对于离散分布是计算概率质量函数（Probability Mass Function）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **probs** (Tensor) - 事件发生的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率值。
|
||||
|
||||
.. py:method:: sample(shape, probs)
|
||||
|
||||
采样函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **shape** (tuple) - 样本的shape。
|
||||
- **probs** (Tensor) - 事件发生的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，根据概率分布采样的样本。
|
||||
|
||||
.. py:method:: sd(probs)
|
||||
|
||||
计算标准差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **probs** (Tensor) - 事件发生的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的标准差。
|
||||
|
||||
.. py:method:: survival_function(value, probs)
|
||||
|
||||
计算给定值对应的生存函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **probs** (Tensor) - 事件发生的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的值。
|
||||
|
||||
.. py:method:: var(probs)
|
||||
|
||||
计算方差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **probs** (Tensor) - 事件发生的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的方差。
|
||||
|
|
|
|||
|
|
@ -11,8 +11,7 @@ mindspore.nn.probability.distribution.Cauchy
|
|||
|
||||
其中 :math:`a, b` 为分别为柯西分布的位置参数和比例参数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (int, float, list, numpy.ndarray, Tensor) - 柯西分布的位置。默认值：None。
|
||||
- **scale** (int, float, list, numpy.ndarray, Tensor) - 柯西分布的比例。默认值：None。
|
||||
- **seed** (int) - 采样时使用的种子。如果为None，则使用全局种子。默认值：None。
|
||||
|
|
@ -24,8 +23,7 @@ mindspore.nn.probability.distribution.Cauchy
|
|||
- `dtype` 必须是float，因为柯西分布是连续的。
|
||||
- GPU后端不支持柯西分布。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - `scale` 中元素小于0。
|
||||
- **TypeError** - `dtype` 不是float的子类。
|
||||
|
||||
|
|
@ -34,8 +32,7 @@ mindspore.nn.probability.distribution.Cauchy
|
|||
|
||||
返回分布位置。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，分布的位置值。
|
||||
|
||||
.. py:method:: scale
|
||||
|
|
@ -43,201 +40,172 @@ mindspore.nn.probability.distribution.Cauchy
|
|||
|
||||
返回分布比例。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，分布的比例值。
|
||||
|
||||
.. py:method:: cdf(value, loc, scale)
|
||||
|
||||
在给定值下计算累积分布函数（Cumulatuve Distribution Function, CDF）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的值。
|
||||
|
||||
.. py:method:: cross_entropy(dist, loc_b, scale_b, loc, scale)
|
||||
|
||||
计算分布a和b之间的交叉熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **loc_b** (Tensor) - 对比分布位置参数。
|
||||
- **scale_b** (Tensor) - 对比分布比例参数。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，交叉熵的值。
|
||||
|
||||
.. py:method:: entropy(loc, scale)
|
||||
|
||||
计算熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，熵的值。
|
||||
|
||||
.. py:method:: kl_loss(dist, loc_b, scale_b, loc, scale)
|
||||
|
||||
计算KL散度，即KL(a||b)。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **loc_b** (Tensor) - 对比分布位置参数。
|
||||
- **scale_b** (Tensor) - 对比分布比例参数。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，KL散度。
|
||||
|
||||
.. py:method:: log_cdf(value, loc, scale)
|
||||
|
||||
计算给定值对于的累积分布函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_prob(value, loc, scale)
|
||||
|
||||
计算给定值对应的概率的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_survival(value, loc, scale)
|
||||
|
||||
计算给定值对应的生存函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的对数。
|
||||
|
||||
.. py:method:: mean(loc, scale)
|
||||
|
||||
计算期望。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的期望。
|
||||
|
||||
.. py:method:: mode(loc, scale)
|
||||
|
||||
计算众数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的众数。
|
||||
|
||||
.. py:method:: prob(value, loc, scale)
|
||||
|
||||
计算给定值下的概率。对于连续是计算概率密度函数（Probability Density Function）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率值。
|
||||
|
||||
.. py:method:: sample(shape, loc, scale)
|
||||
|
||||
采样函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **shape** (tuple) - 样本的shape。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，根据概率分布采样的样本。
|
||||
|
||||
.. py:method:: sd(loc, scale)
|
||||
|
||||
计算标准差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的标准差。
|
||||
|
||||
.. py:method:: survival_function(value, loc, scale)
|
||||
|
||||
计算给定值对应的生存函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的值。
|
||||
|
||||
.. py:method:: var(loc, scale)
|
||||
|
||||
计算方差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的方差。
|
||||
|
|
|
|||
|
|
@ -5,8 +5,7 @@ mindspore.nn.probability.distribution.Distribution
|
|||
|
||||
所有分布的基类。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **seed** (int) - 采样时使用的种子。如果为None，则使用0。
|
||||
- **dtype** (mindspore.dtype) - 事件样例的类型。
|
||||
- **name** (str) - 分布的名称。
|
||||
|
|
@ -19,8 +18,7 @@ mindspore.nn.probability.distribution.Distribution
|
|||
|
||||
在给定值下计算累积分布函数（Cumulatuve Distribution Function, CDF）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **args** (list) - 位置参数列表，具体需要的参数根据子类的实现确定。
|
||||
- **kwargs** (dict) - 关键字参数字典，具体需要的参数根据子类的实现确定。
|
||||
|
|
@ -28,8 +26,7 @@ mindspore.nn.probability.distribution.Distribution
|
|||
.. note::
|
||||
可以通过 `args` 或 `kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的值。
|
||||
|
||||
.. py:method:: construct(name, *args, **kwargs)
|
||||
|
|
@ -40,22 +37,19 @@ mindspore.nn.probability.distribution.Distribution
|
|||
支持的函数包括：'prob'、'log_prob'、'cdf', 'log_cdf'、'survival_function'、'log_survival'、'var'、
|
||||
'sd'、'mode'、'mean'、'entropy'、'kl_loss'、'cross_entropy'、'sample'、'get_dist_args'、'get_dist_type'。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **name** (str) - 函数名称。
|
||||
- **args** (list) - 函数所需的位置参数列表。
|
||||
- **kwargs** (dict) - 函数所需的关键字参数字典。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，name对应函数的值。
|
||||
|
||||
.. py:method:: cross_entropy(dist, *args, **kwargs)
|
||||
|
||||
计算分布a和b之间的交叉熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **args** (list) - 位置参数列表，具体需要的参数根据子类的实现确定。
|
||||
- **kwargs** (dict) - 关键字参数字典，具体需要的参数根据子类的实现确定。
|
||||
|
|
@ -63,56 +57,49 @@ mindspore.nn.probability.distribution.Distribution
|
|||
.. note::
|
||||
Distribution b的 `dist_spec_args` 必须通过 `args` 或 `kwargs` 传递给函数。 传入Distribution a的 `dist_spec_args` 是可选的。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，交叉熵的值。
|
||||
|
||||
.. py:method:: entropy(*args, **kwargs)
|
||||
|
||||
计算熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **args** (list) - 位置参数列表，具体需要的参数根据子类的实现确定。
|
||||
- **kwargs** (dict) - 关键字参数字典，具体需要的参数根据子类的实现确定。
|
||||
|
||||
.. note::
|
||||
可以通过 `args` 或 `kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，熵的值。
|
||||
|
||||
.. py:method:: get_dist_args(*args, **kwargs)
|
||||
|
||||
返回分布的参数列表。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **args** (list) - 位置参数列表，具体需要的参数根据子类的实现确定。
|
||||
- **kwargs** (dict) - 关键字参数字典，具体需要的参数根据子类的实现确定。
|
||||
|
||||
.. note::
|
||||
传递给字类的参数的顺序应该与通过 `_add_parameter` 初始化默认参数的顺序相同。
|
||||
|
||||
**返回：**
|
||||
|
||||
list[Tensor], 参数列表。
|
||||
返回：
|
||||
list[Tensor]，参数列表。
|
||||
|
||||
.. py:method:: get_dist_type()
|
||||
|
||||
返回分布类型。
|
||||
|
||||
**返回：**
|
||||
|
||||
string, 分布类型名字。
|
||||
返回：
|
||||
string，分布类型名字。
|
||||
|
||||
.. py:method:: kl_loss(dist, *args, **kwargs)
|
||||
|
||||
计算KL散度，即KL(a||b)。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **args** (list) - 位置参数列表，具体需要的参数根据子类的实现确定。
|
||||
- **kwargs** (dict) - 关键字参数字典，具体需要的参数根据子类的实现确定。
|
||||
|
|
@ -120,16 +107,14 @@ mindspore.nn.probability.distribution.Distribution
|
|||
.. note::
|
||||
Distribution b的 `dist_spec_args` 必须通过 `args` 或 `kwargs` 传递给函数。 传入Distribution a的 `dist_spec_args` 是可选的。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，KL散度。
|
||||
|
||||
.. py:method:: log_cdf(value, *args, **kwargs)
|
||||
|
||||
计算给定值对于的累积分布函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **args** (list) - 位置参数列表，具体需要的参数根据子类的实现确定。
|
||||
- **kwargs** (dict) - 关键字参数字典，具体需要的参数根据子类的实现确定。
|
||||
|
|
@ -137,16 +122,14 @@ mindspore.nn.probability.distribution.Distribution
|
|||
.. note::
|
||||
可以通过 `args` 或 `kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_prob(value, *args, **kwargs)
|
||||
|
||||
计算给定值对应的概率的对数（pdf或pmf）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **args** (list) - 位置参数列表，具体需要的参数根据子类的实现确定。
|
||||
- **kwargs** (dict) - 关键字参数字典，具体需要的参数根据子类的实现确定。
|
||||
|
|
@ -154,16 +137,14 @@ mindspore.nn.probability.distribution.Distribution
|
|||
.. note::
|
||||
可以通过 `args` 或 `kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_survival(value, *args, **kwargs)
|
||||
|
||||
计算给定值对应的生存函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **args** (list) - 位置参数列表，具体需要的参数根据子类的实现确定。
|
||||
- **kwargs** (dict) - 关键字参数字典，具体需要的参数根据子类的实现确定。
|
||||
|
|
@ -171,48 +152,42 @@ mindspore.nn.probability.distribution.Distribution
|
|||
.. note::
|
||||
可以通过 `args` 或 `kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的对数。
|
||||
|
||||
.. py:method:: mean(*args, **kwargs)
|
||||
|
||||
计算期望。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **args** (list) - 位置参数列表，具体需要的参数根据子类的实现确定。
|
||||
- **kwargs** (dict) - 关键字参数字典，具体需要的参数根据子类的实现确定。
|
||||
|
||||
.. note::
|
||||
可以通过 `args` 或 `kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的期望。
|
||||
|
||||
.. py:method:: mode(*args, **kwargs)
|
||||
|
||||
计算众数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **args** (list) - 位置参数列表，具体需要的参数根据子类的实现确定。
|
||||
- **kwargs** (dict) - 关键字参数字典，具体需要的参数根据子类的实现确定。
|
||||
|
||||
.. note::
|
||||
可以通过 `args` 或 `kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的众数。
|
||||
|
||||
.. py:method:: prob(value, *args, **kwargs)
|
||||
|
||||
计算给定值下的概率。对于离散分布是计算概率质量函数（Probability Mass Function），而对于连续分布是计算概率密度函数（Probability Density Function）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **args** (list) - 位置参数列表，具体需要的参数根据子类的实现确定。
|
||||
- **kwargs** (dict) - 关键字参数字典，具体需要的参数根据子类的实现确定。
|
||||
|
|
@ -220,16 +195,14 @@ mindspore.nn.probability.distribution.Distribution
|
|||
.. note::
|
||||
可以通过 `args` 或 `kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率值。
|
||||
|
||||
.. py:method:: sample(*args, **kwargs)
|
||||
|
||||
采样函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **shape** (tuple) - 样本的shape。
|
||||
- **args** (list) - 位置参数列表，具体需要的参数根据子类的实现确定。
|
||||
- **kwargs** (dict) - 关键字参数字典，具体需要的参数根据子类的实现确定。
|
||||
|
|
@ -237,32 +210,28 @@ mindspore.nn.probability.distribution.Distribution
|
|||
.. note::
|
||||
可以通过 `args` 或 `kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，根据概率分布采样的样本。
|
||||
|
||||
.. py:method:: sd(*args, **kwargs)
|
||||
|
||||
计算标准差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **args** (list) - 位置参数列表，具体需要的参数根据子类的实现确定。
|
||||
- **kwargs** (dict) - 关键字参数字典，具体需要的参数根据子类的实现确定。
|
||||
|
||||
.. note::
|
||||
可以通过 `args` 或 `kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的标准差。
|
||||
|
||||
.. py:method:: survival_function(value, *args, **kwargs)
|
||||
|
||||
计算给定值对应的生存函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **args** (list) - 位置参数列表，具体需要的参数根据子类的实现确定。
|
||||
- **kwargs** (dict) - 关键字参数字典，具体需要的参数根据子类的实现确定。
|
||||
|
|
@ -270,23 +239,20 @@ mindspore.nn.probability.distribution.Distribution
|
|||
.. note::
|
||||
可以通过 `args` 或 `kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的值。
|
||||
|
||||
.. py:method:: var(*args, **kwargs)
|
||||
|
||||
计算方差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **args** (list) - 位置参数列表，具体需要的参数根据子类的实现确定。
|
||||
- **kwargs** (dict) - 关键字参数字典，具体需要的参数根据子类的实现确定。
|
||||
|
||||
.. note::
|
||||
可以通过 `args` 或 `kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的方差。
|
||||
|
||||
|
|
|
|||
|
|
@ -11,8 +11,7 @@ mindspore.nn.probability.distribution.Exponential
|
|||
|
||||
其中 :math:`\lambda` 为分别为指数分布的率参数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **rate** (int, float, list, numpy.ndarray, Tensor) - 率参数。默认值：None。
|
||||
- **seed** (int) - 采样时使用的种子。如果为None，则使用全局种子。默认值：None。
|
||||
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值：mstype.float32。
|
||||
|
|
@ -22,8 +21,7 @@ mindspore.nn.probability.distribution.Exponential
|
|||
- `rate` 中的元素必须大于0。
|
||||
- `dtype` 必须是float，因为指数分布是连续的。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - `rate` 中元素小于0。
|
||||
- **TypeError** - `dtype` 不是float的子类。
|
||||
|
||||
|
|
@ -32,185 +30,156 @@ mindspore.nn.probability.distribution.Exponential
|
|||
|
||||
返回 `rate` 。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，率参数的值。
|
||||
|
||||
.. py:method:: cdf(value, rate)
|
||||
|
||||
在给定值下计算累积分布函数（Cumulatuve Distribution Function, CDF）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **rate** (Tensor) - 分布的率参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的值。
|
||||
|
||||
.. py:method:: cross_entropy(dist, rate_b, rate)
|
||||
|
||||
计算分布a和b之间的交叉熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **rate_b** (Tensor) - 对比分布的率参数。
|
||||
- **rate** (Tensor) - 分布的率参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，交叉熵的值。
|
||||
|
||||
.. py:method:: entropy(rate)
|
||||
|
||||
计算熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **rate** (Tensor) - 分布的率参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，熵的值。
|
||||
|
||||
.. py:method:: kl_loss(dist, rate_b, rate)
|
||||
|
||||
计算KL散度，即KL(a||b)。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **rate_b** (Tensor) - 对比分布的率参数。
|
||||
- **rate** (Tensor) - 分布的率参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，KL散度。
|
||||
|
||||
.. py:method:: log_cdf(value, rate)
|
||||
|
||||
计算给定值对于的累积分布函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **rate** (Tensor) - 分布的率参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_prob(value, rate)
|
||||
|
||||
计算给定值对应的概率的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **rate** (Tensor) - 分布的率参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_survival(value, rate)
|
||||
|
||||
计算给定值对应的生存函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **rate** (Tensor) - 分布的率参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的对数。
|
||||
|
||||
.. py:method:: mean(rate)
|
||||
|
||||
计算期望。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **rate** (Tensor) - 分布的率参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的期望。
|
||||
|
||||
.. py:method:: mode(rate)
|
||||
|
||||
计算众数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **rate** (Tensor) - 分布的率参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的众数。
|
||||
|
||||
.. py:method:: prob(value, rate)
|
||||
|
||||
计算给定值下的概率。对于连续是计算概率密度函数（Probability Density Function）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **rate** (Tensor) - 分布的率参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率值。
|
||||
|
||||
.. py:method:: sample(shape, rate)
|
||||
|
||||
采样函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **shape** (tuple) - 样本的shape。
|
||||
- **rate** (Tensor) - 分布的率参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，根据概率分布采样的样本。
|
||||
|
||||
.. py:method:: sd(rate)
|
||||
|
||||
计算标准差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **rate** (Tensor) - 分布的率参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的标准差。
|
||||
|
||||
.. py:method:: survival_function(value, rate)
|
||||
|
||||
计算给定值对应的生存函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **rate** (Tensor) - 分布的率参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的值。
|
||||
|
||||
.. py:method:: var(rate)
|
||||
|
||||
计算方差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **rate** (Tensor) - 分布的率参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的方差。
|
||||
|
|
|
|||
|
|
@ -11,8 +11,7 @@ mindspore.nn.probability.distribution.Gamma
|
|||
|
||||
其中 :math:`G` 为 Gamma 函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **concentration** (int, float, list, numpy.ndarray, Tensor) - 浓度，也被称为伽马分布的alpha。默认值：None。
|
||||
- **rate** (int, float, list, numpy.ndarray, Tensor) - 逆尺度参数，也被称为伽马分布的beta。默认值：None。
|
||||
- **seed** (int) - 采样时使用的种子。如果为None，则使用全局种子。默认值：None。
|
||||
|
|
@ -23,8 +22,7 @@ mindspore.nn.probability.distribution.Gamma
|
|||
- `concentration` 和 `rate` 中的元素必须大于零。
|
||||
- `dtype` 必须是float，因为伽马分布是连续的。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - `concentration` 或者 `rate` 中元素小于0。
|
||||
- **TypeError** - `dtype` 不是float的子类。
|
||||
|
||||
|
|
@ -33,8 +31,7 @@ mindspore.nn.probability.distribution.Gamma
|
|||
|
||||
返回分布的浓度（也称为伽马分布的alpha）。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，concentration 的值。
|
||||
|
||||
.. py:method:: rate
|
||||
|
|
@ -42,201 +39,172 @@ mindspore.nn.probability.distribution.Gamma
|
|||
|
||||
返回分布的逆尺度（也称为伽马分布的beta）。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，rate 的值。
|
||||
|
||||
.. py:method:: cdf(value, concentration, rate)
|
||||
|
||||
在给定值下计算累积分布函数（Cumulatuve Distribution Function, CDF）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **concentration** (Tensor) - 分布的alpha。默认值：None。
|
||||
- **rate** (Tensor) - 分布的beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的值。
|
||||
|
||||
.. py:method:: cross_entropy(dist, concentration_b, rate_b, concentration, rate)
|
||||
|
||||
计算分布a和b之间的交叉熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **concentration_b** (Tensor) - 对比分布的alpha。
|
||||
- **rate_b** (Tensor) - 对比分布的beta。
|
||||
- **concentration** (Tensor) - 分布的alpha。默认值：None。
|
||||
- **rate** (Tensor) - 分布的beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，交叉熵的值。
|
||||
|
||||
.. py:method:: entropy(concentration, rate)
|
||||
|
||||
计算熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **concentration** (Tensor) - 分布的alpha。默认值：None。
|
||||
- **rate** (Tensor) - 分布的beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，熵的值。
|
||||
|
||||
.. py:method:: kl_loss(dist, concentration_b, rate_b, concentration, rate)
|
||||
|
||||
计算KL散度，即KL(a||b)。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **concentration_b** (Tensor) - 对比分布的alpha。
|
||||
- **rate_b** (Tensor) - 对比分布的beta。
|
||||
- **concentration** (Tensor) - 分布的alpha。默认值：None。
|
||||
- **rate** (Tensor) - 分布的beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，KL散度。
|
||||
|
||||
.. py:method:: log_cdf(value, concentration, rate)
|
||||
|
||||
计算给定值对于的累积分布函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **concentration** (Tensor) - 分布的alpha。默认值：None。
|
||||
- **rate** (Tensor) - 分布的beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_prob(value, concentration, rate)
|
||||
|
||||
计算给定值对应的概率的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **concentration** (Tensor) - 分布的alpha。默认值：None。
|
||||
- **rate** (Tensor) - 分布的beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_survival(value, concentration, rate)
|
||||
|
||||
计算给定值对应的生存函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **concentration** (Tensor) - 分布的alpha。默认值：None。
|
||||
- **rate** (Tensor) - 分布的beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的对数。
|
||||
|
||||
.. py:method:: mean(concentration, rate)
|
||||
|
||||
计算期望。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **concentration** (Tensor) - 分布的alpha。默认值：None。
|
||||
- **rate** (Tensor) - 分布的beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的期望。
|
||||
|
||||
.. py:method:: mode(concentration, rate)
|
||||
|
||||
计算众数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **concentration** (Tensor) - 分布的alpha。默认值：None。
|
||||
- **rate** (Tensor) - 分布的beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的众数。
|
||||
|
||||
.. py:method:: prob(value, concentration, rate)
|
||||
|
||||
计算给定值下的概率。对于连续是计算概率密度函数（Probability Density Function）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **concentration** (Tensor) - 分布的alpha。默认值：None。
|
||||
- **rate** (Tensor) - 分布的beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率值。
|
||||
|
||||
.. py:method:: sample(shape, concentration, rate)
|
||||
|
||||
采样函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **shape** (tuple) - 样本的shape。
|
||||
- **concentration** (Tensor) - 分布的alpha。默认值：None。
|
||||
- **rate** (Tensor) - 分布的beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，根据概率分布采样的样本。
|
||||
|
||||
.. py:method:: sd(concentration, rate)
|
||||
|
||||
计算标准差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **concentration** (Tensor) - 分布的alpha。默认值：None。
|
||||
- **rate** (Tensor) - 分布的beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的标准差。
|
||||
|
||||
.. py:method:: survival_function(value, concentration, rate)
|
||||
|
||||
计算给定值对应的生存函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **concentration** (Tensor) - 分布的alpha。默认值：None。
|
||||
- **rate** (Tensor) - 分布的beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的值。
|
||||
|
||||
.. py:method:: var(concentration, rate)
|
||||
|
||||
计算方差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **concentration** (Tensor) - 分布的alpha。默认值：None。
|
||||
- **rate** (Tensor) - 分布的beta。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的方差。
|
||||
|
|
|
|||
|
|
@ -8,8 +8,7 @@ mindspore.nn.probability.distribution.Geometric
|
|||
它代表在第一次成功之前有k次失败，即在第一次成功实现时，总共有k+1个伯努利试验。
|
||||
离散随机分布，取值范围为正自然数集，概率质量函数为 :math:`P(X = i) = p(1-p)^{i-1}, i = 1, 2, ...`。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **probs** (int, float, list, numpy.ndarray, Tensor) - 成功的概率。默认值：None。
|
||||
- **seed** (int) - 采样时使用的种子。如果为None，则使用全局种子。默认值：None。
|
||||
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值：mstype.int32.
|
||||
|
|
@ -19,8 +18,7 @@ mindspore.nn.probability.distribution.Geometric
|
|||
`probs` 必须是合适的概率（0<p<1）。
|
||||
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - `probs` 中元素小于0或者大于1。
|
||||
|
||||
.. py:method:: probs
|
||||
|
|
@ -28,185 +26,156 @@ mindspore.nn.probability.distribution.Geometric
|
|||
|
||||
返回伯努利试验成功的概率。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，伯努利试验成功的概率值。
|
||||
|
||||
.. py:method:: cdf(value, probs)
|
||||
|
||||
在给定值下计算累积分布函数（Cumulatuve Distribution Function, CDF）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **probs** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的值。
|
||||
|
||||
.. py:method:: cross_entropy(dist, probs_b, probs)
|
||||
|
||||
计算分布a和b之间的交叉熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **probs_b** (Tensor) - 对比分布的伯努利实验成功的概率。
|
||||
- **probs** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，交叉熵的值。
|
||||
|
||||
.. py:method:: entropy(probs)
|
||||
|
||||
计算熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **probs** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，熵的值。
|
||||
|
||||
.. py:method:: kl_loss(dist, probs_b, probs)
|
||||
|
||||
计算KL散度，即KL(a||b)。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **probs_b** (Tensor) - 对比分布的伯努利实验成功的概率。
|
||||
- **probs** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，KL散度。
|
||||
|
||||
.. py:method:: log_cdf(value, probs)
|
||||
|
||||
计算给定值对于的累积分布函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **probs** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_prob(value, probs)
|
||||
|
||||
计算给定值对应的概率的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **probs** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_survival(value, probs)
|
||||
|
||||
计算给定值对应的生存函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **probs** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的对数。
|
||||
|
||||
.. py:method:: mean(probs)
|
||||
|
||||
计算期望。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **probs** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的期望。
|
||||
|
||||
.. py:method:: mode(probs)
|
||||
|
||||
计算众数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **probs** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的众数。
|
||||
|
||||
.. py:method:: prob(value, probs)
|
||||
|
||||
计算给定值下的概率。对于离散分布是计算概率质量函数（Probability Mass Function）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **probs** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率值。
|
||||
|
||||
.. py:method:: sample(shape, probs)
|
||||
|
||||
采样函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **shape** (tuple) - 样本的shape。
|
||||
- **probs** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，根据概率分布采样的样本。
|
||||
|
||||
.. py:method:: sd(probs)
|
||||
|
||||
计算标准差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **probs** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的标准差。
|
||||
|
||||
.. py:method:: survival_function(value, probs)
|
||||
|
||||
计算给定值对应的生存函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **probs** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的值。
|
||||
|
||||
.. py:method:: var(probs)
|
||||
|
||||
计算方差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **probs** (Tensor) - 伯努利实验成功的概率。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的方差。
|
||||
|
|
|
|||
|
|
@ -11,8 +11,7 @@ mindspore.nn.probability.distribution.Gumbel
|
|||
|
||||
其中 :math:`a, b` 为分别为Gumbel分布的位置参数和比例参数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (int, float, list, numpy.ndarray, Tensor) - Gumbel分布的位置。
|
||||
- **scale** (int, float, list, numpy.ndarray, Tensor) - Gumbel分布的尺度。
|
||||
- **seed** (int) - 采样时使用的种子。如果为None，则使用全局种子。默认值：0。
|
||||
|
|
@ -24,8 +23,7 @@ mindspore.nn.probability.distribution.Gumbel
|
|||
- `dtype` 必须是浮点类型，因为Gumbel分布是连续的。
|
||||
- GPU后端不支持 `kl_loss` 和 `cross_entropy` 。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - `scale` 中元素小于0。
|
||||
- **TypeError** - `dtype` 不是float的子类。
|
||||
|
||||
|
|
@ -34,8 +32,7 @@ mindspore.nn.probability.distribution.Gumbel
|
|||
|
||||
返回分布位置。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，分布的位置值。
|
||||
|
||||
.. py:method:: scale
|
||||
|
|
@ -43,201 +40,172 @@ mindspore.nn.probability.distribution.Gumbel
|
|||
|
||||
返回分布比例。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，分布的比例值。
|
||||
|
||||
.. py:method:: cdf(value, loc, scale)
|
||||
|
||||
在给定值下计算累积分布函数（Cumulatuve Distribution Function, CDF）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的值。
|
||||
|
||||
.. py:method:: cross_entropy(dist, loc_b, scale_b, loc, scale)
|
||||
|
||||
计算分布a和b之间的交叉熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **loc_b** (Tensor) - 对比分布位置参数。
|
||||
- **scale_b** (Tensor) - 对比分布比例参数。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，交叉熵的值。
|
||||
|
||||
.. py:method:: entropy(loc, scale)
|
||||
|
||||
计算熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，熵的值。
|
||||
|
||||
.. py:method:: kl_loss(dist, loc_b, scale_b, loc, scale)
|
||||
|
||||
计算KL散度，即KL(a||b)。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **loc_b** (Tensor) - 对比分布位置参数。
|
||||
- **scale_b** (Tensor) - 对比分布比例参数。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，KL散度。
|
||||
|
||||
.. py:method:: log_cdf(value, loc, scale)
|
||||
|
||||
计算给定值对于的累积分布函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_prob(value, loc, scale)
|
||||
|
||||
计算给定值对应的概率的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_survival(value, loc, scale)
|
||||
|
||||
计算给定值对应的生存函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的对数。
|
||||
|
||||
.. py:method:: mean(loc, scale)
|
||||
|
||||
计算期望。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的期望。
|
||||
|
||||
.. py:method:: mode(loc, scale)
|
||||
|
||||
计算众数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的众数。
|
||||
|
||||
.. py:method:: prob(value, loc, scale)
|
||||
|
||||
计算给定值下的概率。对于连续是计算概率密度函数（Probability Density Function）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率值。
|
||||
|
||||
.. py:method:: sample(shape, loc, scale)
|
||||
|
||||
采样函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **shape** (tuple) - 样本的shape。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，根据概率分布采样的样本。
|
||||
|
||||
.. py:method:: sd(loc, scale)
|
||||
|
||||
计算标准差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的标准差。
|
||||
|
||||
.. py:method:: survival_function(value, loc, scale)
|
||||
|
||||
计算给定值对应的生存函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的值。
|
||||
|
||||
.. py:method:: var(loc, scale)
|
||||
|
||||
计算方差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的方差。
|
||||
|
|
|
|||
|
|
@ -12,8 +12,7 @@ mindspore.nn.probability.distribution.LogNormal
|
|||
其中 :math:`a, b` 为分别为基础正态分布的平均值和标准差。
|
||||
服从对数正态分布的随机变量的对数服从正态分布。它被构造为正态分布的指数变换。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (int, float, list, numpy.ndarray, Tensor) - 基础正态分布的平均值。默认值：None。
|
||||
- **scale** (int, float, list, numpy.ndarray, Tensor) - 基础正态分布的标准差。默认值：None。
|
||||
- **seed** (int) - 采样时使用的种子。如果为None，则使用全局种子。默认值：0。
|
||||
|
|
@ -24,8 +23,7 @@ mindspore.nn.probability.distribution.LogNormal
|
|||
- `scale` 必须大于零。
|
||||
- `dtype` 必须是float，因为对数正态分布是连续的。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - `scale` 中元素小于0。
|
||||
- **TypeError** - `dtype` 不是float的子类。
|
||||
|
||||
|
|
@ -34,8 +32,7 @@ mindspore.nn.probability.distribution.LogNormal
|
|||
|
||||
返回分布位置。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，分布的位置值。
|
||||
|
||||
.. py:method:: scale
|
||||
|
|
@ -43,201 +40,172 @@ mindspore.nn.probability.distribution.LogNormal
|
|||
|
||||
返回分布比例。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，分布的比例值。
|
||||
|
||||
.. py:method:: cdf(value, loc, scale)
|
||||
|
||||
在给定值下计算累积分布函数（Cumulatuve Distribution Function, CDF）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的值。
|
||||
|
||||
.. py:method:: cross_entropy(dist, loc_b, scale_b, loc, scale)
|
||||
|
||||
计算分布a和b之间的交叉熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **loc_b** (Tensor) - 对比分布位置参数。
|
||||
- **scale_b** (Tensor) - 对比分布比例参数。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，交叉熵的值。
|
||||
|
||||
.. py:method:: entropy(loc, scale)
|
||||
|
||||
计算熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，熵的值。
|
||||
|
||||
.. py:method:: kl_loss(dist, loc_b, scale_b, loc, scale)
|
||||
|
||||
计算KL散度，即KL(a||b)。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **loc_b** (Tensor) - 对比分布位置参数。
|
||||
- **scale_b** (Tensor) - 对比分布比例参数。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，KL散度。
|
||||
|
||||
.. py:method:: log_cdf(value, loc, scale)
|
||||
|
||||
计算给定值对于的累积分布函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_prob(value, loc, scale)
|
||||
|
||||
计算给定值对应的概率的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_survival(value, loc, scale)
|
||||
|
||||
计算给定值对应的生存函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的对数。
|
||||
|
||||
.. py:method:: mean(loc, scale)
|
||||
|
||||
计算期望。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的期望。
|
||||
|
||||
.. py:method:: mode(loc, scale)
|
||||
|
||||
计算众数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的众数。
|
||||
|
||||
.. py:method:: prob(value, loc, scale)
|
||||
|
||||
计算给定值下的概率。对于连续是计算概率密度函数（Probability Density Function）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率值。
|
||||
|
||||
.. py:method:: sample(shape, loc, scale)
|
||||
|
||||
采样函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **shape** (tuple) - 样本的shape。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，根据概率分布采样的样本。
|
||||
|
||||
.. py:method:: sd(loc, scale)
|
||||
|
||||
计算标准差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的标准差。
|
||||
|
||||
.. py:method:: survival_function(value, loc, scale)
|
||||
|
||||
计算给定值对应的生存函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的值。
|
||||
|
||||
.. py:method:: var(loc, scale)
|
||||
|
||||
计算方差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的方差。
|
||||
|
|
|
|||
|
|
@ -11,8 +11,7 @@ mindspore.nn.probability.distribution.Logistic
|
|||
|
||||
其中 :math:`a, b` 为分别为Logistic分布的位置参数和比例参数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (int, float, list, numpy.ndarray, Tensor) - Logistic分布的位置。默认值：None。
|
||||
- **scale** (int, float, list, numpy.ndarray, Tensor) - Logistic分布的尺度。默认值：None。
|
||||
- **seed** (int) - 采样时使用的种子。如果为None，则使用全局种子。默认值：None。
|
||||
|
|
@ -23,8 +22,7 @@ mindspore.nn.probability.distribution.Logistic
|
|||
- `scale` 必须大于零。
|
||||
- `dtype` 必须是float，因为Logistic分布是连续的。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - `scale` 中元素小于0。
|
||||
- **TypeError** - `dtype` 不是float的子类。
|
||||
|
||||
|
|
@ -33,8 +31,7 @@ mindspore.nn.probability.distribution.Logistic
|
|||
|
||||
返回分布位置。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，分布的位置值。
|
||||
|
||||
.. py:method:: scale
|
||||
|
|
@ -42,201 +39,172 @@ mindspore.nn.probability.distribution.Logistic
|
|||
|
||||
返回分布比例。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，分布的比例值。
|
||||
|
||||
.. py:method:: cdf(value, loc, scale)
|
||||
|
||||
在给定值下计算累积分布函数（Cumulatuve Distribution Function, CDF）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的值。
|
||||
|
||||
.. py:method:: cross_entropy(dist, loc_b, scale_b, loc, scale)
|
||||
|
||||
计算分布a和b之间的交叉熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **loc_b** (Tensor) - 对比分布位置参数。
|
||||
- **scale_b** (Tensor) - 对比分布比例参数。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，交叉熵的值。
|
||||
|
||||
.. py:method:: entropy(loc, scale)
|
||||
|
||||
计算熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，熵的值。
|
||||
|
||||
.. py:method:: kl_loss(dist, loc_b, scale_b, loc, scale)
|
||||
|
||||
计算KL散度，即KL(a||b)。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **loc_b** (Tensor) - 对比分布位置参数。
|
||||
- **scale_b** (Tensor) - 对比分布比例参数。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，KL散度。
|
||||
|
||||
.. py:method:: log_cdf(value, loc, scale)
|
||||
|
||||
计算给定值对于的累积分布函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_prob(value, loc, scale)
|
||||
|
||||
计算给定值对应的概率的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_survival(value, loc, scale)
|
||||
|
||||
计算给定值对应的生存函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的对数。
|
||||
|
||||
.. py:method:: mean(loc, scale)
|
||||
|
||||
计算期望。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的期望。
|
||||
|
||||
.. py:method:: mode(loc, scale)
|
||||
|
||||
计算众数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的众数。
|
||||
|
||||
.. py:method:: prob(value, loc, scale)
|
||||
|
||||
计算给定值下的概率。对于连续是计算概率密度函数（Probability Density Function）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率值。
|
||||
|
||||
.. py:method:: sample(shape, loc, scale)
|
||||
|
||||
采样函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **shape** (tuple) - 样本的shape。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，根据概率分布采样的样本。
|
||||
|
||||
.. py:method:: sd(loc, scale)
|
||||
|
||||
计算标准差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的标准差。
|
||||
|
||||
.. py:method:: survival_function(value, loc, scale)
|
||||
|
||||
计算给定值对应的生存函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的值。
|
||||
|
||||
.. py:method:: var(loc, scale)
|
||||
|
||||
计算方差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **loc** (Tensor) - 分布位置参数。默认值：None。
|
||||
- **scale** (Tensor) - 分布比例参数。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的方差。
|
||||
|
|
|
|||
|
|
@ -11,8 +11,7 @@ mindspore.nn.probability.distribution.Normal
|
|||
|
||||
其中 :math:`\mu, \sigma` 为分别为正态分布的期望与标准差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **mean** (int, float, list, numpy.ndarray, Tensor) - 正态分布的平均值。默认值：None。
|
||||
- **sd** (int, float, list, numpy.ndarray, Tensor) - 正态分布的标准差。默认值：None。
|
||||
- **seed** (int) - 采样时使用的种子。如果为None，则使用全局种子。默认值：None。
|
||||
|
|
@ -23,8 +22,7 @@ mindspore.nn.probability.distribution.Normal
|
|||
- `sd` 必须大于零。
|
||||
- `dtype` 必须是float，因为正态分布是连续的。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - `sd` 中元素小于0。
|
||||
- **TypeError** - `dtype` 不是float的子类。
|
||||
|
||||
|
|
@ -33,8 +31,7 @@ mindspore.nn.probability.distribution.Normal
|
|||
|
||||
返回分布期望。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，分布的期望。
|
||||
|
||||
.. py:method:: sd
|
||||
|
|
@ -42,175 +39,150 @@ mindspore.nn.probability.distribution.Normal
|
|||
|
||||
返回分布的标准差。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，分布的标准差。
|
||||
|
||||
.. py:method:: cdf(value, mean, sd)
|
||||
|
||||
在给定值下计算累积分布函数（Cumulatuve Distribution Function, CDF）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **mean** (Tensor) - 分布的期望。默认值：None。
|
||||
- **sd** (Tensor) - 分布的标准差。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的值。
|
||||
|
||||
.. py:method:: cross_entropy(dist, mean_b, sd_b, mean, sd)
|
||||
|
||||
计算分布a和b之间的交叉熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **mean_b** (Tensor) - 对比分布的期望。
|
||||
- **sd_b** (Tensor) - 对比分布的标准差。
|
||||
- **mean** (Tensor) - 分布的期望。默认值：None。
|
||||
- **sd** (Tensor) - 分布的标准差。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，交叉熵的值。
|
||||
|
||||
.. py:method:: entropy(mean, sd)
|
||||
|
||||
计算熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **mean** (Tensor) - 分布的期望。默认值：None。
|
||||
- **sd** (Tensor) - 分布的标准差。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，熵的值。
|
||||
|
||||
.. py:method:: kl_loss(dist, mean_b, sd_b, mean, sd)
|
||||
|
||||
计算KL散度，即KL(a||b)。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **mean_b** (Tensor) - 对比分布的期望。
|
||||
- **sd_b** (Tensor) - 对比分布的标准差。
|
||||
- **mean** (Tensor) - 分布的期望。默认值：None。
|
||||
- **sd** (Tensor) - 分布的标准差。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，KL散度。
|
||||
|
||||
.. py:method:: log_cdf(value, mean, sd)
|
||||
|
||||
计算给定值对于的累积分布函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **mean** (Tensor) - 分布的期望。默认值：None。
|
||||
- **sd** (Tensor) - 分布的标准差。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_prob(value, mean, sd)
|
||||
|
||||
计算给定值对应的概率的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **mean** (Tensor) - 分布的期望。默认值：None。
|
||||
- **sd** (Tensor) - 分布的标准差。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_survival(value, mean, sd)
|
||||
|
||||
计算给定值对应的生存函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **mean** (Tensor) - 分布的期望。默认值：None。
|
||||
- **sd** (Tensor) - 分布的标准差。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的对数。
|
||||
|
||||
.. py:method:: mode(mean, sd)
|
||||
|
||||
计算众数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **mean** (Tensor) - 分布的期望。默认值：None。
|
||||
- **sd** (Tensor) - 分布的标准差。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的众数。
|
||||
|
||||
.. py:method:: prob(value, mean, sd)
|
||||
|
||||
计算给定值下的概率。对于连续是计算概率密度函数（Probability Density Function）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **mean** (Tensor) - 分布的期望。默认值：None。
|
||||
- **sd** (Tensor) - 分布的标准差。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率值。
|
||||
|
||||
.. py:method:: sample(shape, mean, sd)
|
||||
|
||||
采样函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **shape** (tuple) - 样本的shape。
|
||||
- **mean** (Tensor) - 分布的期望。默认值：None。
|
||||
- **sd** (Tensor) - 分布的标准差。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，根据概率分布采样的样本。
|
||||
|
||||
.. py:method:: survival_function(value, mean, sd)
|
||||
|
||||
计算给定值对应的生存函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **mean** (Tensor) - 分布的期望。默认值：None。
|
||||
- **sd** (Tensor) - 分布的标准差。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的值。
|
||||
|
||||
.. py:method:: var(mean, sd)
|
||||
|
||||
计算方差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **mean** (Tensor) - 分布的期望。默认值：None。
|
||||
- **sd** (Tensor) - 分布的标准差。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的方差。
|
||||
|
|
|
|||
|
|
@ -11,8 +11,7 @@ mindspore.nn.probability.distribution.Poisson
|
|||
|
||||
其中 :math:`\lambda` 为率参数（rate)。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **rate** (int, float, list, numpy.ndarray, Tensor) - 泊松分布的率参数。默认值：None。
|
||||
- **seed** (int) - 采样时使用的种子。如果为None，则使用全局种子。默认值：None。
|
||||
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值：mstype.float32。
|
||||
|
|
@ -21,9 +20,7 @@ mindspore.nn.probability.distribution.Poisson
|
|||
.. note::
|
||||
`rate` 必须大于0。
|
||||
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - `rate` 中元素小于0。
|
||||
|
||||
.. py:method:: rate
|
||||
|
|
@ -31,145 +28,122 @@ mindspore.nn.probability.distribution.Poisson
|
|||
|
||||
返回分布的 `rate` 参数。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，rate 参数的值。
|
||||
|
||||
.. py:method:: cdf(value, rate)
|
||||
|
||||
在给定值下计算累积分布函数（Cumulatuve Distribution Function, CDF）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **rate** (Tensor) - 率参数(rate)。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的值。
|
||||
|
||||
.. py:method:: log_cdf(value, rate)
|
||||
|
||||
计算给定值对于的累积分布函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **rate** (Tensor) - 率参数(rate)。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_prob(value, rate)
|
||||
|
||||
计算给定值对应的概率的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **rate** (Tensor) - 率参数(rate)。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_survival(value, rate)
|
||||
|
||||
计算给定值对应的生存函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **rate** (Tensor) - 率参数(rate)。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的对数。
|
||||
|
||||
.. py:method:: mean(rate)
|
||||
|
||||
计算期望。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **rate** (Tensor) - 率参数(rate)。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的期望。
|
||||
|
||||
.. py:method:: mode(rate)
|
||||
|
||||
计算众数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **rate** (Tensor) - 率参数(rate)。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的众数。
|
||||
|
||||
.. py:method:: prob(value, rate)
|
||||
|
||||
计算给定值下的概率。对于离散分布是计算概率质量函数（Probability Mass Function）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **rate** (Tensor) - 率参数(rate)。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率值。
|
||||
|
||||
.. py:method:: sample(shape, rate)
|
||||
|
||||
采样函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **shape** (tuple) - 样本的shape。
|
||||
- **rate** (Tensor) - 率参数(rate)。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，根据概率分布采样的样本。
|
||||
|
||||
.. py:method:: sd(rate)
|
||||
|
||||
计算标准差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **rate** (Tensor) - 率参数(rate)。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的标准差。
|
||||
|
||||
.. py:method:: survival_function(value, rate)
|
||||
|
||||
计算给定值对应的生存函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **rate** (Tensor) - 率参数(rate)。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的值。
|
||||
|
||||
.. py:method:: var(rate)
|
||||
|
||||
计算方差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **rate** (Tensor) - 率参数(rate)。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的方差。
|
||||
|
|
|
|||
|
|
@ -7,8 +7,7 @@ mindspore.nn.probability.distribution.TransformedDistribution
|
|||
该类包含一个Bijector和一个分布，并通过Bijector定义的操作将原始分布转换为新分布。可如果原始分布为 :math:`X` ，Bijector的映射函数为 :math:`g`， 那么对应的转换分布为 :math:`Y = g(X)` 。
|
||||
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **bijector** (Bijector) - 要执行的转换。
|
||||
- **distribution** (Distribution) - 原始分布。必须具有float数据类型。
|
||||
- **seed** (int) - 采样时使用的种子。如果为None，则使用全局种子。默认值：None。如果在初始化TransformedDistribution对象时给出了此种子，则对象的采样函数将使用此种子；否则，将使用基础分布的种子。
|
||||
|
|
@ -17,8 +16,7 @@ mindspore.nn.probability.distribution.TransformedDistribution
|
|||
.. note::
|
||||
用于初始化原始分布的参数不能为None。例如，由于未指定 `mean` 和 `sd` ，因此无法使用mynormal = msd.Normal(dtype=mindspore.float32)初始化TransformedDistribution。
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **TypeError** - bijector不是Bijector类。
|
||||
- **TypeError** - distribution不是Distribution类。
|
||||
|
||||
|
|
@ -27,125 +25,106 @@ mindspore.nn.probability.distribution.TransformedDistribution
|
|||
|
||||
返回概率映射函数。
|
||||
|
||||
**返回：**
|
||||
|
||||
Bijector, 概率映射函数。
|
||||
返回：
|
||||
Bijector，概率映射函数。
|
||||
|
||||
.. py:method:: distribution
|
||||
:property:
|
||||
|
||||
返回变化前的概率分布。
|
||||
|
||||
**返回：**
|
||||
|
||||
Distribution, 变化前的概率分布。
|
||||
返回：
|
||||
Distribution，变化前的概率分布。
|
||||
|
||||
.. py:method:: dtype
|
||||
:property:
|
||||
|
||||
返回分布的数据类型。
|
||||
|
||||
**返回：**
|
||||
|
||||
mindspore.dtype, 分布的数据类型。
|
||||
返回：
|
||||
mindspore.dtype，分布的数据类型。
|
||||
|
||||
.. py:method:: is_linear_transformation
|
||||
:property:
|
||||
|
||||
返回概率映射函数是否为线性映射。
|
||||
|
||||
**返回：**
|
||||
|
||||
Bool, 概率映射函数为线性映射则返回True，否则返回False。
|
||||
返回：
|
||||
Bool，概率映射函数为线性映射则返回True，否则返回False。
|
||||
|
||||
.. py:method:: cdf(value)
|
||||
|
||||
在给定值下计算累积分布函数（Cumulatuve Distribution Function, CDF）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的值。
|
||||
|
||||
.. py:method:: log_cdf(value)
|
||||
|
||||
计算给定值对于的累积分布函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_prob(value)
|
||||
|
||||
计算给定值对应的概率的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_survival(value)
|
||||
|
||||
计算给定值对应的生存函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的对数。
|
||||
|
||||
.. py:method:: mean
|
||||
|
||||
计算期望。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的期望。
|
||||
|
||||
.. py:method:: prob(value)
|
||||
|
||||
计算给定值下的概率。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率值。
|
||||
|
||||
.. py:method:: sample(shape)
|
||||
|
||||
采样函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **shape** (tuple) - 样本的shape。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，根据概率分布采样的样本。
|
||||
|
||||
.. py:method:: survival_function(value)
|
||||
|
||||
计算给定值对应的生存函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的值。
|
||||
|
|
|
|||
|
|
@ -11,8 +11,7 @@ mindspore.nn.probability.distribution.Uniform
|
|||
|
||||
其中 :math:`a, b` 为分别为均匀分布的下界和上界。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **low** (int, float, list, numpy.ndarray, Tensor) - 分布的下限。默认值：None。
|
||||
- **high** (int, float, list, numpy.ndarray, Tensor) - 分布的上限。默认值：None。
|
||||
- **seed** (int) - 采样时使用的种子。如果为None，则使用全局种子。默认值：None。
|
||||
|
|
@ -24,8 +23,7 @@ mindspore.nn.probability.distribution.Uniform
|
|||
- `dtype` 必须是float类型，因为均匀分布是连续的。
|
||||
|
||||
|
||||
**异常：**
|
||||
|
||||
异常：
|
||||
- **ValueError** - `low` 大于等于 `high` 。
|
||||
- **TypeError** - `dtype` 不是float的子类。
|
||||
|
||||
|
|
@ -34,8 +32,7 @@ mindspore.nn.probability.distribution.Uniform
|
|||
|
||||
返回分布的上限。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，分布的上限值。
|
||||
|
||||
.. py:method:: low
|
||||
|
|
@ -43,201 +40,172 @@ mindspore.nn.probability.distribution.Uniform
|
|||
|
||||
返回分布的下限。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，分布的下限值。
|
||||
|
||||
.. py:method:: cdf(value, high, low)
|
||||
|
||||
在给定值下计算累积分布函数（Cumulatuve Distribution Function, CDF）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **high** (Tensor) - 分布的上限值。默认值：None。
|
||||
- **low** (Tensor) - 分布的下限值。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的值。
|
||||
|
||||
.. py:method:: cross_entropy(dist, high_b, low_b, high, low)
|
||||
|
||||
计算分布a和b之间的交叉熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **high_b** (Tensor) - 对比分布的上限值。
|
||||
- **low_b** (Tensor) - 对比分布的下限值。
|
||||
- **high** (Tensor) - 分布的上限值。默认值：None。
|
||||
- **low** (Tensor) - 分布的下限值。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，交叉熵的值。
|
||||
|
||||
.. py:method:: entropy(high, low)
|
||||
|
||||
计算熵。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **high** (Tensor) - 分布的上限值。默认值：None。
|
||||
- **low** (Tensor) - 分布的下限值。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，熵的值。
|
||||
|
||||
.. py:method:: kl_loss(dist, high_b, low_b, high, low)
|
||||
|
||||
计算KL散度，即KL(a||b)。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **dist** (str) - 分布的类型。
|
||||
- **high_b** (Tensor) - 对比分布的上限值。
|
||||
- **low_b** (Tensor) - 对比分布的下限值。
|
||||
- **high** (Tensor) - 分布的上限值。默认值：None。
|
||||
- **low** (Tensor) - 分布的下限值。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，KL散度。
|
||||
|
||||
.. py:method:: log_cdf(value, high, low)
|
||||
|
||||
计算给定值对于的累积分布函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **high** (Tensor) - 分布的上限值。默认值：None。
|
||||
- **low** (Tensor) - 分布的下限值。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_prob(value, high, low)
|
||||
|
||||
计算给定值对应的概率的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **high** (Tensor) - 分布的上限值。默认值：None。
|
||||
- **low** (Tensor) - 分布的下限值。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，累积分布函数的对数。
|
||||
|
||||
.. py:method:: log_survival(value, high, low)
|
||||
|
||||
计算给定值对应的生存函数的对数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **high** (Tensor) - 分布的上限值。默认值：None。
|
||||
- **low** (Tensor) - 分布的下限值。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的对数。
|
||||
|
||||
.. py:method:: mean(high, low)
|
||||
|
||||
计算期望。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **high** (Tensor) - 分布的上限值。默认值：None。
|
||||
- **low** (Tensor) - 分布的下限值。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的期望。
|
||||
|
||||
.. py:method:: mode(high, low)
|
||||
|
||||
计算众数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **high** (Tensor) - 分布的上限值。默认值：None。
|
||||
- **low** (Tensor) - 分布的下限值。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的众数。
|
||||
|
||||
.. py:method:: prob(value, high, low)
|
||||
|
||||
计算给定值下的概率。对于连续是计算概率密度函数（Probability Density Function）。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **high** (Tensor) - 分布的上限值。默认值：None。
|
||||
- **low** (Tensor) - 分布的下限值。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率值。
|
||||
|
||||
.. py:method:: sample(shape, high, low)
|
||||
|
||||
采样函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **shape** (tuple) - 样本的shape。
|
||||
- **high** (Tensor) - 分布的上限值。默认值：None。
|
||||
- **low** (Tensor) - 分布的下限值。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，根据概率分布采样的样本。
|
||||
|
||||
.. py:method:: sd(high, low)
|
||||
|
||||
计算标准差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **high** (Tensor) - 分布的上限值。默认值：None。
|
||||
- **low** (Tensor) - 分布的下限值。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的标准差。
|
||||
|
||||
.. py:method:: survival_function(value, high, low)
|
||||
|
||||
计算给定值对应的生存函数。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **value** (Tensor) - 要计算的值。
|
||||
- **high** (Tensor) - 分布的上限值。默认值：None。
|
||||
- **low** (Tensor) - 分布的下限值。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，生存函数的值。
|
||||
|
||||
.. py:method:: var(high, low)
|
||||
|
||||
计算方差。
|
||||
|
||||
**参数：**
|
||||
|
||||
参数：
|
||||
- **high** (Tensor) - 分布的上限值。默认值：None。
|
||||
- **low** (Tensor) - 分布的下限值。默认值：None。
|
||||
|
||||
**返回：**
|
||||
|
||||
返回：
|
||||
Tensor，概率分布的方差。
|
||||
|
|
|
|||
Loading…
Reference in New Issue