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

Add further Customization Templates #1

Open
kmdn opened this issue Jan 27, 2022 · 0 comments
Open

Add further Customization Templates #1

kmdn opened this issue Jan 27, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@kmdn
Copy link
Owner

kmdn commented Jan 27, 2022

[What]
Improve documentation!
Ideally at least 1 template per component type, so switching out one specific line to match a user's call becomes relatively trivial.

[How]
Add more templates than the ones for mention detection (spaCy [0] (Python)) and linker recommendation (RF implementation [1] (Python)).
Although protocol is intentionally the same for all (sub-)components, add at least one template for each, so parameter handling and population within passed JSON object becomes trivial.

[0] https://github.com/kmdn/spacy_md_api
[1] https://github.com/kmdn/linker_recommender_api

[Why]
API and protocols are not yet easily understood by novel users, so we have to add more documentation (while trying to keep it succinct) to lower the entry barrier.
Improve understanding of the API by providing more examples on how it may be used and customised.

@kmdn kmdn self-assigned this Jan 27, 2022
@kmdn kmdn added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 27, 2022
@kmdn kmdn changed the title Add further Customization Templates (Documentation Improvement) Add further Customization Templates Jan 27, 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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant