Function to remove data pack from a multi pack

[J007X]

This PR fixes #544.

Description of changes

remove_pack(index_of_pack: int, clean_invalid_entries: bool = False) is added with clean_invalid_entries option for removing Cross-Pack links/groups associated with the data pack to be removed. If this flag is false and the pack to be removed have cross-pack links/groups, a ValueError will be raised indicate user the existence of cross pack links/groups with this pack and the need for setting the flag to be true to remove the associated links/groups.

Possible influences of this PR.

Possible side-effects: if directly removed packs from related arrays the index for the elements after that will be changed which will affect those buffered index such as in getChild/getParent. So current solution is to set the element in corresponding arrays as None instead to keep the index of other elements unchanged. A purge function is also added however to compress the array and remove the None in it however this will cause the index of elements after those removed ones being changed.

Test Conducted

Unit test performed for remove single pack, remove pack with cross pack links and groups. Also unit tested purge function.

[codecov]

Codecov Report

Merging #555 (812c5da) into master (63577ce) will increase coverage by 0.08%.
The diff coverage is 89.28%.

@@            Coverage Diff             @@
##           master     #555      +/-   ##
==========================================
+ Coverage   80.82%   80.90%   +0.08%     
==========================================
  Files         240      240              
  Lines       17194    17362     +168     
==========================================
+ Hits        13897    14047     +150     
- Misses       3297     3315      +18     

Impacted Files	Coverage Δ
forte/data/multi_pack.py	78.01% <75.51%> (-0.53%)	⬇️
tests/forte/data/multi_pack_test.py	96.68% <94.95%> (-2.24%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 63577ce...812c5da. Read the comment docs.

[hunterhector]

Since we will change some implementation in pack id, I didn't fully review this. But I added some comments on some other parts.

[J007X]

Please have a review of the new code that fixed the comments issue as suggested. Thanks.

[hunterhector]

any updates to the reviews

[hunterhector]

Should update branch with master and see if we can pass CI

[J007X]

Sure will do soon as related things getting clear. Thanks Hector. James Xiao Architect T: +971 2 8113163 E: ***@***.*** www.mbzuai.ac.ae<http://www.mbzuai.ac.ae> Mohamed bin Zayed University of Artificial Intelligence Masdar City, Building 1B, 3rd Floor Abu Dhabi, UAE [cid:MBZUAI_Logo_4d283c4f-1a0d-4aed-8a25-b17ff8b431f8.png] The world’s first specialized research-based AI university

…

________________________________ 发件人: Hector ***@***.***> 发送时间: 2022年2月3日 9:20 收件人: asyml/forte ***@***.***> 抄送: James Xiao ***@***.***>; Author ***@***.***> 主题: Re: [asyml/forte] Function to remove data pack from a multi pack (PR #555) Should update branch with master and see if we can pass CI ― Reply to this email directly, view it on GitHub<#555 (comment)>, or unsubscribe<https:/notifications/unsubscribe-auth/AWD56G6M64FJ35UXSEZ3PPDUZIGBTANCNFSM5HLYRRAQ>. Triage notifications on the go with GitHub Mobile for iOS<https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android<https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>. You are receiving this because you authored the thread.Message ID: ***@***.***>