diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 71242907a..000000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,7 +0,0 @@ -## Unreleased - -### New features - -### Feature improvements - -### Fixes diff --git a/HISTORY.rst b/HISTORY.rst index 88e7e3f32..92308b874 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -1,6 +1,39 @@ ======= History ======= + +0.3.0.dev2 + — — — — — — — — - +* DataPack version is still 0.0.2 (unstable) +* Add a new tutorial for building machine translation system: #818, #826 +* Fix issues in documentation and tutorials: #825, #799, #830 +* Improve data augmentation: #784 +* Data-efficiency improvement: #834, #839, #692, #842 + +0.3.0.dev1 + — — — — — — — — - +* Unstable development version +* DataPack version is updated to 0.0.2 (unstable), does not support old data pack version. +* Data-efficiency improvement + - Use new data structures such as list/tuples store the data in order to optimize the speed of operations such as add, query, get (type, range, attribute), delete, etc. +#782, #796, #779, #801, #769, #771, #800, #680, #814 +* A prototyped Computer Vision design and example #795, #813 +* Regular bug fixes + +0.2.0 + — — — — — — — — - +* DataPack is newly versioned as 0.0.1, also supporting old (un-versioned) data pack versions +* Add functionalities to data augmentation (#532, #536, #543, #554, #619, #685, #717) +* Fix issues in examples and create some new ones (#545, #624, #529, #632, #708, #711) +* Improve doctoring and refactor documentation (#611, #633, #636, #642, #652, #653, #657, #668, #674, #686, #682, #723, #730, #724) +* Add audio support to DataPack (#585, #592, #600, #603, #609) +* Improve and fix issues in ontology system (#568, #575, #577, #521) +* Relax package requirements and move out dependencies (#705, #706, #707, #720, #760) +* Add readers and selectors (#535, #516, #539) +* Create some utilities for pipeline (#499, #690, #562) +* Provide more operations for DataPack and MultiPack (#531, #534, #555, #564, #553, #576) +* Several clean up and bug fixes (#541, #693, #695) + 0.1.2 — — — — — — — — - * Simplify the Configurable interface (#517) diff --git a/forte/data/multi_pack.py b/forte/data/multi_pack.py index eb437b276..bea95df21 100644 --- a/forte/data/multi_pack.py +++ b/forte/data/multi_pack.py @@ -41,7 +41,7 @@ ) from forte.data.types import DataRequest from forte.utils import get_class, get_full_module_name -from forte.version import DEFAULT_PACK_VERSION, PACK_ID_COMPATIBLE_VERSION +from forte.version import DEFAULT_PACK_VERSION logger = logging.getLogger(__name__) @@ -55,6 +55,10 @@ MdRequest = Dict[Type[Union[MultiPackLink, MultiPackGroup]], Union[Dict, List]] +# Before this, version, data packs are indexed in multipack using the index, +# but afterwards, they are indexed by the pack id. +version_indexed_by_pack_id = "0.0.1" + class MultiPackMeta(BaseMeta): r"""Meta information of a MultiPack.""" @@ -149,19 +153,18 @@ def _init_meta(self, pack_name: Optional[str] = None) -> MultiPackMeta: def _validate(self, entry: EntryType) -> bool: return isinstance(entry, MultiPackEntries) - # TODO: get_subentry maybe useless def get_subentry(self, pack_idx: int, entry_id: int): r""" - Get sub_entry from multi pack. This method uses `pack_id` (a unique - identifier assigned to datapack) to get a pack from multi pack, - and then return its sub_entry with entry_id. Noted this is changed from - the way of accessing such pack before the PACK_ID_COMPATIBLE_VERSION, + Get `sub_entry` from `multi pack`. This method uses `pack_id` (a unique + identifier assigned to datapack) to get a pack from `multi pack`, + and then return its sub_entry with entry_id. + + Noted this is changed from the way of accessing such pack before v0.0.1, in which the `pack_idx` was used as list index number to access/reference - a pack within the multi pack (and in this case then get the sub_entry). + a pack within the `multi pack` (and in this case then get the `sub_entry`). Args: - pack_idx: The pack_id for the data_pack in the - multi pack. + pack_idx: The pack_id for the data_pack in the multi pack. entry_id: the id for the entry from the pack with pack_id Returns: @@ -171,7 +174,7 @@ def get_subentry(self, pack_idx: int, entry_id: int): pack_array_index: int = pack_idx # the old way # the following check if the pack version is higher than the (backward) # compatible version in which pack_idx is the pack_id not list index - if Version(self.pack_version) >= Version(PACK_ID_COMPATIBLE_VERSION): + if Version(self.pack_version) >= Version(version_indexed_by_pack_id): pack_array_index = self.get_pack_index( pack_idx ) # the new way: using pack_id instead of array index diff --git a/forte/version.py b/forte/version.py index 7cf4996ff..e0036f0b2 100644 --- a/forte/version.py +++ b/forte/version.py @@ -20,5 +20,7 @@ VERSION = "{0}.{1}.{2}".format(_MAJOR, _MINOR, _REVISION) FORTE_IR_VERSION = "0.0.1" PACK_VERSION = "0.0.2" +# The version before formal release, data pack without +# version annotation will be assigned this. DEFAULT_PACK_VERSION = "0.0.0" PACK_ID_COMPATIBLE_VERSION = "0.0.2"