Unify preds, target input arguments for text metrics [2of2] cer, ter, wer, mer, rouge, squad

[ashutoshml]

What does this PR do?

Fixes part of #716

Fixes

• cer
• mer
• ter
• wer
• rouge
• squad

Before submitting

• Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
• Did you read the contributor guideline, Pull Request section?
• Did you make sure to update the docs?
• Did you write any new necessary tests?

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃
Yes

[codecov]

Codecov Report

Merging #727 (8f94875) into master (77babc9) will increase coverage by 0%.
The diff coverage is 91%.

@@          Coverage Diff          @@
##           master   #727   +/-   ##
=====================================
  Coverage      95%    95%           
=====================================
  Files         170    170           
  Lines        6769   6775    +6     
=====================================
+ Hits         6408   6414    +6     
  Misses        361    361           

[Borda]

need to finish deprecation/compatibility 🐰

[ashutoshml]

doctest seem to be failing. Incase we use pyDeprecate, I will remove those docstrings.

there is no rush to use pyDeprecate, it was just a suggestion... cc: @SkafteNicki

Oh I see, then what would be an ideal way of formatting the docstring for deprecated arguments ?

well, I have a plan to add the docstring enrichment in v0.4 🐰

        predictions:
            .. deprecated:: v0.7
                This argument is deprecated in favor of  `preds` and will be removed in v0.8.
        references:
            .. deprecated:: v0.7
                This argument is deprecated in favor of  `preds` and will be removed in v0.8.

This is failing with docstrings. What is the correct way of writing it? I can't find a way online for sphinx

[Borda]

This is failing with docstrings. What is the correct way of writing it? I can't find a way online for sphinx

pls check how we did it with PL, probably some spacing is needed (cc: @awaelchli )

        predictions:

            .. deprecated:: v0.7
                This argument is deprecated in favor of  `preds` and will be removed in v0.8.

        references:

            .. deprecated:: v0.7
                This argument is deprecated in favor of  `preds` and will be removed in v0.8.

[ashutoshml]

This is failing with docstrings. What is the correct way of writing it? I can't find a way online for sphinx

pls check how we did it with PL, probably some spacing is needed (cc: @awaelchli )

        predictions:

            .. deprecated:: v0.7
                This argument is deprecated in favor of  `preds` and will be removed in v0.8.

        references:

            .. deprecated:: v0.7
                This argument is deprecated in favor of  `preds` and will be removed in v0.8.

Tried this. Still failing. Just to confirm: Adding new line between argument name and .. deprecated:: v0.7 is the only indentation change, right ?

[ashutoshml]

For cer, I did this and it seems to be working for now. Let me know if this is the right way

    Args:
        preds: Transcription(s) to score as a string or list of strings
        target: Reference(s) for each speech input as a string or list of strings
    Returns:
        Character error rate score

    .. deprecated:: v0.7
        Args:
            predictions:
                This argument is deprecated in favor of  `preds` and will be removed in v0.8.
            references:
                This argument is deprecated in favor of  `target` and will be removed in v0.8.

And I'll update the rest of the public methods with the same.

[ashutoshml]

@Borda Updated the code with all the requested changes. Kindly review

[stancld]

MER, SQuAD and TER are new metrics in v0.7 thus there's no need to handle naming changes :]

[Borda]

hi @ashutoshml @stancld maybe jump on a quick call and sync what is the latest way of deprecation, eventually @stancld can directly edit your PR in his IDE :]

[stancld]

hi @ashutoshml @stancld maybe jump on a quick call and sync what is the latest way of deprecation, eventually @stancld can directly edit your PR in his IDE :]

I'm now leaving but will be back in ~2 hrs if you're available :]

[ashutoshml]

hi @ashutoshml @stancld maybe jump on a quick call and sync what is the latest way of deprecation, eventually @stancld can directly edit your PR in his IDE :]

I'm now leaving but will be back in ~2 hrs if you're available :]

@stancld. I might not be available then (10:30 pm here RN). Whenever you're available, please have a quick look at the current docstring and suggest changes, if any. I'll update them whenever I start working tomorrow morning.

[ashutoshml]

@Borda Made all the relevant changes. Kindly review