Compound

Compound manifolds

class Manifolds.CompoundManifold(manifolds)

add_cotan(cotan)

Same as add_gd(), for cotangents.

add_gd(gd)

Adds gd to the manifold geometrical descriptors.

Parameters

gd (Iterable or torch.Tensor) – Tensors that will be added to the manifold geometrical descriptors.

add_tan(tan)

Same as add_gd(), for tangents.

clone(requires_grad=False)

Returns a copy of the manifold. The computation tree gets detached.

cot_to_vs(sigma, backend=None)

TODO: Add documentation.

property cotan

cotan_requires_grad_(requires_grad=True)

property device

property dim

property dtype

fill(manifold, copy=False, requires_grad=True)

TODO: write documentation

fill_cotan(cotan, copy=False, requires_grad=None)

Same as fill_cotan(), for cotangents.

fill_cotan_randn(requires_grad=True)

Same as fill_gd_randn(), for cotangents.

fill_cotan_zeros(requires_grad=True)

Same as fill_gd_zeros(), for cotangents.

fill_gd(gd, copy=False, requires_grad=None)

Fill geometrical descriptors to the manifold.

Parameters

• copy (bool, default=False) – If True, copy the geometrical descriptors into the manifold, detaching the computation graph. If False, the tensors are passed by references.

• requires_grad (bool, default=True) – If copy**=True, set the **requires_grad flag of the copied geometrical descriptors tensors to the given boolean value.

fill_gd_randn(requires_grad=True)

Fill geometrical descriptors with a standard normal distribution.

Parameters

requires_grad (bool, default=True) – Value given to the requires_grad flag of the random tensors.

fill_gd_zeros(requires_grad=True)

Fill geometrical descriptors with zero tensors.

Parameters

requires_grad (bool, default=True) – Value given to the requires_grad flag of the zero tensors.

fill_tan(tan, copy=False, requires_grad=None)

Same as fill_gd(), for tangents.

fill_tan_randn(requires_grad=True)

Same as fill_gd_randn(), for tangents.

fill_tan_zeros(requires_grad=True)

Same as fill_gd_zeros(), for tangents.

property gd

gd_requires_grad_(requires_grad=True)

infinitesimal_action(field)

Infinitesimal action generated by the manifold.

Parameters

field (StructuredField.BaseStructuredField) – Hello there.

inner_prod_field(field)

TODO: Add documentation.

property len_gd

property manifolds

property nb_pts

negate_cotan()

Negate cotangents.

negate_gd()

Negate geometrical descriptors.

negate_tan()

Negate tangents.

property numel_gd

roll_cotan(l)

roll_gd(l)

Unflattens the list into one suitable for fill_gd() or all *_gd() numerical operations.

property tan

tan_requires_grad_(requires_grad=True)

to_(*argv, **kwargs)

unroll_cotan()

unroll_gd()

Returns a flattened list of all gd tensors.