Skip to content

Almost zero documentation for the training modules API #152

Open
@arunchakra

Description

Hello,

I would like to try out this package but realize there is close to zero documentation in the official 'readthedocs'/API for the train classes. Is this actually the official documentation? None of the parameters are defined, the differences between functions are undefined, and almost nothing is written here. Please correct me if this is not the official documentation. It's unclear how to even use the train modules

https://ncem.readthedocs.io/en/latest/readme.html

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions