metric tracker

[rajs96]

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?

Adds timeseries metric to the library. Resolves #180

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 🙃

[codecov]

Codecov Report

Merging #238 (f4a5205) into master (b487ac3) will decrease coverage by 0.05%.
The diff coverage is 91.48%.

@@            Coverage Diff             @@
##           master     #238      +/-   ##
==========================================
- Coverage   96.01%   95.96%   -0.06%     
==========================================
  Files         126      127       +1     
  Lines        4088     4134      +46     
==========================================
+ Hits         3925     3967      +42     
- Misses        163      167       +4     

Flag	Coverage Δ
Linux	74.77% <80.85%> (+0.08%)	⬆️
Windows	74.77% <80.85%> (+0.08%)	⬆️
cpu	74.77% <80.85%> (+0.08%)	⬆️
gpu	95.96% <91.48%> (-0.06%)	⬇️
macOS	74.77% <80.85%> (+0.08%)	⬆️
pytest	95.96% <91.48%> (-0.06%)	⬇️

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

Impacted Files	Coverage Δ
torchmetrics/wrappers/tracker.py	91.11% <91.11%> (ø)
torchmetrics/__init__.py	100.00% <100.00%> (ø)
torchmetrics/wrappers/__init__.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 b487ac3...f4a5205. Read the comment docs.

[pep8speaks]

Hello @rajs96! Thanks for updating this PR.

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

Comment last updated at 2021-08-04 09:27:08 UTC

[SkafteNicki]

Overall it looks good to me, but I am basically missing a bit of context.
Could you provide an example on how it is intended to be used

[Borda]

@rajs96 mind check comments and then we can turn it to PR (not just draft)

also, you mentioned in #180 to implement multiple metrics, but if this class has metric type as an argument, there is no need for multiple classes, right?

[Borda]

@rajs96 could you also add to the PR description add a use-case/application?
after we ll add in the docs anyway 🐰

[Borda]

@rajs96 how is it going here?