Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Various documentation issues #39

Open
5 tasks
IAlibay opened this issue Sep 6, 2023 · 0 comments
Open
5 tasks

Various documentation issues #39

IAlibay opened this issue Sep 6, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@IAlibay
Copy link
Member

IAlibay commented Sep 6, 2023 •
edited by orbeckst

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.
@orbeckst orbeckst added the documentation Improvements or additions to documentation label Sep 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@orbeckst @IAlibay