Convokit 3.0 Mega Pull Request #199
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This is the Mega PR for ConvoKit 3.0 Release Updates.
let's do it in chronological order
Fix coordination.py with use of mutability of metadata - bug fix
Major immutability of metadata implementation, with a deepcopy of metadata field returned upon accesses of metadata fields. This prevent all potential modification to metadata fields from affecting the actual storage, same as making metadata fields immutable. The purpose of this is to align behavior between MEM mode to DB mode, as DB mode has the issue with mutation to metadata fields not able to be updated to database. - major update
Documentation updates for version 3.0 - documentation update
Pairer with pair_mode set to 'maximize' leads to error when pairing function returns integer (TypeError: unsupported operand type(s) for +: 'int' and 'str' ). We now implement to cast all returned value of pairing function to string when pair_mode is 'maximize', so that fix the bug, and as the case when it will not work is very rare (casting custom type to string etc, handled explicitly), this method would generally work - bug fix
Motivation and Context
The major update for ConvoKit 3.0 is to introduce DB mode, with the support of MongoDB backend. Thus, we are able to work with large scale corpus in a more RAM friendly and stable fashion. To support the new version, immutability of metadata is introduced to align the behavior of two modes. For more detail, view the updated documentation.
How has this been tested?
Run through all tests, example notebooks with no error found.