Skip to content

Various documentation issues #39

@IAlibay

Description

@IAlibay

Porting over some issues from MDAnalysis/mdanalysis#2401

  • encore.hes returns unreadable details which are not documented
  • encore.ClusteringMethod.KMeans documents precompute_distances without actually having it as a kwarg
  • encore.DimensionalityReductionMethod.StochasticProximityEmbeddingNative documents the default number of dimensions as 3, but it's actually 2
  • for encore.hes, ces, dres: document that the method returns averages and standard deviations if estimate_error=True
  • for encore.ces_convergence document the output. The shape does not include preference_values.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions