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

Improve API reference #1102

Closed
ClaudiaComito opened this issue Feb 13, 2023 · 4 comments
Closed

Improve API reference #1102

ClaudiaComito opened this issue Feb 13, 2023 · 4 comments
Labels
documentation Anything related to documentation good first issue Good for newcomers stale

Comments

@ClaudiaComito
Copy link
Contributor

ClaudiaComito commented Feb 13, 2023

Context
Heat's autogenerated API reference lists all the modules in alphabetical order and links to the modules' documentation.

This is perfect for us insiders, but a bit confusing for users who go through the API reference to figure out what numpy or scikit-learn functionalities they can memory-distribute with Heat.

Feature functionality
Replace or augment our API reference with something that conveys at a glance what numpy/scipy functions or scikit-learn algos are already implemented in Heat, what features are in progress (would be nice: link issue/PR?), what are missing entirely (would be nice: link/button to request feature).

Additional context
For inspiration:
dpnp
ramba
cunumeric

Feel free to add more in the comments.

New contributors

  • please branch off the release/1.2.x branch to fix this issue, not the main branch.
  • when you create a PR, make sure your base branch (the branch you want to merge your change into) is release/1.2.x, not main.

Thanks a lot!

@ClaudiaComito ClaudiaComito added good first issue Good for newcomers documentation Anything related to documentation labels Feb 13, 2023
@AsRaNi1
Copy link
Contributor

AsRaNi1 commented Feb 14, 2023

@ClaudiaComito I would like to work on this issue, i'll soon create a PR
Also, should i only include the major functions implemented?

@ClaudiaComito
Copy link
Contributor Author

@AsRaNi1 thanks a lot for taking this on. Ideally we would have:

  • an automated or semi-automated solution including everything
  • a summary table with the most important modules/functions that we can post on the README.

Summary table would be top priority at this time.

Thanks again!

Copy link
Contributor

This issue is stale because it has been open for 60 days with no activity.

@github-actions github-actions bot added the stale label Dec 11, 2023
Copy link
Contributor

This issue was closed because it has been inactive for 60 days since being marked as stale.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Feb 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to documentation good first issue Good for newcomers stale
Projects
None yet
Development

No branches or pull requests

2 participants