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

More detailed API references which help plugin developer to work easier. #350

Open
rickycao-qy opened this issue Jul 16, 2020 · 1 comment
Assignees
Labels
docs Improvements or additions to documentation

Comments

@rickycao-qy
Copy link
Collaborator

rickycao-qy commented Jul 16, 2020

Currently pipcook is lack of detailed documentation about what functions or API plugins could use so it's hard for developers to develop plugins. We need to provide a detailed API reference:

  • Detailed API reference for plugin prototype (in pipcook-core)

    • documentation about type of plugins
    • documentation about parameters (args) for each plugins
    • documentation about dataset types
    • documentation about model types
    • documentation about how to organize plugins folder structures
  • Detailed reference about public utils

Generally the above API are provided in pipcook-core. We could give reasonable comments for each type and functions in pipcook-core.

To support multiple languages, we can use typedoc plugin typedoc-plugin-localization

@rickycao-qy rickycao-qy added the docs Improvements or additions to documentation label Jul 16, 2020
@rickycao-qy rickycao-qy self-assigned this Jul 16, 2020
@yorkie yorkie mentioned this issue Jul 16, 2020
31 tasks
@yorkie
Copy link
Member

yorkie commented Jul 16, 2020

Is there a typo for imgcook-core?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants