SMAP regression error

[hugoperrin]

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?

What does this PR do?

This PR adds SMAPE regression metric: #372.

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 🙃

[pep8speaks]

Hello @hugoperrin! Thanks for updating this PR.

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2021-07-16 13:25:56 UTC

[codecov]

Codecov Report

Merging #375 (7bfed06) into master (a4d2a7a) will increase coverage by 0.03%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #375      +/-   ##
==========================================
+ Coverage   96.42%   96.46%   +0.03%     
==========================================
  Files         112      114       +2     
  Lines        3665     3705      +40     
==========================================
+ Hits         3534     3574      +40     
  Misses        131      131              

Flag	Coverage Δ
Linux	76.62% <97.50%> (+0.22%)	⬆️
Windows	76.62% <97.50%> (+0.22%)	⬆️
cpu	96.41% <100.00%> (+0.03%)	⬆️
gpu	96.38% <100.00%> (+0.03%)	⬆️
macOS	96.41% <100.00%> (+0.03%)	⬆️
pytest	96.46% <100.00%> (+0.03%)	⬆️
python3.6	95.57% <100.00%> (+0.04%)	⬆️
python3.8	96.30% <100.00%> (-0.07%)	⬇️
python3.9	?
torch1.3.1	95.57% <100.00%> (+0.04%)	⬆️
torch1.4.0	?
torch1.9.0	96.30% <100.00%> (+0.04%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
torchmetrics/__init__.py	100.00% <ø> (ø)
torchmetrics/functional/__init__.py	100.00% <100.00%> (ø)
...ession/symmetric_mean_absolute_percentage_error.py	100.00% <100.00%> (ø)
torchmetrics/regression/__init__.py	100.00% <100.00%> (ø)
...ession/symmetric_mean_absolute_percentage_error.py	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a4d2a7a...7bfed06. Read the comment docs.

[SkafteNicki]

Looks great. Two things:

• Remember to add an note in the Changelog file
• The function that is compared against takes a multioutput argument but the functional/modular implementation of SMAPE does not. Why is that?

[Borda]

@hugoperrin mind check last comments from @SkafteNicki, mainly related to references

[hugoperrin]

@Borda I updated the needed docs, I think this should be good, I'll wait on the CI to finish and fix things if things are needed to be fixed then :) Thank you for your quick feedback :)

PS: should I squash the commits by the way?

[Borda]

PS: should I squash the commits by the way?

no need, well do it with all PR by default: squash + merge

@hugoperrin seems it is your first PR so GH requires to allow running CI by a maintainer, so pls when you see it is hanging, pls ping me in slack so we can speed it up :]

[SkafteNicki]

LGTM