Chore/rename task fields

[luisaadanttas]

This pull request addresses issue #938

[yoavkatz]

Thanks for your contribution Maria! The changes look right. However, the proposed change is not backward compatible (require changes to user code). Since we don't want to make abrupt changes, we should keep the original fields in Task , but add them as deprecated. Then we should check in the Task. prepare() that either the old fields or new fields are set (but not both). It's good that you changed all the existing documentation and examples, so people will follow the new approach from now on. Finally, we should add one test that uses the old fields and see it continues works.

Do you think you can proceed with these changes.

[luisaadanttas]

Yes, that makes a lot of sense. Thank you!

I can implement those changes :)

[elronbandel]

@luisaadanttas thanks again! notice you mark the old fields with DeprectedField.
See this example for reference:

unitxt/src/unitxt/operators.py

Line 257 in 279412f

use_query: bool = DeprecatedField(

[yoavkatz]

I suggest separating into two checks, because people can mix only one pair of fields.

if (self.input_fields is not None and self.inputs is not None):
aise ValueError(
"Conflicting attributes: 'input_fields' cannot be set simultaneously with 'inputs'. Use only 'input_fields'"
)

if (self.output_fields is not None and self.reference_fields is not None):
aise ValueError(
"Conflicting attributes: 'reference_fields' cannot be set simultaneously with 'output'. Use only 'reference_fields'"
)

[yoavkatz]

Thanks for making the changes. I added two minor comments regarding error checking - and then I think we are good to merge.

[luisaadanttas]

Thanks for making the changes. I added two minor comments regarding error checking - and then I think we are good to merge.

Thanks for your review and suggestions! I've incorporated your feedback on the field checks and updated the tests accordingly :)

[yoavkatz]

Thanks for making the changes. I approved it, but the check failed.

{'file': '/home/runner/work/unitxt/unitxt/src/unitxt/catalog/cards/atta_q.json', 'diff': 'diff'}
{'file': '/home/runner/work/unitxt/unitxt/src/unitxt/catalog/cards/attaq_500.json', 'diff': 'diff'}
{'file': '/home/runner/work/unitxt/unitxt/src/unitxt/catalog/cards/bold.json', 'diff': 'diff'}

The prepare/attaq_.py has

task=Task(
    inputs=["input"], outputs=["input_label"], metrics=["metrics.safety_metric"]
),

https://github.com/luisaadanttas/unitxt/blob/chore/rename-task-fields/prepare/cards/atta_q.py
These should be replaced to the new field names (in the 3 files).

Then you need to run:

utils/prepare_all_artifacts.py to update the json files.

[yoavkatz]

Changes are merged.

Thank you Maria for your contribution!