Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SDK][Agreement] Harmonize Interfaces of Agreement Measures #975

Merged
merged 25 commits into from
Oct 4, 2023

Conversation

simulacrum6
Copy link
Contributor

Description

This PR aligns the data format required by all measures under the agreement package.

Previously, different agreement measures required annotations in different formats as input. This made it hard to use them, as the users needed to know, which format their data had to be transformed into. It also made bootstrapping more tricky, as sampling from some data formats is not straightforward.

Summary of changes

  • All measures take the same data format now. Inputs to measures must be a 2d array with columns representing annotators and rows representing items.
  • Tests have been adapted and simplified.
  • Docstrings and documentation were updated.

How test the changes

pytest <PATH_TO_PYTHON_SDK/test/human_protocol_sdk/agreement

Related issues

Closes #944.

Operational checklist

  • All new functionality is covered by tests
  • Any related documentation has been changed or added

# Conflicts:
#	packages/sdk/python/human-protocol-sdk/human_protocol_sdk/agreement/__init__.py
#	packages/sdk/python/human-protocol-sdk/human_protocol_sdk/agreement/bootstrap.py
#	packages/sdk/python/human-protocol-sdk/human_protocol_sdk/agreement/measures.py
#	packages/sdk/python/human-protocol-sdk/human_protocol_sdk/agreement/utils.py
#	packages/sdk/python/human-protocol-sdk/test/human_protocol_sdk/agreement/test_bootstrap.py
#	packages/sdk/python/human-protocol-sdk/test/human_protocol_sdk/agreement/test_measures.py
#	packages/sdk/python/human-protocol-sdk/test/human_protocol_sdk/agreement/test_utils.py
# Conflicts:
#	packages/sdk/python/human-protocol-sdk/human_protocol_sdk/agreement/__init__.py
#	packages/sdk/python/human-protocol-sdk/human_protocol_sdk/agreement/measures.py
#	packages/sdk/python/human-protocol-sdk/human_protocol_sdk/agreement/utils.py
#	packages/sdk/python/human-protocol-sdk/test/human_protocol_sdk/agreement/test_bootstrap.py
#	packages/sdk/python/human-protocol-sdk/test/human_protocol_sdk/agreement/test_measures.py
#	packages/sdk/python/human-protocol-sdk/test/human_protocol_sdk/agreement/test_utils.py
@simulacrum6 simulacrum6 added SDK IRA Package Issues related to the Inter-Rater Agreement package. labels Oct 3, 2023
@vercel
Copy link

vercel bot commented Oct 3, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
escrow-dashboard ✅ Ready (Inspect) Visit Preview Oct 3, 2023 9:48am
fortune-job-launcher-client ✅ Ready (Inspect) Visit Preview Oct 3, 2023 9:48am
human-protocol-typescript-sdk-docs ❌ Failed (Inspect) Oct 3, 2023 9:48am
job-launcher-client ✅ Ready (Inspect) Visit Preview Oct 3, 2023 9:48am
job-launcher-server ✅ Ready (Inspect) Visit Preview Oct 3, 2023 9:48am
6 Ignored Deployments
Name Status Preview Updated (UTC)
faucet-server ⬜️ Ignored (Inspect) Oct 3, 2023 9:48am
fortune-exchange-oracle ⬜️ Ignored (Inspect) Oct 3, 2023 9:48am
fortune-exchange-oracle-server ⬜️ Ignored (Inspect) Oct 3, 2023 9:48am
fortune-job-launcher-server ⬜️ Ignored (Inspect) Oct 3, 2023 9:48am
fortune-recording-oracle ⬜️ Ignored (Inspect) Oct 3, 2023 9:48am
fortune-reputation-oracle ⬜️ Ignored (Inspect) Oct 3, 2023 9:48am

@simulacrum6 simulacrum6 self-assigned this Oct 3, 2023
@simulacrum6 simulacrum6 merged commit 57e0893 into develop Oct 4, 2023
18 of 21 checks passed
@simulacrum6 simulacrum6 deleted the feat/agreement/unify-measures-interface branch October 4, 2023 11:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
IRA Package Issues related to the Inter-Rater Agreement package. SDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants