!37910 modify the Chinese API files

Merge pull request !37910 from 宦晓玲/code_docs_0712
This commit is contained in:
i-robot 2022-07-13 06:07:21 +00:00 committed by Gitee
commit 331de15f22
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
34 changed files with 1731 additions and 2366 deletions

View File

@ -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。

View File

@ -5,29 +5,29 @@
在训练过程中管理联邦学习。
**参数:**
参数:
- **model** (nn.Cell) - 一个用于联邦训练的模型。
- **sync_frequency** (int) - 联邦学习中的参数同步频率。
需要注意在数据下沉模式中频率的单位是epoch的数量。否则频率的单位是step的数量。
在自适应同步频率模式下为初始同步频率,在固定频率模式下为同步频率。
- **sync_type** (str) - 采用同步策略类型的参数。
支持["fixed", "adaptive"]。默认值:"fixed"。
- **model** (nn.Cell) - 用于联邦训练的模型。
- **sync_frequency** (int) - 联邦学习中的参数同步频率。
需要注意在数据下沉模式中频率的单位是epoch的数量。否则频率的单位是step的数量。
在自适应同步频率模式下为初始同步频率,在固定频率模式下为同步频率。
- **sync_type** (str) - 采用同步策略类型的参数。
支持["fixed", "adaptive"]。默认值:"fixed"。
- fixed参数的同步频率是固定的。
- adaptive参数的同步频率是自适应变化的。
- **min_consistent_rate** (float) - 最小一致性比率阈值,该值越大同步频率提升难度越大。
取值范围大于等于0.0。默认值1.1。
- **min_consistent_rate_at_round** (int) - 最小一致性比率阈值的轮数,该值越大同步频率提升难度越大。
取值范围大于等于0。默认值0。
- **ema_alpha** (float) - 梯度一致性平滑系数,该值越小越会根据当前轮次的梯度分叉情况来判断频率是否需要改变,反之则会更加根据历史梯度分叉情况来判断。
取值范围:(0.0, 1.0)。默认值0.5。
- **observation_window_size** (int) - 观察时间窗的轮数,该值越大同步频率减小难度越大。
取值范围大于0。默认值5。
- **frequency_increase_ratio** (int) - 频率提升幅度,该值越大频率提升幅度越大。
取值范围大于0。默认值2。
- **unchanged_round** (int) - 频率不发生变化的轮数在前unchanged_round个轮次频率不会发生变化。
取值范围大于等于0。默认值0。
- fixed参数的同步频率是固定的。
- adaptive参数的同步频率是自适应变化的。
- **min_consistent_rate** (float) - 最小一致性比率阈值,该值越大同步频率提升难度越大。
取值范围大于等于0.0。默认值1.1。
- **min_consistent_rate_at_round** (int) - 最小一致性比率阈值的轮数,该值越大同步频率提升难度越大。
取值范围大于等于0。默认值0。
- **ema_alpha** (float) - 梯度一致性平滑系数,该值越小越会根据当前轮次的梯度分叉情况来判断频率是否
需要改变,反之则会更加根据历史梯度分叉情况来判断。
取值范围:(0.0, 1.0)。默认值0.5。
- **observation_window_size** (int) - 观察时间窗的轮数,该值越大同步频率减小难度越大。
取值范围大于0。默认值5。
- **frequency_increase_ratio** (int) - 频率提升幅度,该值越大频率提升幅度越大。
取值范围大于0。默认值2。
- **unchanged_round** (int) - 频率不发生变化的轮数在前unchanged_round个轮次频率不会发生变化。
取值范围大于等于0。默认值0。
.. note::
这是一个实验原型,可能会有变化。
@ -36,6 +36,5 @@
在step结束时同步参数。如果 `sync_type` 是"adaptive",同步频率会在这里自适应的调整。
**参数:**
- **run_context** (RunContext) - 包含模型的相关信息。
参数:
- **run_context** (RunContext) - 包含模型的相关信息。

View File

@ -106,83 +106,80 @@ 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'中的一个。
- **worker_num** (int) - 云侧训练进程的数量。
- **server_num** (int) - 联邦学习服务器的数量。默认值0。
- **scheduler_ip** (str) - 调度器IP。默认值'0.0.0.0'。
- **scheduler_port** (int) - 调度器端口。默认值6667。
- **fl_server_port** (int) - 服务器端口。默认值6668。
- **start_fl_job_threshold** (int) - 开启联邦学习作业的阈值计数。默认值1。
- **start_fl_job_time_window** (int) - 开启联邦学习作业的时间窗口持续时间以毫秒为单位。默认值300000。
- **update_model_ratio** (float) - 计算更新模型阈值计数的比率。默认值1.0。
- **update_model_time_window** (int) - 更新模型的时间窗口持续时间以毫秒为单位。默认值300000。
- **fl_name** (str) - 联邦学习作业名称。默认值:""。
- **fl_iteration_num** (int) - 联邦学习的迭代次数即客户端和服务器的交互次数。默认值20。
- **client_epoch_num** (int) - 客户端训练epoch数量。默认值25。
- **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'。如果是'DP_ENCRYPT',则将对客户端应用差分隐私模式,
隐私保护效果将由上面所述的dp_eps、dp_delta、dp_norm_clip确定。如果'PW_ENCRYPT'则将应用成对pairwisePW安全聚合
来保护客户端模型在跨设备场景中不被窃取。如果'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。
- **dp_eps** (float) - DP差分隐私机制的epsilon预算。dp_eps越小隐私保护效果越好。默认值50.0。
- **dp_delta** (float) - DP差分隐私机制的delta预算通常等于客户端数量的倒数。dp_delta越小隐私保护效果越好。默认值0.01。
- **dp_norm_clip** (float) - DP差分隐私梯度裁剪的控制因子。建议其值为0.5~2。默认值1.0。
- **sign_k** (float) - SignDSTop-k比率即Top-k维度的数量除以维度总数。建议取值范围在(0, 0.25]内。默认值0.01。
- **sign_eps** (float) - SignDS隐私预算。该值越小隐私保护力度越大精度越低。建议取值范围在(0, 100]内。默认值100。
- **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) - 用于集群容灾恢复的配置文件路径、认证相关参数以及文件路径、评价指标文件路径和运维相关文件路径。默认值:""。
- **scheduler_manage_port** (int) - 用于扩容/缩容的调度器管理端口。默认值11202。
- **enable_ssl** (bool) - 设置联邦学习开启SSL安全通信。默认值False。
- **client_password** (str) - 解密客户端证书中存储的秘钥的密码。默认值:""。
- **server_password** (str) - 解密服务器证书中存储的秘钥的密码。默认值:""。
- **pki_verify** (bool) - 如果为True则将打开服务器和客户端之间的身份验证。
还应从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。
- **http_url_prefix** (str) - 设置联邦学习端云通信的http路径。默认值""。
- **global_iteration_time_window** (int) - 一次迭代的全局时间窗口轮次ms。默认值3600000。
- **checkpoint_dir** (str) - server读取和保存模型文件的目录。若没有设置则不读取和保存模型文件。默认值""。
- **upload_compress_type** (str) - 上传压缩方法。可以是'NO_COMPRESS'或'DIFF_SPARSE_QUANT'。如果是'NO_COMPRESS',则不对上传的模型
进行压缩。如果是'DIFF_SPARSE_QUANT',则对上传的模型使用权重差+稀疏+量化压缩策略。默认值:'NO_COMPRESS'。
- **upload_sparse_rate** (float) - 上传压缩稀疏率。稀疏率越大,则压缩率越小。取值范围:(0, 1.0]。默认值0.4。
- **download_compress_type** (str) - 下载压缩方法。可以是'NO_COMPRESS'或'QUANT'。如果是'NO_COMPRESS',则不对下载的模型进行压缩。
如果是'QUANT',则对下载的模型使用量化压缩策略。默认值:'NO_COMPRESS'。
- **enable_fl** (bool) - 是否启用联邦学习训练模式。默认值False。
- **server_mode** (str) - 描述服务器模式,它必须是'FEDERATED_LEARNING'和'HYBRID_TRAINING'中的一个。
- **ms_role** (str) - 进程在联邦学习模式中的角色,
它必须是'MS_SERVER'、'MS_WORKER'和'MS_SCHED'中的一个。
- **worker_num** (int) - 云侧训练进程的数量。
- **server_num** (int) - 联邦学习服务器的数量。默认值0。
- **scheduler_ip** (str) - 调度器IP。默认值'0.0.0.0'。
- **scheduler_port** (int) - 调度器端口。默认值6667。
- **fl_server_port** (int) - 服务器端口。默认值6668。
- **start_fl_job_threshold** (int) - 开启联邦学习作业的阈值计数。默认值1。
- **start_fl_job_time_window** (int) - 开启联邦学习作业的时间窗口持续时间以毫秒为单位。默认值300000。
- **update_model_ratio** (float) - 计算更新模型阈值计数的比率。默认值1.0。
- **update_model_time_window** (int) - 更新模型的时间窗口持续时间以毫秒为单位。默认值300000。
- **fl_name** (str) - 联邦学习作业名称。默认值:""。
- **fl_iteration_num** (int) - 联邦学习的迭代次数即客户端和服务器的交互次数。默认值20。
- **client_epoch_num** (int) - 客户端训练epoch数量。默认值25。
- **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'则将应用成对pairwisePW安全聚合来保护客户端模型在跨设备场景中不被窃取
如果是'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>`_
- **share_secrets_ratio** (float) - PW参与秘密分享的客户端比例。默认值1.0。
- **cipher_time_window** (int) - PW每个加密轮次的时间窗口持续时间以毫秒为单位。默认值300000。
- **reconstruct_secrets_threshold** (int) - PW秘密重建的阈值。默认值2000。
- **dp_eps** (float) - DP差分隐私机制的epsilon预算。dp_eps越小隐私保护效果越好。默认值50.0。
- **dp_delta** (float) - DP差分隐私机制的delta预算通常等于客户端数量的倒数。dp_delta越小隐私保护效果越好。默认值0.01。
- **dp_norm_clip** (float) - DP差分隐私梯度裁剪的控制因子。建议其值为0.5~2。默认值1.0。
- **sign_k** (float) - SignDSTop-k比率即Top-k维度的数量除以维度总数。建议取值范围在(0, 0.25]内。默认值0.01。
- **sign_eps** (float) - SignDS隐私预算。该值越小隐私保护力度越大精度越低。建议取值范围在(0, 100]内。默认值100。
- **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) - 用于集群容灾恢复的配置文件路径、认证相关参数以及文件路径、评价指标文件路径和运维相关文件路径。默认值:''。
- **scheduler_manage_port** (int) - 用于扩容/缩容的调度器管理端口。默认值11202。
- **enable_ssl** (bool) - 设置联邦学习开启SSL安全通信。默认值False。
- **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证书。
需要注意的是只有当客户端是具有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。
- **http_url_prefix** (str) - 设置联邦学习端云通信的http路径。默认值""。
- **global_iteration_time_window** (int) - 一次迭代的全局时间窗口轮次ms。默认值3600000。
- **checkpoint_dir** (str) - server读取和保存模型文件的目录。若没有设置则不读取和保存模型文件。默认值""。
- **upload_compress_type** (str) - 上传压缩方法。可以是'NO_COMPRESS'或'DIFF_SPARSE_QUANT'。如果是'NO_COMPRESS',则不对上传的模型
进行压缩。如果是'DIFF_SPARSE_QUANT',则对上传的模型使用权重差+稀疏+量化压缩策略。默认值:'NO_COMPRESS'。
- **upload_sparse_rate** (float) - 上传压缩稀疏率。稀疏率越大,则压缩率越小。取值范围:(0, 1.0]。默认值0.4。
- **download_compress_type** (str) - 下载压缩方法。可以是'NO_COMPRESS'或'QUANT'。如果是'NO_COMPRESS',则不对下载的模型进行压缩。
如果是'QUANT',则对下载的模型使用量化压缩策略。默认值:'NO_COMPRESS'。
**异常:**
- **ValueError** - 如果输入key不是联邦学习模式context中的属性。
异常:
- **ValueError** - 如果输入key不是联邦学习模式context中的属性。
.. py:function:: mindspore.get_fl_context(attr_key)
根据key获取联邦学习模式context中的属性值。
**参数:**
参数:
- **attr_key** (str) - 属性的key。
请参考 `set_fl_context` 中的参数来决定应传递的key。
- **attr_key** (str) - 属性的key。
请参考 `set_fl_context` 中的参数来决定应传递的key
返回:
根据key返回属性值。
**返回:**
异常:
- **ValueError** - 如果输入key不是联邦学习模式context中的属性。
Object表示给定属性key的值。
**异常:**
- **ValueError** - 如果输入key不是联邦学习模式context中的属性。

View File

@ -6,39 +6,32 @@
.. note::
示例的详细信息,请参见 `转换CIFAR-10数据集 <https://www.mindspore.cn/tutorials/zh-CN/master/advanced/dataset/record.html#转换cifar-10数据集>`_
**参数:**
参数:
- **source** (str) - 待转换的CIFAR-100数据集文件所在目录的路径。
- **destination** (str) - 转换生成的MindRecord文件路径需提前创建目录并且目录下不能存在同名文件。
- **source** (str) - 待转换的CIFAR-100数据集文件所在目录的路径。
- **destination** (str) - 转换生成的MindRecord文件路径需提前创建目录并且目录下不能存在同名文件。
**异常:**
- **ValueError** - 参数 `source``destination` 无效。
异常:
- **ValueError** - 参数 `source``destination` 无效。
.. py:method:: run(fields=None)
执行从CIFAR-100数据集到MindRecord格式数据集的转换。
**参数:**
- **fields** (list[str],可选) - 索引字段的列表,例如['fine_label', 'coarse_label']。默认值None。
索引字段的设置请参考函数 :func:`mindspore.mindrecord.FileWriter.add_index`
**返回:**
MSRStatusSUCCESS或FAILED。
参数:
- **fields** (list[str],可选) - 索引字段的列表,例如['fine_label', 'coarse_label']。默认值None。
索引字段的设置请参考函数 :func:`mindspore.mindrecord.FileWriter.add_index`
返回:
MSRStatusSUCCESS或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`
- **fields** (list[str],可选) - 索引字段的列表,例如['fine_label', 'coarse_label']。默认值None。
索引字段的设置请参考函数 :func:`mindspore.mindrecord.FileWriter.add_index`
**返回:**
MSRStatusSUCCESS或FAILED。
返回:
MSRStatusSUCCESS或FAILED。

View File

@ -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` 无效。
参数:
- **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`
**返回:**
MSRStatusSUCCESS或FAILED。
参数:
- **fields** (list[str],可选) - 索引字段的列表。默认值None。
索引字段的设置请参考函数 :func:`mindspore.mindrecord.FileWriter.add_index`
返回:
MSRStatusSUCCESS或FAILED。
.. py:method:: transform(fields=None)
:func:`mindspore.mindrecord.Cifar10ToMR.run` 的包装函数来保证异常时正常退出。
**参数:**
参数:
- **fields** (list[str],可选) - 索引字段的列表。默认值None。
索引字段的设置请参考函数 :func:`mindspore.mindrecord.FileWriter.add_index`
- **fields** (list[str],可选) - 索引字段的列表。默认值None。
索引字段的设置请参考函数 :func:`mindspore.mindrecord.FileWriter.add_index`
**返回:**
MSRStatusSUCCESS或FAILED。
返回:
MSRStatusSUCCESS或FAILED。

View File

@ -6,32 +6,27 @@
.. 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。
- **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` 无效。
异常:
- **ValueError** - 参数 `source``destination``partition_number` 无效。
- **RuntimeError** - 参数 `columns_list` 无效。
.. py:method:: run()
执行从CSV格式数据集到MindRecord格式数据集的转换。
**返回:**
MSRStatusSUCCESS或FAILED。
返回:
MSRStatusSUCCESS或FAILED。
.. py:method:: transform()
:func:`mindspore.mindrecord.CsvToMR.run` 的包装函数来保证异常时正常退出。
**返回:**
MSRStatusSUCCESS或FAILED。
返回:
SRStatusSUCCESS或FAILED。

View File

@ -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` 无效。
参数:
- **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下一批数据键值与数据列名相同。
dict下一批数据键值与数据列名相同。
**异常:**
- **MRMUnsupportedSchemaError** - 当schema无效。
异常:
- **MRMUnsupportedSchemaError** - 当schema无效。

View File

@ -6,16 +6,13 @@
.. note::
生成MindRecord文件后如果修改文件名可能会导致读取文件失败。
**参数:**
- **file_name** (str) - 转换生成的MindRecord文件路径。
- **shard_num** (int可选) - 生成MindRecord的文件个数。取值范围为[1, 1000]。默认值1。
- **overwrite** (bool可选) - 当指定目录存在同名文件时是否覆盖写。默认值False。
**异常:**
- **ParamValueError** - `file_name``shard_num` 无效。
参数:
- **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)
@ -26,21 +23,17 @@
- 如果不调用该函数则默认将schema中所有的Primitive类型的字段设置为索引。
请参考类的示例 :class:`mindspore.mindrecord.FileWriter`
**参数:**
参数:
- **index_fields** (list[str]) - schema中的字段。
- **index_fields** (list[str]) - schema中的字段。
**返回:**
MSRStatusSUCCESS或FAILED。
**异常:**
- **ParamTypeError** - 索引字段无效。
- **MRMDefineIndexError** - 索引字段不是Primitive类型。
- **MRMAddIndexError** - 无法添加索引字段。
- **MRMGetMetaError** - 未设置schema或无法获取schema。
返回:
MSRStatusSUCCESS或FAILED。
异常:
- **ParamTypeError** - 索引字段无效。
- **MRMDefineIndexError** - 索引字段不是Primitive类型。
- **MRMAddIndexError** - 无法添加索引字段。
- **MRMGetMetaError** - 未设置schema或无法获取schema。
.. py:method:: add_schema(content, desc=None)
@ -49,21 +42,17 @@
.. note::
请参考类的示例 :class:`mindspore.mindrecord.FileWriter`
**参数:**
参数:
- **content** (dict) - schema内容的字典。
- **desc** (str可选) - schema的描述。默认值None。
- **content** (dict) - schema内容的字典。
- **desc** (str可选) - schema的描述。默认值None。
**返回:**
intschema ID。
**异常:**
- **MRMInvalidSchemaError** - schema无效。
- **MRMBuildSchemaError** - 构建schema失败。
- **MRMAddSchemaError** - 添加schema失败。
返回:
intschema ID。
异常:
- **MRMInvalidSchemaError** - schema无效。
- **MRMBuildSchemaError** - 构建schema失败。
- **MRMAddSchemaError** - 添加schema失败。
.. py:method:: commit()
@ -72,89 +61,71 @@
.. note::
请参考类的示例 :class:`mindspore.mindrecord.FileWriter`
**返回:**
返回:
MSRStatusSUCCESS或FAILED。
MSRStatusSUCCESS或FAILED。
**异常:**
- **MRMOpenError** - 打开MindRecord文件失败。
- **MRMSetHeaderError** - 设置MindRecord文件的header失败。
- **MRMIndexGeneratorError** - 创建索引Generator失败。
- **MRMGenerateIndexError** - 写入数据库失败。
- **MRMCommitError** - 数据同步到磁盘失败。
异常:
- **MRMOpenError** - 打开MindRecord文件失败。
- **MRMSetHeaderError** - 设置MindRecord文件的header失败。
- **MRMIndexGeneratorError** - 创建索引Generator失败。
- **MRMGenerateIndexError** - 写入数据库失败。
- **MRMCommitError** - 数据同步到磁盘失败。
.. py:method:: open_and_set_header()
打开MindRecord文件准备写入并且设置描述其meta信息的头部该函数仅用于并行写入并在 `write_raw_data` 函数之前调用。
**返回:**
MSRStatusSUCCESS或FAILED。
**异常:**
- **MRMOpenError** - 打开MindRecord文件失败。
- **MRMSetHeaderError** - 设置MindRecord文件的header失败。
返回:
MSRStatusSUCCESS或FAILED。
异常:
- **MRMOpenError** - 打开MindRecord文件失败。
- **MRMSetHeaderError** - 设置MindRecord文件的header失败。
.. py:method:: open_for_append(file_name)
打开MindRecord文件准备追加数据。
**参数:**
参数:
- **file_name** (str) - MindRecord格式的数据集文件的路径。
- **file_name** (str) - MindRecord格式的数据集文件的路径。
**返回:**
FileWriterMindRecord文件的写对象。
**异常:**
- **ParamValueError** - `file_name` 无效。
- **FileNameError** - MindRecord文件路径中包含无效字符。
- **MRMOpenError** - 打开MindRecord文件失败。
- **MRMOpenForAppendError** - 打开MindRecord文件追加数据失败。
返回:
FileWriterMindRecord文件的写对象。
异常:
- **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)。
- **header_size** (int) - header大小可设置范围为16*1024(16KB)到128*1024*1024(128MB)。
**返回:**
MSRStatusSUCCESS或FAILED。
**异常:**
- **MRMInvalidHeaderSizeError** - 设置header大小失败。
返回:
MSRStatusSUCCESS或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)。
- **page_size** (int) - page大小可设置范围为32*1024(32KB)到256*1024*1024(256MB)。
**返回:**
MSRStatusSUCCESS或FAILED。
**异常:**
- **MRMInvalidPageSizeError** - 设置page大小失败。
返回:
MSRStatusSUCCESS或FAILED。
异常:
- **MRMInvalidPageSizeError** - 设置page大小失败。
.. py:method:: write_raw_data(raw_data, parallel_writer=False)
@ -163,20 +134,17 @@
.. note::
请参考类的示例 :class:`mindspore.mindrecord.FileWriter`
**参数:**
参数:
- **raw_data** (list[dict]) - 用户自定义数据的列表。
- **parallel_writer** (bool可选) - 如果为True则并行写入用户自定义数据。默认值False。
- **raw_data** (list[dict]) - 用户自定义数据的列表。
- **parallel_writer** (bool可选) - 如果为True则并行写入用户自定义数据。默认值False
返回:
MSRStatusSUCCESS或FAILED
**返回:**
MSRStatusSUCCESS或FAILED。
**异常:**
- **ParamTypeError** - 索引字段无效。
- **MRMOpenError** - 打开MindRecord文件失败。
- **MRMValidateDataError** - 数据校验失败。
- **MRMSetHeaderError** - 设置MindRecord文件的header失败。
- **MRMWriteDatasetError** - 写入MindRecord格式的数据集失败。
异常:
- **ParamTypeError** - 索引字段无效。
- **MRMOpenError** - 打开MindRecord文件失败。
- **MRMValidateDataError** - 数据校验失败。
- **MRMSetHeaderError** - 设置MindRecord文件的header失败。
- **MRMWriteDatasetError** - 写入MindRecord格式的数据集失败。

View File

@ -3,38 +3,33 @@
将ImageNet数据集转换为MindRecord格式数据集。
**参数:**
参数:
- **map_file** (str) - 标签映射文件的路径。映射文件内容如下:
- **map_file** (str) - 标签映射文件的路径。映射文件内容如下:
.. code-block::
.. code-block::
n02119789 0
n02100735 1
n02110185 2
n02096294 3
n02119789 0
n02100735 1
n02110185 2
n02096294 3
- **image_dir** (str) - ImageNet数据集的目录路径目录中包含类似n02119789、n02100735、n02110185和n02096294的子目录。
- **destination** (str) - 转换生成的MindRecord文件路径需提前创建目录并且目录下不能存在同名文件。
- **partition_number** (int可选) - 生成MindRecord的文件个数。默认值1。
- **image_dir** (str) - ImageNet数据集的目录路径目录中包含类似n02119789、n02100735、n02110185和n02096294的子目录。
- **destination** (str) - 转换生成的MindRecord文件路径需提前创建目录并且目录下不能存在同名文件。
- **partition_number** (int可选) - 生成MindRecord的文件个数。默认值1。
**异常:**
- **ValueError** - 参数 `map_file``image_dir``destination` 无效。
异常:
- **ValueError** - 参数 `map_file``image_dir``destination` 无效。
.. py:method:: run()
执行从ImageNet数据集到MindRecord格式数据集的转换。
**返回:**
MSRStatusSUCCESS或FAILED。
返回:
MSRStatusSUCCESS或FAILED。
.. py:method:: transform()
:func:`mindspore.mindrecord.ImageNetToMR.run` 的包装函数来保证异常时正常退出。
**返回:**
MSRStatusSUCCESS或FAILED。
返回:
MSRStatusSUCCESS或FAILED。

View File

@ -3,25 +3,21 @@
以分页方式读取MindRecord文件的类。
**参数:**
- **file_name** (Union[str, list[str]]) - MindRecord格式的数据集文件或文件列表。
- **num_consumer** (int可选) - 加载数据的并发数。默认值4。不应小于1或大于处理器的核数。
**异常:**
- **ParamValueError** - `file_name``num_consumer``columns` 无效。
- **MRMInitSegmentError** - 初始化ShardSegment失败。
参数:
- **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 字段。
返回:
list[str]候选category 字段。
.. py:method:: category_field
@ -29,68 +25,55 @@
返回用于数据分组的category字段。
**返回:**
list[str]category字段。
返回:
list[str]category字段。
.. py:method:: get_category_fields()
返回用于数据分组的候选category字段。
**返回:**
list[str]候选category字段。
返回:
list[str]候选category字段。
.. py:method:: read_at_page_by_id(category_id, page, num_row)
以分页方式按category ID进行查询。
**参数:**
参数:
- **category_id** (int) - category ID参考 `read_category_info` 函数的返回值。
- **page** (int) - 分页的索引。
- **num_row** (int) - 每个分页的行数。
- **category_id** (int) - category ID参考 `read_category_info` 函数的返回值。
- **page** (int) - 分页的索引。
- **num_row** (int) - 每个分页的行数。
**返回:**
list[dict]根据category ID查询的数据。
**异常:**
- **ParamValueError** - 参数无效。
- **MRMFetchDataError** - 无法按category ID获取数据。
- **MRMUnsupportedSchemaError** - schema无效。
返回:
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字段查询的数据。
参数:
- **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信息失败。
返回:
str分组信息的描述。
异常:
- **MRMReadCategoryInfoError** - 读取category信息失败。
.. py:method:: set_category_field(category_field)
@ -99,10 +82,8 @@
.. note::
必须是候选category字段。
**参数:**
参数:
- **category_field** (str) - category字段名称。
- **category_field** (str) - category字段名称。
**返回:**
MSRStatusSUCCESS或FAILED
返回:
MSRStatusSUCCESS或FAILED

View File

@ -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` 无效。
参数:
- **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格式数据集的转换。
**返回:**
MSRStatusMNIST数据集是否成功转换为MindRecord格式数据集。
返回:
MSRStatusMNIST数据集是否成功转换为MindRecord格式数据集。
.. py:method:: transform()
:func:`mindspore.mindrecord.MnistToMR.run` 函数的包装函数来保证异常时正常退出。
**返回:**
MSRStatusSUCCESS或FAILED。
返回:
MSRStatusSUCCESS或FAILED。

View File

@ -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模块或其版本不正确。
参数:
- **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格式数据集的转换。
**返回:**
MSRStatusSUCCESS或FAILED。
返回:
MSRStatusSUCCESS或FAILED。
.. py:method:: tfrecord_iterator()
生成一个字典其key是schema中的字段value是数据。
**返回:**
Dictkey与schema中字段名相同的数据字典。
返回:
Dictkey与schema中字段名相同的数据字典。
.. py:method:: tfrecord_iterator_oldversion()
生成一个字典其中key是schema中的字段value是数据。该函数适用于早于2.1.0版本的TensorFlow。
**返回:**
Dictkey与schema中字段名相同的数据字典。
返回:
Dictkey与schema中字段名相同的数据字典。
.. py:method:: transform()
:func:`mindspore.mindrecord.TFRecordToMR.run` 的包装函数来保证异常时正常退出。
**返回:**
MSRStatusSUCCESS或FAILED。
返回:
MSRStatusSUCCESS或FAILED。

View File

@ -5,13 +5,12 @@ 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。
- **dtype** (mindspore.dtype) - Bijector可以操作的分布的数据类型。默认值None。
- **param** (dict) - 用于初始化Bijector的参数。默认值None。
参数:
- **is_constant_jacobian** (bool) - Bijector是否具有常数导数。默认值False。
- **is_injective** (bool) - Bijector是否为一对一映射。默认值True。
- **name** (str) - Bijector名称。默认值None。
- **dtype** (mindspore.dtype) - Bijector可以操作的分布的数据类型。默认值None。
- **param** (dict) - 用于初始化Bijector的参数。默认值None。
.. note::
Bijector的 `dtype` 为None时输入值必须是float类型除此之外没有其他强制要求。
@ -30,10 +29,9 @@ mindspore.nn.probability.bijector.Bijector
将输入中的 `para` 的数据类型转换为与 `value` 相同的类型一般由Bijector的子类用于基于输入对自身参数进行数据类型变化。
**参数:**
- **value** (Tensor) - 输入数据。
- **para** (Tensor) - Bijector参数。
参数:
- **value** (Tensor) - 输入数据。
- **para** (Tensor) - Bijector参数。
.. py:method:: construct(name, *args, **kwargs)
@ -42,64 +40,55 @@ mindspore.nn.probability.bijector.Bijector
.. note::
支持的函数名称包括:'forward'、'inverse'、'forward_log_jacobian'、'inverse_log_jacobian'。
**参数:**
- **name** (str) - 函数名称。
- **args** (list) - 函数所需的位置参数列表。
- **kwargs** (dict) - 函数所需的关键字参数字典。
参数:
- **name** (str) - 函数名称。
- **args** (list) - 函数所需的位置参数列表。
- **kwargs** (dict) - 函数所需的关键字参数字典。
.. py:method:: forward(value, *args, **kwargs)
正映射,计算输入随机变量 :math:`X = value` 经过映射后的值 :math:`Y = g(value)`
**参数:**
参数:
- **value** (Tensor) - 输入随机变量的值。
- **args** (list) - 函数所需的位置参数列表。
- **kwargs** (dict) - 函数所需的关键字参数字典。
- **value** (Tensor) - 输入随机变量的值。
- **args** (list) - 函数所需的位置参数列表。
- **kwargs** (dict) - 函数所需的关键字参数字典。
**返回:**
Tensor输出随机变量的值。
返回:
Tensor输出随机变量的值。
.. py:method:: forward_log_jacobian(value, *args, **kwargs)
计算正映射导数的对数值,即 :math:`\log(dg(x) / dx)`
**参数:**
参数:
- **value** (Tensor) - 输入随机变量的值。
- **args** (list) - 函数所需的位置参数列表。
- **kwargs** (dict) - 函数所需的关键字参数字典。
- **value** (Tensor) - 输入随机变量的值。
- **args** (list) - 函数所需的位置参数列表。
- **kwargs** (dict) - 函数所需的关键字参数字典。
**返回:**
Tensor正映射导数的对数值。
返回:
Tensor正映射导数的对数值。
.. py:method:: inverse(value, *args, **kwargs)
逆映射,计算输出随机变量 :math:`Y = value` 时对应的输入随机变量的值 :math:`X = g^{-1}(value)`
**参数:**
- **value** (Tensor) - 输出随机变量的值。
- **args** (list) - 函数所需的位置参数列表。
- **kwargs** (dict) - 函数所需的关键字参数字典。
参数:
- **value** (Tensor) - 输出随机变量的值。
- **args** (list) - 函数所需的位置参数列表。
- **kwargs** (dict) - 函数所需的关键字参数字典。
**返回:**
Tensor输入随机变量的值。
返回:
Tensor输入随机变量的值。
.. py:method:: inverse_log_jacobian(value, *args, **kwargs)
计算逆映射导数的对数值,即 :math:`\log(dg^{-1}(x) / dx)`
**参数:**
参数:
- **value** (Tensor) - 输出随机变量的值。
- **args** (list) - 函数所需的位置参数列表。
- **kwargs** (dict) - 函数所需的关键字参数字典。
- **value** (Tensor) - 输出随机变量的值。
- **args** (list) - 函数所需的位置参数列表。
- **kwargs** (dict) - 函数所需的关键字参数字典。
**返回:**
Tensor逆映射导数的对数值。
返回:
Tensor逆映射导数的对数值。

View File

@ -9,55 +9,46 @@ mindspore.nn.probability.bijector.Exp
.. math::
Y = \exp(x).
**参数:**
- **name** (str) - Bijector名称。默认值'Exp'。
参数:
- **name** (str) - Bijector名称。默认值'Exp'。
.. py:method:: forward(value)
正映射,计算输入随机变量 :math:`X = value` 经过映射后的值 :math:`Y = \exp(value)`
**参数:**
参数:
- **value** (Tensor) - 输入随机变量的值。
- **value** (Tensor) - 输入随机变量的值。
**返回:**
Tensor输出随机变量的值。
返回:
Tensor输出随机变量的值。
.. py:method:: forward_log_jacobian(value)
计算正映射导数的对数值,即 :math:`\log(d\exp(x) / dx)`
**参数:**
参数:
- **value** (Tensor) - 输入随机变量的值。
- **value** (Tensor) - 输入随机变量的值。
**返回:**
Tensor正映射导数的对数值。
返回:
Tensor正映射导数的对数值。
.. py:method:: inverse(value)
正映射,计算输出随机变量 :math:`Y = value` 时对应的输入随机变量的值 :math:`X = \log(value)`
**参数:**
参数:
- **value** (Tensor) - 输出随机变量的值。
- **value** (Tensor) - 输出随机变量的值。
**返回:**
Tensor输入随机变量的值。
返回:
Tensor输入随机变量的值。
.. py:method:: inverse_log_jacobian(value)
计算逆映射导数的对数值,即 :math:`\log(d\log(x) / dx)`
**参数:**
参数:
- **value** (Tensor) - 输出随机变量的值。
- **value** (Tensor) - 输出随机变量的值。
**返回:**
Tensor逆映射导数的对数值。
返回:
Tensor逆映射导数的对数值。

View File

@ -9,11 +9,10 @@ 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'。
参数:
- **loc** (float, list, numpy.ndarray, Tensor) - 位移因子即上述公式中的loc。默认值0.0。
- **scale** (float, list, numpy.ndarray, Tensor) - 比例因子即上述公式中的scale。默认值1.0。
- **name** (str) - Bijector名称。默认值'GumbelCDF'。
.. note::
- `scale` 中元素必须大于零。
@ -21,72 +20,61 @@ mindspore.nn.probability.bijector.GumbelCDF
- `loc``scale` 中元素的数据类型必须为float。
- 如果 `loc``scale` 作为numpy.ndarray或Tensor传入则它们必须具有相同的数据类型否则将引发错误。
**异常:**
- **TypeError** - `loc``scale` 中元素的数据类型不为float`loc``scale` 中元素的数据类型不相同。
异常:
- **TypeError** - `loc``scale` 中元素的数据类型不为float`loc``scale` 中元素的数据类型不相同。
.. py:method:: loc
:property:
返回分布位置。
**返回:**
Tensor分布的位置值。
返回:
Tensor分布的位置值。
.. py:method:: scale
:property:
返回分布比例。
**返回:**
Tensor分布的比例值。
返回:
Tensor分布的比例值。
.. py:method:: forward(value)
正映射,计算输入随机变量 :math:`X = value` 经过映射后的值 :math:`Y = g(value)`
**参数:**
参数:
- **value** (Tensor) - 输入随机变量的值。
- **value** (Tensor) - 输入随机变量的值。
**返回:**
Tensor输入随机变量的值。
返回:
Tensor输入随机变量的值。
.. py:method:: forward_log_jacobian(value)
计算正映射导数的对数值,即 :math:`\log(dg(x) / dx)`
**参数:**
参数:
- **value** (Tensor) - 输入随机变量的值。
- **value** (Tensor) - 输入随机变量的值。
**返回:**
Tensor正映射导数的对数值。
返回:
Tensor正映射导数的对数值。
.. py:method:: inverse(value)
正映射,计算输出随机变量 :math:`Y = value` 时对应的输入随机变量的值 :math:`X = g(value)`
**参数:**
参数:
- **value** (Tensor) - 输出随机变量的值。
- **value** (Tensor) - 输出随机变量的值。
**返回:**
Tensor输出随机变量的值。
返回:
Tensor输出随机变量的值。
.. py:method:: inverse_log_jacobian(value)
计算逆映射导数的对数值,即 :math:`\log(dg^{-1}(x) / dx)`
**参数:**
参数:
- **value** (Tensor) - 输出随机变量的值。
- **value** (Tensor) - 输出随机变量的值。
**返回:**
Tensor逆映射导数的对数值。
返回:
Tensor逆映射导数的对数值。

View File

@ -6,10 +6,9 @@ mindspore.nn.probability.bijector.Invert
逆映射BijectorInvert Bijector
计算输入Bijector的逆映射。如果正向映射下面的 `bijector` 输入)对应的映射函数为 :math:`Y = g(X)` 那么对应的逆映射Bijector的映射函数为 :math:`Y = h(X) = g^{-1}(X)`
**参数:**
- **bijector** (Bijector) - 基础BijectorBase Bijector
- **name** (str) - Bijector名称。默认值""。当name设置为""时,它实际上是'Invert' + Bijector.name。
参数:
- **bijector** (Bijector) - 基础BijectorBase Bijector
- **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的输出随机变量的值。
- **x** (Tensor) - 基础Bijector的输出随机变量的值。
**返回:**
Tensor基础Bijector的输入随机变量的值。
返回:
Tensor基础Bijector的输入随机变量的值。
.. py:method:: forward_log_jacobian(x)
计算基础Bijector的逆映射导数的对数值:math:`\log dg^{-1}(x) / dx`
**参数:**
参数:
- **x** (Tensor) - 基础Bijector的输出随机变量的值。
- **x** (Tensor) - 基础Bijector的输出随机变量的值。
**返回:**
Tensor基类逆映射导数的对数值。
返回:
Tensor基类逆映射导数的对数值。
.. py:method:: inverse(y)
计算基础Bijector的正映射:math:`Y = g(X)`
**参数:**
参数:
- **y** (Tensor) - 基础Bijector的输入随机变量的值。
- **y** (Tensor) - 基础Bijector的输入随机变量的值。
**返回:**
Tensor基础Bijector的输出随机变量的值。
返回:
Tensor基础Bijector的输出随机变量的值。
.. py:method:: inverse_log_jacobian(y)
计算基础Bijector的正映射导数的对数:math:`Y = \log dg(x) / dx`
**参数:**
参数:
- **y** (Tensor) - 基础Bijector的输入随机变量的值。
- **y** (Tensor) - 基础Bijector的输入随机变量的值。
**返回:**
Tensor基类正映射导数的对数值。
返回:
Tensor基类正映射导数的对数值。

View File

@ -15,72 +15,61 @@ 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'。
参数:
- **power** (float, list, numpy.ndarray, Tensor) - 比例因子。默认值0。
- **name** (str) - Bijector名称。默认值'PowerTransform'。
.. note::
`power` 中元素的数据类型必须为float。
**异常:**
- **ValueError** - `power` 中元素小于0或静态未知。
- **TypeError** - `power` 中元素的数据类型不是float。
异常:
- **ValueError** - `power` 中元素小于0或静态未知。
- **TypeError** - `power` 中元素的数据类型不是float。
.. py:method:: power
:property:
返回指数。
**返回:**
TensorBijector的指数。
返回:
TensorBijector的指数。
.. py:method:: forward(value)
正映射,计算输入随机变量 :math:`X = value` 经过映射后的值 :math:`Y = g(value)`
**参数:**
参数:
- **value** (Tensor) - 输入随机变量的值。
- **value** (Tensor) - 输入随机变量的值。
**返回:**
Tensor输入随机变量的值。
返回:
Tensor输入随机变量的值。
.. py:method:: forward_log_jacobian(value)
计算正映射导数的对数值,即 :math:`\log(dg(x) / dx)`
**参数:**
参数:
- **value** (Tensor) - 输入随机变量的值。
- **value** (Tensor) - 输入随机变量的值。
**返回:**
Tensor正映射导数的对数值。
返回:
Tensor正映射导数的对数值。
.. py:method:: inverse(value)
正映射,计算输出随机变量 :math:`Y = value` 时对应的输入随机变量的值 :math:`X = g(value)`
**参数:**
参数:
- **value** (Tensor) - 输出随机变量的值。
- **value** (Tensor) - 输出随机变量的值。
**返回:**
Tensor输出随机变量的值。
返回:
Tensor输出随机变量的值。
.. py:method:: inverse_log_jacobian(value)
计算逆映射导数的对数值,即 :math:`\log(dg^{-1}(x) / dx)`
**参数:**
参数:
- **value** (Tensor) - 输出随机变量的值。
- **value** (Tensor) - 输出随机变量的值。
**返回:**
Tensor逆映射导数的对数值。
返回:
Tensor逆映射导数的对数值。

View File

@ -11,81 +11,69 @@ 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'。
参数:
- **scale** (float, list, numpy.ndarray, Tensor) - 比例因子。默认值1.0。
- **shift** (float, list, numpy.ndarray, Tensor) - 移位因子。默认值0.0。
- **name** (str) - Bijector名称。默认值'ScalarAffine'。
.. note::
`shift``scale` 中元素的数据类型必须为float。如果 `shift``scale` 作为numpy.ndarray或Tensor传入则它们必须具有相同的数据类型否则将引发错误。
**异常:**
- **TypeError** - `shift``scale` 中元素的数据类型不为float`shift``scale` 的数据类型不相同。
异常:
- **TypeError** - `shift``scale` 中元素的数据类型不为float`shift``scale` 的数据类型不相同。
.. py:method:: shift
:property:
返回映射的位置。
**返回:**
Tensor映射的位置值。
返回:
Tensor映射的位置值。
.. py:method:: scale
:property:
返回映射的比例。
**返回:**
Tensor映射的比例值。
返回:
Tensor映射的比例值。
.. py:method:: forward(value)
正映射,计算输入随机变量 :math:`X = value` 经过映射后的值 :math:`Y = g(value)`
**参数:**
参数:
- **value** (Tensor) - 输入随机变量的值。
- **value** (Tensor) - 输入随机变量的值。
**返回:**
Tensor输入随机变量的值。
返回:
Tensor输入随机变量的值。
.. py:method:: forward_log_jacobian(value)
计算正映射导数的对数值,即 :math:`\log(dg(x) / dx)`
**参数:**
参数:
- **value** (Tensor) - 输入随机变量的值。
- **value** (Tensor) - 输入随机变量的值。
**返回:**
Tensor正映射导数的对数值。
返回:
Tensor正映射导数的对数值。
.. py:method:: inverse(value)
正映射,计算输出随机变量 :math:`Y = value` 时对应的输入随机变量的值 :math:`X = g(value)`
**参数:**
参数:
- **value** (Tensor) - 输出随机变量的值。
- **value** (Tensor) - 输出随机变量的值。
**返回:**
Tensor输出随机变量的值。
返回:
Tensor输出随机变量的值。
.. py:method:: inverse_log_jacobian(value)
计算逆映射导数的对数值,即 :math:`\log(dg^{-1}(x) / dx)`
**参数:**
参数:
- **value** (Tensor) - 输出随机变量的值。
- **value** (Tensor) - 输出随机变量的值。
**返回:**
Tensor逆映射导数的对数值。
返回:
Tensor逆映射导数的对数值。

View File

@ -11,71 +11,60 @@ mindspore.nn.probability.bijector.Softplus
其中k是锐度因子。
**参数:**
- **sharpness** (float, list, numpy.ndarray, Tensor) - 锐度因子上述公式中的k。默认值1.0。
- **name** (str) - Bijector名称。默认值'Softplus'。
参数:
- **sharpness** (float, list, numpy.ndarray, Tensor) - 锐度因子上述公式中的k。默认值1.0。
- **name** (str) - Bijector名称。默认值'Softplus'。
.. note::
`sharpness` 中元素的数据类型必须为float。
**异常:**
- **TypeError** - sharpness中元素的数据类型不为float。
异常:
- **TypeError** - sharpness中元素的数据类型不为float。
.. py:method:: sharpness
:property:
返回映射的锐度因子。
**返回:**
Tensor映射的锐度因子。
返回:
Tensor映射的锐度因子。
.. py:method:: forward(value)
正映射,计算输入随机变量 :math:`X = value` 经过映射后的值 :math:`Y = g(value)`
**参数:**
参数:
- **value** (Tensor) - 输入随机变量的值。
- **value** (Tensor) - 输入随机变量的值。
**返回:**
Tensor输入随机变量的值。
返回:
Tensor输入随机变量的值。
.. py:method:: forward_log_jacobian(value)
计算正映射导数的对数值,即 :math:`\log(dg(x) / dx)`
**参数:**
参数:
- **value** (Tensor) - 输入随机变量的值。
- **value** (Tensor) - 输入随机变量的值。
**返回:**
Tensor正映射导数的对数值。
返回:
Tensor正映射导数的对数值。
.. py:method:: inverse(value)
正映射,计算输出随机变量 :math:`Y = value` 时对应的输入随机变量的值 :math:`X = g(value)`
**参数:**
参数:
- **value** (Tensor) - 输出随机变量的值。
- **value** (Tensor) - 输出随机变量的值。
**返回:**
Tensor输出随机变量的值。
返回:
Tensor输出随机变量的值。
.. py:method:: inverse_log_jacobian(value)
计算逆映射导数的对数值,即 :math:`\log(dg^{-1}(x) / dx)`
**参数:**
参数:
- **value** (Tensor) - 输出随机变量的值。
- **value** (Tensor) - 输出随机变量的值。
**返回:**
Tensor逆映射导数的对数值。
返回:
Tensor逆映射导数的对数值。

View File

@ -6,204 +6,173 @@ 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.
- **name** (str) - 分布的名称。默认值:'Bernoulli'。
参数:
- **probs** (float, list, numpy.ndarray, Tensor) - 结果是1的概率。默认值None。
- **seed** (int) - 采样时使用的种子。如果为None则使用全局种子。默认值None。
- **dtype** (mindspore.dtype) - 采样结果的数据类型。默认值mstype.int32.
- **name** (str) - 分布的名称。默认值:'Bernoulli'。
.. note::
`probs` 中元素必须是合适的概率0<p<1
**异常:**
- **ValueError** - `probs` 中元素小于0或大于1。
异常:
- **ValueError** - `probs` 中元素小于0或大于1。
.. py:method:: probs
:property:
返回结果为1的概率。
**返回:**
Tensor结果为1的概率。
返回:
Tensor结果为1的概率。
.. py:method:: cdf(value, probs1)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
- **value** (Tensor) - 要计算的值。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor累积分布函数的值。
返回:
Tensor累积分布函数的值。
.. py:method:: cross_entropy(dist, probs1_b, probs1_a)
计算分布a和b之间的交叉熵。
**参数:**
参数:
- **dist** (str) - 分布的类型。
- **probs1_b** (Tensor) - 对比分布的伯努利实验成功的概率。
- **probs1_a** (Tensor) - 伯努利实验成功的概率。默认值None。
- **dist** (str) - 分布的类型。
- **probs1_b** (Tensor) - 对比分布的伯努利实验成功的概率。
- **probs1_a** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor交叉熵的值。
返回:
Tensor交叉熵的值。
.. py:method:: entropy(probs1)
计算熵。
**参数:**
参数:
- **probs1** (Tensor) - 对比分布的伯努利实验成功的概率。默认值None。
- **probs1** (Tensor) - 对比分布的伯努利实验成功的概率。默认值None。
**返回:**
Tensor熵的值。
返回:
Tensor熵的值。
.. py:method:: kl_loss(dist, probs1_b, probs1_a)
计算KL散度即KL(a||b)。
**参数:**
参数:
- **dist** (str) - 分布的类型。
- **probs1_b** (Tensor) - 对比分布的伯努利实验成功的概率。
- **probs1_a** (Tensor) - 伯努利实验成功的概率。默认值None。
- **dist** (str) - 分布的类型。
- **probs1_b** (Tensor) - 对比分布的伯努利实验成功的概率。
- **probs1_a** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
TensorKL散度。
返回:
TensorKL散度。
.. py:method:: log_cdf(value, probs1)
计算给定值对于的累积分布函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
- **value** (Tensor) - 要计算的值。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, probs1)
计算给定值对应的概率的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
- **value** (Tensor) - 要计算的值。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, probs1)
计算给定值对应的生存函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
- **value** (Tensor) - 要计算的值。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor生存函数的对数。
返回:
Tensor生存函数的对数。
.. py:method:: mean(probs1)
计算期望。
**参数:**
参数:
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor概率分布的期望。
返回:
Tensor概率分布的期望。
.. py:method:: mode(probs1)
计算众数。
**参数:**
参数:
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor概率分布的众数。
返回:
Tensor概率分布的众数。
.. py:method:: prob(value, probs1)
计算给定值下的概率。对于离散分布是计算概率质量函数Probability Mass Function
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
- **value** (Tensor) - 要计算的值。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor概率值。
返回:
Tensor概率值。
.. py:method:: sample(shape, probs1)
采样函数。
**参数:**
参数:
- **shape** (tuple) - 样本的shape。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
- **shape** (tuple) - 样本的shape。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
返回:
Tensor根据概率分布采样的样本。
.. py:method:: sd(probs1)
计算标准差。
**参数:**
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
参数:
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor概率分布的标准差。
返回:
Tensor概率分布的标准差。
.. py:method:: survival_function(value, probs1)
计算给定值对应的生存函数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
- **value** (Tensor) - 要计算的值。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor生存函数的值。
返回:
Tensor生存函数的值。
.. py:method:: var(probs1)
计算方差。
**参数:**
参数:
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
- **probs1** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor概率分布的方差。
返回:
Tensor概率分布的方差。

View File

@ -11,232 +11,200 @@ 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。
- **dtype** (mindspore.dtype) - 采样结果的数据类型。默认值mstype.float32。
- **name** (str) - 分布的名称。默认值:'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。
- **dtype** (mindspore.dtype) - 采样结果的数据类型。默认值mstype.float32。
- **name** (str) - 分布的名称。默认值:'Beta'。
.. note::
- `concentration1``concentration0` 中元素必须大于零。
- `dtype` 必须是float因为 Beta 分布是连续的。
**异常:**
- **ValueError** - `concentration1` 或者 `concentration0` 中元素小于0。
- **TypeError** - `dtype` 不是float的子类。
异常:
- **ValueError** - `concentration1` 或者 `concentration0` 中元素小于0。
- **TypeError** - `dtype` 不是float的子类。
.. py:method:: concentration0
:property:
返回concentration0也称为 Beta 分布的 beta
**返回:**
Tensorconcentration0 的值。
返回:
Tensorconcentration0 的值。
.. py:method:: concentration1
:property:
返回concentration1也称为 Beta 分布的 alpha
**返回:**
Tensorconcentration1 的值。
返回:
Tensorconcentration1 的值。
.. py:method:: cdf(value, concentration1, concentration0)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
- **value** (Tensor) - 要计算的值。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor累积分布函数的值。
返回:
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。
- **dist** (str) - 分布的类型。
- **concentration1_b** (Tensor) - 对比 Beta 分布的 alpha。
- **concentration0_b** (Tensor) - 对比 Beta 分布的 beta。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor交叉熵的值。
返回:
Tensor交叉熵的值。
.. py:method:: entropy(concentration1, concentration0)
计算熵。
**参数:**
参数:
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor熵的值。
返回:
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。
- **dist** (str) - 分布的类型。
- **concentration1_b** (Tensor) - 对比 Beta 分布的 alpha。
- **concentration0_b** (Tensor) - 对比 Beta 分布的 beta。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
TensorKL散度。
返回:
TensorKL散度。
.. py:method:: log_cdf(value, concentration1, concentration0)
计算给定值对于的累积分布函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
- **value** (Tensor) - 要计算的值。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, concentration1, concentration0)
计算给定值对应的概率的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
- **value** (Tensor) - 要计算的值。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, concentration1, concentration0)
计算给定值对应的生存函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
- **value** (Tensor) - 要计算的值。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor生存函数的对数。
返回:
Tensor生存函数的对数。
.. py:method:: mean(concentration1, concentration0)
计算期望。
**参数:**
参数:
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor概率分布的期望。
返回:
Tensor概率分布的期望。
.. py:method:: mode(concentration1, concentration0)
计算众数。
**参数:**
参数:
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor概率分布的众数。
返回:
Tensor概率分布的众数。
.. py:method:: prob(value, concentration1, concentration0)
计算给定值下的概率。对于连续是计算概率密度函数Probability Density Function
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
- **value** (Tensor) - 要计算的值。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor概率值。
返回:
Tensor概率值。
.. py:method:: sample(shape, concentration1, concentration0)
采样函数。
**参数:**
参数:
- **shape** (tuple) - 样本的shape。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
- **shape** (tuple) - 样本的shape。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
返回:
Tensor根据概率分布采样的样本。
.. py:method:: sd(concentration1, concentration0)
计算标准差。
**参数:**
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
参数:
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor概率分布的标准差。
返回:
Tensor概率分布的标准差。
.. py:method:: survival_function(value, concentration1, concentration0)
计算给定值对应的生存函数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
- **value** (Tensor) - 要计算的值。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor生存函数的值。
返回:
Tensor生存函数的值。
.. py:method:: var(concentration1, concentration0)
计算方差。
**参数:**
参数:
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
- **concentration1** (Tensor) - Beta 分布的 alpha。默认值None。
- **concentration0** (Tensor) - Beta 分布的 beta。默认值None。
**返回:**
Tensor概率分布的方差。
返回:
Tensor概率分布的方差。

View File

@ -6,204 +6,173 @@ 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.
- **name** (str) - 分布的名称。默认值Categorical。
参数:
- **probs** (Tensor, list, numpy.ndarray) - 事件概率。默认值None。
- **seed** (int) - 采样时使用的种子。如果为None则使用全局种子。默认值None。
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值mstype.int32.
- **name** (str) - 分布的名称。默认值Categorical。
.. note::
`probs` 的秩必须至少为1值是合适的概率并且总和为1。
**异常:**
- **ValueError** - `probs` 的秩为0或者其中所有元素的和不等于1。
异常:
- **ValueError** - `probs` 的秩为0或者其中所有元素的和不等于1。
.. py:method:: probs
:property:
返回事件发生的概率。
**返回:**
Tensor事件发生的概率。
返回:
Tensor事件发生的概率。
.. py:method:: cdf(value, probs)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 事件发生的概率。默认值None。
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor累积分布函数的值。
返回:
Tensor累积分布函数的值。
.. py:method:: cross_entropy(dist, probs_b, probs)
计算分布a和b之间的交叉熵。
**参数:**
参数:
- **dist** (str) - 分布的类型。
- **probs_b** (Tensor) - 对比分布的事件发生的概率。
- **probs** (Tensor) - 事件发生的概率。默认值None。
- **dist** (str) - 分布的类型。
- **probs_b** (Tensor) - 对比分布的事件发生的概率。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor交叉熵的值。
返回:
Tensor交叉熵的值。
.. py:method:: entropy(probs)
计算熵。
**参数:**
参数:
- **probs** (Tensor) - 事件发生的概率。默认值None。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor熵的值。
返回:
Tensor熵的值。
.. py:method:: kl_loss(dist, probs_b, probs)
计算KL散度即KL(a||b)。
**参数:**
参数:
- **dist** (str) - 分布的类型。
- **probs_b** (Tensor) - 对比分布的事件发生的概率。
- **probs** (Tensor) - 事件发生的概率。默认值None。
- **dist** (str) - 分布的类型。
- **probs_b** (Tensor) - 对比分布的事件发生的概率。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
TensorKL散度。
返回:
TensorKL散度。
.. py:method:: log_cdf(value, probs)
计算给定值对于的累积分布函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 事件发生的概率。默认值None。
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, probs)
计算给定值对应的概率的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 事件发生的概率。默认值None。
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, probs)
计算给定值对应的生存函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 事件发生的概率。默认值None。
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor生存函数的对数。
返回:
Tensor生存函数的对数。
.. py:method:: mean(probs)
计算期望。
**参数:**
参数:
- **probs** (Tensor) - 事件发生的概率。默认值None。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor概率分布的期望。
返回:
Tensor概率分布的期望。
.. py:method:: mode(probs)
计算众数。
**参数:**
参数:
- **probs** (Tensor) - 事件发生的概率。默认值None。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor概率分布的众数。
返回:
Tensor概率分布的众数。
.. py:method:: prob(value, probs)
计算给定值下的概率。对于离散分布是计算概率质量函数Probability Mass Function
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 事件发生的概率。默认值None。
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor概率值。
返回:
Tensor概率值。
.. py:method:: sample(shape, probs)
采样函数。
**参数:**
参数:
- **shape** (tuple) - 样本的shape。
- **probs** (Tensor) - 事件发生的概率。默认值None。
- **shape** (tuple) - 样本的shape。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
返回:
Tensor根据概率分布采样的样本。
.. py:method:: sd(probs)
计算标准差。
**参数:**
- **probs** (Tensor) - 事件发生的概率。默认值None。
参数:
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor概率分布的标准差。
返回:
Tensor概率分布的标准差。
.. py:method:: survival_function(value, probs)
计算给定值对应的生存函数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 事件发生的概率。默认值None。
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor生存函数的值。
返回:
Tensor生存函数的值。
.. py:method:: var(probs)
计算方差。
**参数:**
参数:
- **probs** (Tensor) - 事件发生的概率。默认值None。
- **probs** (Tensor) - 事件发生的概率。默认值None。
**返回:**
Tensor概率分布的方差。
返回:
Tensor概率分布的方差。

View File

@ -11,233 +11,201 @@ 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。
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值mstype.float32。
- **name** (str) - 分布的名称。默认值:'Cauchy'。
参数:
- **loc** (int, float, list, numpy.ndarray, Tensor) - 柯西分布的位置。默认值None。
- **scale** (int, float, list, numpy.ndarray, Tensor) - 柯西分布的比例。默认值None。
- **seed** (int) - 采样时使用的种子。如果为None则使用全局种子。默认值None。
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值mstype.float32。
- **name** (str) - 分布的名称。默认值:'Cauchy'。
.. note::
- `scale` 中的元素必须大于零。
- `dtype` 必须是float因为柯西分布是连续的。
- GPU后端不支持柯西分布。
**异常:**
- **ValueError** - `scale` 中元素小于0。
- **TypeError** - `dtype` 不是float的子类。
异常:
- **ValueError** - `scale` 中元素小于0。
- **TypeError** - `dtype` 不是float的子类。
.. py:method:: loc
:property:
返回分布位置。
**返回:**
Tensor分布的位置值。
返回:
Tensor分布的位置值。
.. py:method:: scale
:property:
返回分布比例。
**返回:**
Tensor分布的比例值。
返回:
Tensor分布的比例值。
.. py:method:: cdf(value, loc, scale)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的值。
返回:
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。
- **dist** (str) - 分布的类型。
- **loc_b** (Tensor) - 对比分布位置参数。
- **scale_b** (Tensor) - 对比分布比例参数。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor交叉熵的值。
返回:
Tensor交叉熵的值。
.. py:method:: entropy(loc, scale)
计算熵。
**参数:**
参数:
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor熵的值。
返回:
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。
- **dist** (str) - 分布的类型。
- **loc_b** (Tensor) - 对比分布位置参数。
- **scale_b** (Tensor) - 对比分布比例参数。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
TensorKL散度。
返回:
TensorKL散度。
.. py:method:: log_cdf(value, loc, scale)
计算给定值对于的累积分布函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, loc, scale)
计算给定值对应的概率的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, loc, scale)
计算给定值对应的生存函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor生存函数的对数。
返回:
Tensor生存函数的对数。
.. py:method:: mean(loc, scale)
计算期望。
**参数:**
参数:
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的期望。
返回:
Tensor概率分布的期望。
.. py:method:: mode(loc, scale)
计算众数。
**参数:**
参数:
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的众数。
返回:
Tensor概率分布的众数。
.. py:method:: prob(value, loc, scale)
计算给定值下的概率。对于连续是计算概率密度函数Probability Density Function
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率值。
返回:
Tensor概率值。
.. py:method:: sample(shape, loc, scale)
采样函数。
**参数:**
参数:
- **shape** (tuple) - 样本的shape。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **shape** (tuple) - 样本的shape。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
返回:
Tensor根据概率分布采样的样本。
.. py:method:: sd(loc, scale)
计算标准差。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
参数:
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的标准差。
返回:
Tensor概率分布的标准差。
.. py:method:: survival_function(value, loc, scale)
计算给定值对应的生存函数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor生存函数的值。
返回:
Tensor生存函数的值。
.. py:method:: var(loc, scale)
计算方差。
**参数:**
参数:
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的方差。
返回:
Tensor概率分布的方差。

View File

@ -5,12 +5,11 @@ mindspore.nn.probability.distribution.Distribution
所有分布的基类。
**参数:**
- **seed** (int) - 采样时使用的种子。如果为None则使用0。
- **dtype** (mindspore.dtype) - 事件样例的类型。
- **name** (str) - 分布的名称。
- **param** (dict) - 用于初始化分布的参数。
参数:
- **seed** (int) - 采样时使用的种子。如果为None则使用0。
- **dtype** (mindspore.dtype) - 事件样例的类型。
- **name** (str) - 分布的名称。
- **param** (dict) - 用于初始化分布的参数。
.. note::
派生类必须重写 `_mean` 、 `_prob` 和 `_log_prob` 等操作。必填参数必须通过 `args` 或 `kwargs` 传入,如 `_prob` 的 `value` 。
@ -19,18 +18,16 @@ mindspore.nn.probability.distribution.Distribution
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
- **value** (Tensor) - 要计算的值。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
参数:
- **value** (Tensor) - 要计算的值。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
可以通过 `args``kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
**返回:**
Tensor累积分布函数的值。
返回:
Tensor累积分布函数的值。
.. py:method:: construct(name, *args, **kwargs)
@ -40,253 +37,222 @@ 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) - 函数所需的关键字参数字典。
- **name** (str) - 函数名称。
- **args** (list) - 函数所需的位置参数列表。
- **kwargs** (dict) - 函数所需的关键字参数字典。
**返回:**
Tensorname对应函数的值。
返回:
Tensorname对应函数的值。
.. py:method:: cross_entropy(dist, *args, **kwargs)
计算分布a和b之间的交叉熵。
**参数:**
- **dist** (str) - 分布的类型。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
参数:
- **dist** (str) - 分布的类型。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
Distribution b的 `dist_spec_args` 必须通过 `args``kwargs` 传递给函数。 传入Distribution a的 `dist_spec_args` 是可选的。
**返回:**
Tensor交叉熵的值。
返回:
Tensor交叉熵的值。
.. py:method:: entropy(*args, **kwargs)
计算熵。
**参数:**
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
参数:
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
可以通过 `args``kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
**返回:**
Tensor熵的值。
返回:
Tensor熵的值。
.. py:method:: get_dist_args(*args, **kwargs)
返回分布的参数列表。
**参数:**
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
参数:
- **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) - 关键字参数字典,具体需要的参数根据子类的实现确定。
参数:
- **dist** (str) - 分布的类型。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
Distribution b的 `dist_spec_args` 必须通过 `args``kwargs` 传递给函数。 传入Distribution a的 `dist_spec_args` 是可选的。
**返回:**
TensorKL散度。
返回:
TensorKL散度。
.. py:method:: log_cdf(value, *args, **kwargs)
计算给定值对于的累积分布函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
参数:
- **value** (Tensor) - 要计算的值。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
可以通过 `args``kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, *args, **kwargs)
计算给定值对应的概率的对数pdf或pmf
**参数:**
- **value** (Tensor) - 要计算的值。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
参数:
- **value** (Tensor) - 要计算的值。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
可以通过 `args``kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, *args, **kwargs)
计算给定值对应的生存函数的对数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
参数:
- **value** (Tensor) - 要计算的值。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
可以通过 `args``kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
**返回:**
Tensor生存函数的对数。
返回:
Tensor生存函数的对数。
.. py:method:: mean(*args, **kwargs)
计算期望。
**参数:**
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
参数:
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
可以通过 `args``kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
**返回:**
Tensor概率分布的期望。
返回:
Tensor概率分布的期望。
.. py:method:: mode(*args, **kwargs)
计算众数。
**参数:**
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
参数:
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
可以通过 `args``kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
**返回:**
Tensor概率分布的众数。
返回:
Tensor概率分布的众数。
.. py:method:: prob(value, *args, **kwargs)
计算给定值下的概率。对于离散分布是计算概率质量函数Probability Mass Function而对于连续分布是计算概率密度函数Probability Density Function
**参数:**
- **value** (Tensor) - 要计算的值。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
参数:
- **value** (Tensor) - 要计算的值。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
可以通过 `args``kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
**返回:**
Tensor概率值。
返回:
Tensor概率值。
.. py:method:: sample(*args, **kwargs)
采样函数。
**参数:**
- **shape** (tuple) - 样本的shape。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
参数:
- **shape** (tuple) - 样本的shape。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
可以通过 `args``kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
**返回:**
Tensor根据概率分布采样的样本。
返回:
Tensor根据概率分布采样的样本。
.. py:method:: sd(*args, **kwargs)
计算标准差。
**参数:**
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
参数:
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
可以通过 `args``kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
**返回:**
Tensor概率分布的标准差。
返回:
Tensor概率分布的标准差。
.. py:method:: survival_function(value, *args, **kwargs)
计算给定值对应的生存函数。
**参数:**
- **value** (Tensor) - 要计算的值。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
参数:
- **value** (Tensor) - 要计算的值。
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
可以通过 `args``kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
**返回:**
Tensor生存函数的值。
返回:
Tensor生存函数的值。
.. py:method:: var(*args, **kwargs)
计算方差。
**参数:**
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
参数:
- **args** (list) - 位置参数列表,具体需要的参数根据子类的实现确定。
- **kwargs** (dict) - 关键字参数字典,具体需要的参数根据子类的实现确定。
.. note::
可以通过 `args``kwargs` 传递其 `dist_spec_args` 来选择性地将Distribution传递给函数。
**返回:**
Tensor概率分布的方差。
返回:
Tensor概率分布的方差。

View File

@ -11,206 +11,175 @@ mindspore.nn.probability.distribution.Exponential
其中 :math:`\lambda` 为分别为指数分布的率参数。
**参数:**
- **rate** (int, float, list, numpy.ndarray, Tensor) - 率参数。默认值None。
- **seed** (int) - 采样时使用的种子。如果为None则使用全局种子。默认值None。
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值mstype.float32。
- **name** (str) - 分布的名称。默认值:'Exponential'。
参数:
- **rate** (int, float, list, numpy.ndarray, Tensor) - 率参数。默认值None。
- **seed** (int) - 采样时使用的种子。如果为None则使用全局种子。默认值None。
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值mstype.float32。
- **name** (str) - 分布的名称。默认值:'Exponential'。
.. note::
- `rate` 中的元素必须大于0。
- `dtype` 必须是float因为指数分布是连续的。
**异常:**
- **ValueError** - `rate` 中元素小于0。
- **TypeError** - `dtype` 不是float的子类。
异常:
- **ValueError** - `rate` 中元素小于0。
- **TypeError** - `dtype` 不是float的子类。
.. py:method:: rate
:property:
返回 `rate`
**返回:**
Tensor率参数的值。
返回:
Tensor率参数的值。
.. py:method:: cdf(value, rate)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 分布的率参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor累积分布函数的值。
返回:
Tensor累积分布函数的值。
.. py:method:: cross_entropy(dist, rate_b, rate)
计算分布a和b之间的交叉熵。
**参数:**
参数:
- **dist** (str) - 分布的类型。
- **rate_b** (Tensor) - 对比分布的率参数。
- **rate** (Tensor) - 分布的率参数。默认值None。
- **dist** (str) - 分布的类型。
- **rate_b** (Tensor) - 对比分布的率参数。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor交叉熵的值。
返回:
Tensor交叉熵的值。
.. py:method:: entropy(rate)
计算熵。
**参数:**
参数:
- **rate** (Tensor) - 分布的率参数。默认值None。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor熵的值。
返回:
Tensor熵的值。
.. py:method:: kl_loss(dist, rate_b, rate)
计算KL散度即KL(a||b)。
**参数:**
参数:
- **dist** (str) - 分布的类型。
- **rate_b** (Tensor) - 对比分布的率参数。
- **rate** (Tensor) - 分布的率参数。默认值None。
- **dist** (str) - 分布的类型。
- **rate_b** (Tensor) - 对比分布的率参数。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
TensorKL散度。
返回:
TensorKL散度。
.. py:method:: log_cdf(value, rate)
计算给定值对于的累积分布函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 分布的率参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, rate)
计算给定值对应的概率的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 分布的率参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, rate)
计算给定值对应的生存函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 分布的率参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor生存函数的对数。
返回:
Tensor生存函数的对数。
.. py:method:: mean(rate)
计算期望。
**参数:**
参数:
- **rate** (Tensor) - 分布的率参数。默认值None。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor概率分布的期望。
返回:
Tensor概率分布的期望。
.. py:method:: mode(rate)
计算众数。
**参数:**
参数:
- **rate** (Tensor) - 分布的率参数。默认值None。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor概率分布的众数。
返回:
Tensor概率分布的众数。
.. py:method:: prob(value, rate)
计算给定值下的概率。对于连续是计算概率密度函数Probability Density Function
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 分布的率参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor概率值。
返回:
Tensor概率值。
.. py:method:: sample(shape, rate)
采样函数。
**参数:**
参数:
- **shape** (tuple) - 样本的shape。
- **rate** (Tensor) - 分布的率参数。默认值None。
- **shape** (tuple) - 样本的shape。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
返回:
Tensor根据概率分布采样的样本。
.. py:method:: sd(rate)
计算标准差。
**参数:**
- **rate** (Tensor) - 分布的率参数。默认值None。
参数:
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor概率分布的标准差。
返回:
Tensor概率分布的标准差。
.. py:method:: survival_function(value, rate)
计算给定值对应的生存函数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 分布的率参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor生存函数的值。
返回:
Tensor生存函数的值。
.. py:method:: var(rate)
计算方差。
**参数:**
参数:
- **rate** (Tensor) - 分布的率参数。默认值None。
- **rate** (Tensor) - 分布的率参数。默认值None。
**返回:**
Tensor概率分布的方差。
返回:
Tensor概率分布的方差。

View File

@ -11,232 +11,200 @@ 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。
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值mstype.float32。
- **name** (str) - 分布的名称。默认值:'Gamma'。
参数:
- **concentration** (int, float, list, numpy.ndarray, Tensor) - 浓度也被称为伽马分布的alpha。默认值None。
- **rate** (int, float, list, numpy.ndarray, Tensor) - 逆尺度参数也被称为伽马分布的beta。默认值None。
- **seed** (int) - 采样时使用的种子。如果为None则使用全局种子。默认值None。
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值mstype.float32。
- **name** (str) - 分布的名称。默认值:'Gamma'。
.. note::
- `concentration``rate` 中的元素必须大于零。
- `dtype` 必须是float因为伽马分布是连续的。
**异常:**
- **ValueError** - `concentration` 或者 `rate` 中元素小于0。
- **TypeError** - `dtype` 不是float的子类。
异常:
- **ValueError** - `concentration` 或者 `rate` 中元素小于0。
- **TypeError** - `dtype` 不是float的子类。
.. py:method:: concentration
:property:
返回分布的浓度也称为伽马分布的alpha
**返回:**
Tensorconcentration 的值。
返回:
Tensorconcentration 的值。
.. py:method:: rate
:property:
返回分布的逆尺度也称为伽马分布的beta
**返回:**
Tensorrate 的值。
返回:
Tensorrate 的值。
.. py:method:: cdf(value, concentration, rate)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
- **value** (Tensor) - 要计算的值。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor累积分布函数的值。
返回:
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。
- **dist** (str) - 分布的类型。
- **concentration_b** (Tensor) - 对比分布的alpha。
- **rate_b** (Tensor) - 对比分布的beta。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor交叉熵的值。
返回:
Tensor交叉熵的值。
.. py:method:: entropy(concentration, rate)
计算熵。
**参数:**
参数:
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor熵的值。
返回:
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。
- **dist** (str) - 分布的类型。
- **concentration_b** (Tensor) - 对比分布的alpha。
- **rate_b** (Tensor) - 对比分布的beta。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
TensorKL散度。
返回:
TensorKL散度。
.. py:method:: log_cdf(value, concentration, rate)
计算给定值对于的累积分布函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
- **value** (Tensor) - 要计算的值。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, concentration, rate)
计算给定值对应的概率的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
- **value** (Tensor) - 要计算的值。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, concentration, rate)
计算给定值对应的生存函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
- **value** (Tensor) - 要计算的值。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor生存函数的对数。
返回:
Tensor生存函数的对数。
.. py:method:: mean(concentration, rate)
计算期望。
**参数:**
参数:
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor概率分布的期望。
返回:
Tensor概率分布的期望。
.. py:method:: mode(concentration, rate)
计算众数。
**参数:**
参数:
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor概率分布的众数。
返回:
Tensor概率分布的众数。
.. py:method:: prob(value, concentration, rate)
计算给定值下的概率。对于连续是计算概率密度函数Probability Density Function
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
- **value** (Tensor) - 要计算的值。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor概率值。
返回:
Tensor概率值。
.. py:method:: sample(shape, concentration, rate)
采样函数。
**参数:**
参数:
- **shape** (tuple) - 样本的shape。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
- **shape** (tuple) - 样本的shape。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
返回:
Tensor根据概率分布采样的样本。
.. py:method:: sd(concentration, rate)
计算标准差。
**参数:**
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
参数:
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor概率分布的标准差。
返回:
Tensor概率分布的标准差。
.. py:method:: survival_function(value, concentration, rate)
计算给定值对应的生存函数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
- **value** (Tensor) - 要计算的值。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor生存函数的值。
返回:
Tensor生存函数的值。
.. py:method:: var(concentration, rate)
计算方差。
**参数:**
参数:
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
- **concentration** (Tensor) - 分布的alpha。默认值None。
- **rate** (Tensor) - 分布的beta。默认值None。
**返回:**
Tensor概率分布的方差。
返回:
Tensor概率分布的方差。

View File

@ -8,205 +8,174 @@ 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.
- **name** (str) - 分布的名称。默认值:'Geometric'。
参数:
- **probs** (int, float, list, numpy.ndarray, Tensor) - 成功的概率。默认值None。
- **seed** (int) - 采样时使用的种子。如果为None则使用全局种子。默认值None。
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值mstype.int32.
- **name** (str) - 分布的名称。默认值:'Geometric'。
.. note::
`probs` 必须是合适的概率0<p<1
**异常:**
- **ValueError** - `probs` 中元素小于0或者大于1。
异常:
- **ValueError** - `probs` 中元素小于0或者大于1。
.. py:method:: probs
:property:
返回伯努利试验成功的概率。
**返回:**
Tensor伯努利试验成功的概率值。
返回:
Tensor伯努利试验成功的概率值。
.. py:method:: cdf(value, probs)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor累积分布函数的值。
返回:
Tensor累积分布函数的值。
.. py:method:: cross_entropy(dist, probs_b, probs)
计算分布a和b之间的交叉熵。
**参数:**
参数:
- **dist** (str) - 分布的类型。
- **probs_b** (Tensor) - 对比分布的伯努利实验成功的概率。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
- **dist** (str) - 分布的类型。
- **probs_b** (Tensor) - 对比分布的伯努利实验成功的概率。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor交叉熵的值。
返回:
Tensor交叉熵的值。
.. py:method:: entropy(probs)
计算熵。
**参数:**
参数:
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor熵的值。
返回:
Tensor熵的值。
.. py:method:: kl_loss(dist, probs_b, probs)
计算KL散度即KL(a||b)。
**参数:**
参数:
- **dist** (str) - 分布的类型。
- **probs_b** (Tensor) - 对比分布的伯努利实验成功的概率。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
- **dist** (str) - 分布的类型。
- **probs_b** (Tensor) - 对比分布的伯努利实验成功的概率。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
TensorKL散度。
返回:
TensorKL散度。
.. py:method:: log_cdf(value, probs)
计算给定值对于的累积分布函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, probs)
计算给定值对应的概率的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, probs)
计算给定值对应的生存函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor生存函数的对数。
返回:
Tensor生存函数的对数。
.. py:method:: mean(probs)
计算期望。
**参数:**
参数:
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor概率分布的期望。
返回:
Tensor概率分布的期望。
.. py:method:: mode(probs)
计算众数。
**参数:**
参数:
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor概率分布的众数。
返回:
Tensor概率分布的众数。
.. py:method:: prob(value, probs)
计算给定值下的概率。对于离散分布是计算概率质量函数Probability Mass Function
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor概率值。
返回:
Tensor概率值。
.. py:method:: sample(shape, probs)
采样函数。
**参数:**
参数:
- **shape** (tuple) - 样本的shape。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
- **shape** (tuple) - 样本的shape。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
返回:
Tensor根据概率分布采样的样本。
.. py:method:: sd(probs)
计算标准差。
**参数:**
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
参数:
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor概率分布的标准差。
返回:
Tensor概率分布的标准差。
.. py:method:: survival_function(value, probs)
计算给定值对应的生存函数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
- **value** (Tensor) - 要计算的值。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor生存函数的值。
返回:
Tensor生存函数的值。
.. py:method:: var(probs)
计算方差。
**参数:**
参数:
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
- **probs** (Tensor) - 伯努利实验成功的概率。默认值None。
**返回:**
Tensor概率分布的方差。
返回:
Tensor概率分布的方差。

View File

@ -11,233 +11,201 @@ 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。
- **dtype** (mindspore.dtype) - 分布类型。默认值mstype.float32。
- **name** (str) - 分布的名称。默认值:'Gumbel'。
参数:
- **loc** (int, float, list, numpy.ndarray, Tensor) - Gumbel分布的位置。
- **scale** (int, float, list, numpy.ndarray, Tensor) - Gumbel分布的尺度。
- **seed** (int) - 采样时使用的种子。如果为None则使用全局种子。默认值0。
- **dtype** (mindspore.dtype) - 分布类型。默认值mstype.float32。
- **name** (str) - 分布的名称。默认值:'Gumbel'。
.. note::
- `scale` 必须大于零。
- `dtype` 必须是浮点类型因为Gumbel分布是连续的。
- GPU后端不支持 `kl_loss``cross_entropy`
**异常:**
- **ValueError** - `scale` 中元素小于0。
- **TypeError** - `dtype` 不是float的子类。
异常:
- **ValueError** - `scale` 中元素小于0。
- **TypeError** - `dtype` 不是float的子类。
.. py:method:: loc
:property:
返回分布位置。
**返回:**
Tensor分布的位置值。
返回:
Tensor分布的位置值。
.. py:method:: scale
:property:
返回分布比例。
**返回:**
Tensor分布的比例值。
返回:
Tensor分布的比例值。
.. py:method:: cdf(value, loc, scale)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的值。
返回:
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。
- **dist** (str) - 分布的类型。
- **loc_b** (Tensor) - 对比分布位置参数。
- **scale_b** (Tensor) - 对比分布比例参数。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor交叉熵的值。
返回:
Tensor交叉熵的值。
.. py:method:: entropy(loc, scale)
计算熵。
**参数:**
参数:
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor熵的值。
返回:
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。
- **dist** (str) - 分布的类型。
- **loc_b** (Tensor) - 对比分布位置参数。
- **scale_b** (Tensor) - 对比分布比例参数。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
TensorKL散度。
返回:
TensorKL散度。
.. py:method:: log_cdf(value, loc, scale)
计算给定值对于的累积分布函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, loc, scale)
计算给定值对应的概率的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, loc, scale)
计算给定值对应的生存函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor生存函数的对数。
返回:
Tensor生存函数的对数。
.. py:method:: mean(loc, scale)
计算期望。
**参数:**
参数:
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的期望。
返回:
Tensor概率分布的期望。
.. py:method:: mode(loc, scale)
计算众数。
**参数:**
参数:
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的众数。
返回:
Tensor概率分布的众数。
.. py:method:: prob(value, loc, scale)
计算给定值下的概率。对于连续是计算概率密度函数Probability Density Function
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率值。
返回:
Tensor概率值。
.. py:method:: sample(shape, loc, scale)
采样函数。
**参数:**
参数:
- **shape** (tuple) - 样本的shape。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **shape** (tuple) - 样本的shape。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
返回:
Tensor根据概率分布采样的样本。
.. py:method:: sd(loc, scale)
计算标准差。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
参数:
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的标准差。
返回:
Tensor概率分布的标准差。
.. py:method:: survival_function(value, loc, scale)
计算给定值对应的生存函数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor生存函数的值。
返回:
Tensor生存函数的值。
.. py:method:: var(loc, scale)
计算方差。
**参数:**
参数:
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的方差。
返回:
Tensor概率分布的方差。

View File

@ -12,232 +12,200 @@ 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。
- **dtype** (mindspore.dtype) - 分布类型。默认值mstype.float32。
- **name** (str) - 分布的名称。默认值:'LogNormal'。
参数:
- **loc** (int, float, list, numpy.ndarray, Tensor) - 基础正态分布的平均值。默认值None。
- **scale** (int, float, list, numpy.ndarray, Tensor) - 基础正态分布的标准差。默认值None。
- **seed** (int) - 采样时使用的种子。如果为None则使用全局种子。默认值0。
- **dtype** (mindspore.dtype) - 分布类型。默认值mstype.float32。
- **name** (str) - 分布的名称。默认值:'LogNormal'。
.. note::
- `scale` 必须大于零。
- `dtype` 必须是float因为对数正态分布是连续的。
**异常:**
- **ValueError** - `scale` 中元素小于0。
- **TypeError** - `dtype` 不是float的子类。
异常:
- **ValueError** - `scale` 中元素小于0。
- **TypeError** - `dtype` 不是float的子类。
.. py:method:: loc
:property:
返回分布位置。
**返回:**
Tensor分布的位置值。
返回:
Tensor分布的位置值。
.. py:method:: scale
:property:
返回分布比例。
**返回:**
Tensor分布的比例值。
返回:
Tensor分布的比例值。
.. py:method:: cdf(value, loc, scale)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的值。
返回:
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。
- **dist** (str) - 分布的类型。
- **loc_b** (Tensor) - 对比分布位置参数。
- **scale_b** (Tensor) - 对比分布比例参数。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor交叉熵的值。
返回:
Tensor交叉熵的值。
.. py:method:: entropy(loc, scale)
计算熵。
**参数:**
参数:
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor熵的值。
返回:
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。
- **dist** (str) - 分布的类型。
- **loc_b** (Tensor) - 对比分布位置参数。
- **scale_b** (Tensor) - 对比分布比例参数。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
TensorKL散度。
返回:
TensorKL散度。
.. py:method:: log_cdf(value, loc, scale)
计算给定值对于的累积分布函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, loc, scale)
计算给定值对应的概率的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, loc, scale)
计算给定值对应的生存函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor生存函数的对数。
返回:
Tensor生存函数的对数。
.. py:method:: mean(loc, scale)
计算期望。
**参数:**
参数:
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的期望。
返回:
Tensor概率分布的期望。
.. py:method:: mode(loc, scale)
计算众数。
**参数:**
参数:
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的众数。
返回:
Tensor概率分布的众数。
.. py:method:: prob(value, loc, scale)
计算给定值下的概率。对于连续是计算概率密度函数Probability Density Function
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率值。
返回:
Tensor概率值。
.. py:method:: sample(shape, loc, scale)
采样函数。
**参数:**
参数:
- **shape** (tuple) - 样本的shape。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **shape** (tuple) - 样本的shape。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
返回:
Tensor根据概率分布采样的样本。
.. py:method:: sd(loc, scale)
计算标准差。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
参数:
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的标准差。
返回:
Tensor概率分布的标准差。
.. py:method:: survival_function(value, loc, scale)
计算给定值对应的生存函数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor生存函数的值。
返回:
Tensor生存函数的值。
.. py:method:: var(loc, scale)
计算方差。
**参数:**
参数:
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的方差。
返回:
Tensor概率分布的方差。

View File

@ -11,232 +11,200 @@ 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。
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值mstype.float32。
- **name** (str) - 分布的名称。默认值:'Logistic'。
参数:
- **loc** (int, float, list, numpy.ndarray, Tensor) - Logistic分布的位置。默认值None。
- **scale** (int, float, list, numpy.ndarray, Tensor) - Logistic分布的尺度。默认值None。
- **seed** (int) - 采样时使用的种子。如果为None则使用全局种子。默认值None。
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值mstype.float32。
- **name** (str) - 分布的名称。默认值:'Logistic'。
.. note::
- `scale` 必须大于零。
- `dtype` 必须是float因为Logistic分布是连续的。
**异常:**
- **ValueError** - `scale` 中元素小于0。
- **TypeError** - `dtype` 不是float的子类。
异常:
- **ValueError** - `scale` 中元素小于0。
- **TypeError** - `dtype` 不是float的子类。
.. py:method:: loc
:property:
返回分布位置。
**返回:**
Tensor分布的位置值。
返回:
Tensor分布的位置值。
.. py:method:: scale
:property:
返回分布比例。
**返回:**
Tensor分布的比例值。
返回:
Tensor分布的比例值。
.. py:method:: cdf(value, loc, scale)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的值。
返回:
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。
- **dist** (str) - 分布的类型。
- **loc_b** (Tensor) - 对比分布位置参数。
- **scale_b** (Tensor) - 对比分布比例参数。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor交叉熵的值。
返回:
Tensor交叉熵的值。
.. py:method:: entropy(loc, scale)
计算熵。
**参数:**
参数:
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor熵的值。
返回:
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。
- **dist** (str) - 分布的类型。
- **loc_b** (Tensor) - 对比分布位置参数。
- **scale_b** (Tensor) - 对比分布比例参数。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
TensorKL散度。
返回:
TensorKL散度。
.. py:method:: log_cdf(value, loc, scale)
计算给定值对于的累积分布函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, loc, scale)
计算给定值对应的概率的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, loc, scale)
计算给定值对应的生存函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor生存函数的对数。
返回:
Tensor生存函数的对数。
.. py:method:: mean(loc, scale)
计算期望。
**参数:**
参数:
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的期望。
返回:
Tensor概率分布的期望。
.. py:method:: mode(loc, scale)
计算众数。
**参数:**
参数:
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的众数。
返回:
Tensor概率分布的众数。
.. py:method:: prob(value, loc, scale)
计算给定值下的概率。对于连续是计算概率密度函数Probability Density Function
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率值。
返回:
Tensor概率值。
.. py:method:: sample(shape, loc, scale)
采样函数。
**参数:**
参数:
- **shape** (tuple) - 样本的shape。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **shape** (tuple) - 样本的shape。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
返回:
Tensor根据概率分布采样的样本。
.. py:method:: sd(loc, scale)
计算标准差。
**参数:**
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
参数:
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的标准差。
返回:
Tensor概率分布的标准差。
.. py:method:: survival_function(value, loc, scale)
计算给定值对应的生存函数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **value** (Tensor) - 要计算的值。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor生存函数的值。
返回:
Tensor生存函数的值。
.. py:method:: var(loc, scale)
计算方差。
**参数:**
参数:
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
- **loc** (Tensor) - 分布位置参数。默认值None。
- **scale** (Tensor) - 分布比例参数。默认值None。
**返回:**
Tensor概率分布的方差。
返回:
Tensor概率分布的方差。

View File

@ -11,206 +11,178 @@ 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。
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值mstype.float32。
- **name** (str) - 分布的名称。默认值:'Normal'。
参数:
- **mean** (int, float, list, numpy.ndarray, Tensor) - 正态分布的平均值。默认值None。
- **sd** (int, float, list, numpy.ndarray, Tensor) - 正态分布的标准差。默认值None。
- **seed** (int) - 采样时使用的种子。如果为None则使用全局种子。默认值None。
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值mstype.float32。
- **name** (str) - 分布的名称。默认值:'Normal'。
.. note::
- `sd` 必须大于零。
- `dtype` 必须是float因为正态分布是连续的。
**异常:**
- **ValueError** - `sd` 中元素小于0。
- **TypeError** - `dtype` 不是float的子类。
异常:
- **ValueError** - `sd` 中元素小于0。
- **TypeError** - `dtype` 不是float的子类。
.. py:method:: mean
:property:
返回分布期望。
**返回:**
Tensor分布的期望。
返回:
Tensor分布的期望。
.. py:method:: sd
:property:
返回分布的标准差。
**返回:**
Tensor分布的标准差。
返回:
Tensor分布的标准差。
.. py:method:: cdf(value, mean, sd)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
- **value** (Tensor) - 要计算的值。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor累积分布函数的值。
返回:
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。
- **dist** (str) - 分布的类型。
- **mean_b** (Tensor) - 对比分布的期望。
- **sd_b** (Tensor) - 对比分布的标准差。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor交叉熵的值。
返回:
Tensor交叉熵的值。
.. py:method:: entropy(mean, sd)
计算熵。
**参数:**
参数:
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor熵的值。
返回:
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。
- **dist** (str) - 分布的类型。
- **mean_b** (Tensor) - 对比分布的期望。
- **sd_b** (Tensor) - 对比分布的标准差。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
TensorKL散度。
返回:
TensorKL散度。
.. py:method:: log_cdf(value, mean, sd)
计算给定值对于的累积分布函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
- **value** (Tensor) - 要计算的值。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, mean, sd)
计算给定值对应的概率的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
- **value** (Tensor) - 要计算的值。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, mean, sd)
计算给定值对应的生存函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
- **value** (Tensor) - 要计算的值。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor生存函数的对数。
返回:
Tensor生存函数的对数。
.. py:method:: mode(mean, sd)
计算众数。
**参数:**
参数:
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor概率分布的众数。
返回:
Tensor概率分布的众数。
.. py:method:: prob(value, mean, sd)
计算给定值下的概率。对于连续是计算概率密度函数Probability Density Function
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
- **value** (Tensor) - 要计算的值。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor概率值。
返回:
Tensor概率值。
.. py:method:: sample(shape, mean, sd)
采样函数。
**参数:**
参数:
- **shape** (tuple) - 样本的shape。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
- **shape** (tuple) - 样本的shape。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
返回:
Tensor根据概率分布采样的样本。
.. py:method:: survival_function(value, mean, sd)
计算给定值对应的生存函数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
- **value** (Tensor) - 要计算的值。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor生存函数的值。
返回:
Tensor生存函数的值。
.. py:method:: var(mean, sd)
计算方差。
**参数:**
参数:
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
- **mean** (Tensor) - 分布的期望。默认值None。
- **sd** (Tensor) - 分布的标准差。默认值None。
**返回:**
Tensor概率分布的方差。
返回:
Tensor概率分布的方差。

View File

@ -11,165 +11,139 @@ 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。
- **name** (str) - 分布的名称。默认值:'Poisson'。
参数:
- **rate** (int, float, list, numpy.ndarray, Tensor) - 泊松分布的率参数。默认值None。
- **seed** (int) - 采样时使用的种子。如果为None则使用全局种子。默认值None。
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值mstype.float32。
- **name** (str) - 分布的名称。默认值:'Poisson'。
.. note::
`rate` 必须大于0。
**异常:**
- **ValueError** - `rate` 中元素小于0。
异常:
- **ValueError** - `rate` 中元素小于0。
.. py:method:: rate
:property:
返回分布的 `rate` 参数。
**返回:**
Tensorrate 参数的值。
返回:
Tensorrate 参数的值。
.. py:method:: cdf(value, rate)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 率参数(rate)。默认值None。
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor累积分布函数的值。
返回:
Tensor累积分布函数的值。
.. py:method:: log_cdf(value, rate)
计算给定值对于的累积分布函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 率参数(rate)。默认值None。
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, rate)
计算给定值对应的概率的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 率参数(rate)。默认值None。
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, rate)
计算给定值对应的生存函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 率参数(rate)。默认值None。
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor生存函数的对数。
返回:
Tensor生存函数的对数。
.. py:method:: mean(rate)
计算期望。
**参数:**
参数:
- **rate** (Tensor) - 率参数(rate)。默认值None。
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor概率分布的期望。
返回:
Tensor概率分布的期望。
.. py:method:: mode(rate)
计算众数。
**参数:**
参数:
- **rate** (Tensor) - 率参数(rate)。默认值None。
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor概率分布的众数。
返回:
Tensor概率分布的众数。
.. py:method:: prob(value, rate)
计算给定值下的概率。对于离散分布是计算概率质量函数Probability Mass Function
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 率参数(rate)。默认值None。
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor概率值。
返回:
Tensor概率值。
.. py:method:: sample(shape, rate)
采样函数。
**参数:**
参数:
- **shape** (tuple) - 样本的shape。
- **rate** (Tensor) - 率参数(rate)。默认值None。
- **shape** (tuple) - 样本的shape。
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
返回:
Tensor根据概率分布采样的样本。
.. py:method:: sd(rate)
计算标准差。
**参数:**
- **rate** (Tensor) - 率参数(rate)。默认值None。
参数:
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor概率分布的标准差。
返回:
Tensor概率分布的标准差。
.. py:method:: survival_function(value, rate)
计算给定值对应的生存函数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 率参数(rate)。默认值None。
- **value** (Tensor) - 要计算的值。
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor生存函数的值。
返回:
Tensor生存函数的值。
.. py:method:: var(rate)
计算方差。
**参数:**
参数:
- **rate** (Tensor) - 率参数(rate)。默认值None。
- **rate** (Tensor) - 率参数(rate)。默认值None。
**返回:**
Tensor概率分布的方差。
返回:
Tensor概率分布的方差。

View File

@ -7,145 +7,124 @@ 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对象时给出了此种子则对象的采样函数将使用此种子否则将使用基础分布的种子。
- **name** (str) - 转换分布的名称。默认值:'transformed_distribution'。
参数:
- **bijector** (Bijector) - 要执行的转换。
- **distribution** (Distribution) - 原始分布。必须具有float数据类型。
- **seed** (int) - 采样时使用的种子。如果为None则使用全局种子。默认值None。如果在初始化TransformedDistribution对象时给出了此种子则对象的采样函数将使用此种子否则将使用基础分布的种子。
- **name** (str) - 转换分布的名称。默认值:'transformed_distribution'。
.. note::
用于初始化原始分布的参数不能为None。例如由于未指定 `mean``sd` 因此无法使用mynormal = msd.Normal(dtype=mindspore.float32)初始化TransformedDistribution。
**异常:**
- **TypeError** - bijector不是Bijector类。
- **TypeError** - distribution不是Distribution类。
异常:
- **TypeError** - bijector不是Bijector类。
- **TypeError** - distribution不是Distribution类。
.. py:method:: bijector
:property:
返回概率映射函数。
**返回:**
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) - 要计算的值。
- **value** (Tensor) - 要计算的值。
**返回:**
Tensor累积分布函数的值。
返回:
Tensor累积分布函数的值。
.. py:method:: log_cdf(value)
计算给定值对于的累积分布函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **value** (Tensor) - 要计算的值。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_prob(value)
计算给定值对应的概率的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **value** (Tensor) - 要计算的值。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_survival(value)
计算给定值对应的生存函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **value** (Tensor) - 要计算的值。
**返回:**
Tensor生存函数的对数。
返回:
Tensor生存函数的对数。
.. py:method:: mean
计算期望。
**返回:**
Tensor概率分布的期望。
返回:
Tensor概率分布的期望。
.. py:method:: prob(value)
计算给定值下的概率。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **value** (Tensor) - 要计算的值。
**返回:**
Tensor概率值。
返回:
Tensor概率值。
.. py:method:: sample(shape)
采样函数。
**参数:**
参数:
- **shape** (tuple) - 样本的shape。
- **shape** (tuple) - 样本的shape。
**返回:**
Tensor根据概率分布采样的样本。
返回:
Tensor根据概率分布采样的样本。
.. py:method:: survival_function(value)
计算给定值对应的生存函数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **value** (Tensor) - 要计算的值。
**返回:**
Tensor生存函数的值。
返回:
Tensor生存函数的值。

View File

@ -11,233 +11,201 @@ 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。
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值mstype.float32。
- **name** (str) - 分布的名称。默认值:'Uniform'。
参数:
- **low** (int, float, list, numpy.ndarray, Tensor) - 分布的下限。默认值None。
- **high** (int, float, list, numpy.ndarray, Tensor) - 分布的上限。默认值None。
- **seed** (int) - 采样时使用的种子。如果为None则使用全局种子。默认值None。
- **dtype** (mindspore.dtype) - 事件样例的类型。默认值mstype.float32。
- **name** (str) - 分布的名称。默认值:'Uniform'。
.. note::
- `low` 必须小于 `high`
- `dtype` 必须是float类型因为均匀分布是连续的。
**异常:**
- **ValueError** - `low` 大于等于 `high`
- **TypeError** - `dtype` 不是float的子类。
异常:
- **ValueError** - `low` 大于等于 `high`
- **TypeError** - `dtype` 不是float的子类。
.. py:method:: high
:property:
返回分布的上限。
**返回:**
Tensor分布的上限值。
返回:
Tensor分布的上限值。
.. py:method:: low
:property:
返回分布的下限。
**返回:**
Tensor分布的下限值。
返回:
Tensor分布的下限值。
.. py:method:: cdf(value, high, low)
在给定值下计算累积分布函数Cumulatuve Distribution Function, CDF
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
- **value** (Tensor) - 要计算的值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor累积分布函数的值。
返回:
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。
- **dist** (str) - 分布的类型。
- **high_b** (Tensor) - 对比分布的上限值。
- **low_b** (Tensor) - 对比分布的下限值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor交叉熵的值。
返回:
Tensor交叉熵的值。
.. py:method:: entropy(high, low)
计算熵。
**参数:**
参数:
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor熵的值。
返回:
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。
- **dist** (str) - 分布的类型。
- **high_b** (Tensor) - 对比分布的上限值。
- **low_b** (Tensor) - 对比分布的下限值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
TensorKL散度。
返回:
TensorKL散度。
.. py:method:: log_cdf(value, high, low)
计算给定值对于的累积分布函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
- **value** (Tensor) - 要计算的值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_prob(value, high, low)
计算给定值对应的概率的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
- **value** (Tensor) - 要计算的值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor累积分布函数的对数。
返回:
Tensor累积分布函数的对数。
.. py:method:: log_survival(value, high, low)
计算给定值对应的生存函数的对数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
- **value** (Tensor) - 要计算的值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor生存函数的对数。
返回:
Tensor生存函数的对数。
.. py:method:: mean(high, low)
计算期望。
**参数:**
参数:
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor概率分布的期望。
返回:
Tensor概率分布的期望。
.. py:method:: mode(high, low)
计算众数。
**参数:**
参数:
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor概率分布的众数。
返回:
Tensor概率分布的众数。
.. py:method:: prob(value, high, low)
计算给定值下的概率。对于连续是计算概率密度函数Probability Density Function
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
- **value** (Tensor) - 要计算的值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor概率值。
返回:
Tensor概率值。
.. py:method:: sample(shape, high, low)
采样函数。
**参数:**
参数:
- **shape** (tuple) - 样本的shape。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
- **shape** (tuple) - 样本的shape。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor根据概率分布采样的样本。
返回:
Tensor根据概率分布采样的样本。
.. py:method:: sd(high, low)
计算标准差。
**参数:**
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
参数:
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor概率分布的标准差。
返回:
Tensor概率分布的标准差。
.. py:method:: survival_function(value, high, low)
计算给定值对应的生存函数。
**参数:**
参数:
- **value** (Tensor) - 要计算的值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
- **value** (Tensor) - 要计算的值。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor生存函数的值。
返回:
Tensor生存函数的值。
.. py:method:: var(high, low)
计算方差。
**参数:**
参数:
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
- **high** (Tensor) - 分布的上限值。默认值None。
- **low** (Tensor) - 分布的下限值。默认值None。
**返回:**
Tensor概率分布的方差。
返回:
Tensor概率分布的方差。