-
Notifications
You must be signed in to change notification settings - Fork 1
Add further Customization Templates #1
Description
[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.