Skip to content

readthedocs API changes #159

Description

@jeremymanning

I think a few minor changes would help make the API documentation a bit clearer on readthedocs:

  • Make a note in hypertools.tools.describe_pca that the function is depreciated (replaced by hypertools.describe
  • Change order of main functions to: plot, analyze, normalize, reduce, align, cluster, describe
  • Make a note in hypertools.tools.procrustes that the function is depreciated (replaced by hypertools.align(..., align='procrustes')
  • Does cluster support normalize/reduce/align keywords? I think it should... (if not, we should open another issue for it; otherwise we should correct the API)
  • In plot, analyze, normalize, reduce, align, and cluster we should add more details on how to specify the models. Specifically, make clear that the user should pass in a string (list possible options) if they want the default parameters. For advanced users, they should pass a dictionary (and make the scikit-learn "supported models" a hyperlink, so advanced users can explore which parameters are supported)
  • For DataGeometry in the high level description, instead of saying "Note: this class should not be called directly, ..." I think we should say "Note: new instances of this class should not be initialized directly, ..." (or something along those lines)

Metadata

Metadata

Assignees

Type

No type

Fields

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