asyml / asyml/forte

DataPack.get_data usage issue

Open
#69 0 comments 0 reactions 0 assignees View on GitHub
enhancement priority: high topic: data
Dominant language
Python
Stars
253
Forks
59
PR merge metrics
No merged PRs in 30d

Description

The get_data() method can get links from the pack, however, the behavior is not very intuitive:
If the request didn't contain the ParentType and ChildType of the requested Link, then no links will be returned. The links will only be returned when both the ParentType and ChildType are also requested. Possible enhancements are:

1. Clear documentation of such behavior.
1. Warning when the ParentType or ChildType of the link not specified.
1. Automatically expand the Annotation request set with the ParentType and ChildType.

Contributor guide

Open the contributing guide

Research direction

Start by locating the Python implementation of DataPack.get_data() and examining how requested ParentType and ChildType values control returned links. Compare the three proposed enhancements and determine which behavior the maintainers want; done should include the selected behavior and clear documentation or warning coverage.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.