update poisson docs to mention the ability to use batching
@@ -33,12 +33,10 @@ public class PoissonVertex extends VertexImpl<IntegerTensor, IntegerVertex> impl
private static final String MU_NAME = "mu";
/**
- * One mu that must match a proposed tensor shape of Poisson.
- * <p>
- * If all provided parameters are scalar then the proposed shape determines the shape
+ * Poisson with mu as a hyperparameter. Mu here is aka lambda.
*
- * @param shape the desired shape of the vertex
- * @param mu the mu of the Poisson with either the same shape as specified for this vertex or a scalar
+ * @param shape the desired shape of the vertex. This must be broadcastable with the mu shape.
+ * @param mu the mu of the Poisson. The shape of mu must be broadcastable with shape.
*/
public PoissonVertex(@LoadShape long[] shape,
@LoadVertexParam(MU_NAME) Vertex<DoubleTensor, ?> mu) {
