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.

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

comprehensive explanation of metrics, models and dataset #66

Open
niansong1996 opened this issue Aug 31, 2021 · 1 comment
Open

comprehensive explanation of metrics, models and dataset #66

niansong1996 opened this issue Aug 31, 2021 · 1 comment
Assignees
Labels
enhancement New feature or request feature request Requesting new features
Milestone

Comments

@niansong1996
Copy link
Collaborator

Making sure that we have rather comprehensive descriptions/explanations of the metrics, models and datasets.

We should have methods to list all models/datasets/metrics, either in natural language describing them, or using something like prettytable to print tables in the readme to the console/notebook.

@niansong1996 niansong1996 added enhancement New feature or request feature request Requesting new features labels Aug 31, 2021
@niansong1996 niansong1996 added this to To do in First Release Sep 10, 2021
@niansong1996 niansong1996 added this to the Release 0.1.0 milestone Sep 10, 2021
@zhangir-azerbayev
Copy link
Collaborator

For a long time I've been wanting to write a detailed documentation page using Sphinx. I am swamped for the next week or so, but could start working on it from 10/19 if it sounds like a good idea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request feature request Requesting new features
Projects
No open projects
Development

No branches or pull requests

3 participants