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

Updated documentation on README #9

Open
aditeyabaral opened this issue Sep 26, 2022 · 0 comments
Open

Updated documentation on README #9

aditeyabaral opened this issue Sep 26, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@aditeyabaral
Copy link
Owner

aditeyabaral commented Sep 26, 2022

The README requires updates with respect to documentation - initialising models, the loss functions, etc. Expecting an extensive documentation present for each function and class present in the readthedocs documentation. A few things like performance metrics need to be added from the paper as well.

@aditeyabaral aditeyabaral added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Sep 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant