提交 bc1d0d86 authored 作者: Nicolas Bouchard's avatar Nicolas Bouchard 提交者: Frederic

Docstrings of Binomial.

上级 075ece1e
...@@ -42,17 +42,23 @@ class Binomial(gof.op.Op): ...@@ -42,17 +42,23 @@ class Binomial(gof.op.Op):
# facts, this does not follow a binomial distribution at all. # facts, this does not follow a binomial distribution at all.
# To see it, just try with p = 1. # To see it, just try with p = 1.
# """Return a sparse matrix having random values from a binomial """Return a sparse matrix having random values from a binomial
# density having number of experiment `n` and probability of succes density having number of experiment `n` and probability of succes
# `p`. `p`.
# :param n: Tensor scalar representing the number of experiment. .. warning::
# :param p: Tensor scalar representing the probability of success.
# :param shape: Tensor vector for the output shape.
# :return: A sparse matrix of integers representing the number For now, this op does not return a true binomial
# of success. distribution. It is a random disposition of ones
# """ in a sparse matrix.
:param n: Tensor scalar representing the number of experiment.
:param p: Tensor scalar representing the probability of success.
:param shape: Tensor vector for the output shape.
:return: A sparse matrix of integers representing the number
of success.
"""
def __init__(self, format, dtype): def __init__(self, format, dtype):
self.format = format self.format = format
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论