[FEATURE] Add a simple MSE Metric

[minettekaum]

‼️ If you want to work on this issue: please comment below and wait until a maintainer assigns this issue to you before opening a PR to avoid several contributions on the same issue. Thanks! 😊

---

✨ What You’ll Do

Right now, Pruna has several evaluation metrics, but we would need a simple MSE based metric.

You can do this by putting images on top of each other and literally looking at the pixel differences at the transitions.

Your task will be to:

• Add a new metric class MSE under pruna/metrics/.
• Implement the standard metric interface (update(...), compute(...)).
• Integrate this metric into Pruna’s registry so it can be selected in evaluation runs.
• Add tests that validate correctness on toy examples and edge cases.
• Document the new metric and provide a simple usage example.

---

🤖 Useful Resources

• The pruna documentation: https://docs.pruna.ai/en/stable/docs_pruna/user_manual/customize_metric.html
• Existing metrics in pruna/metrics as references for structure.
• Pruna’s metric registry and how new metrics are registered.

---

✅ Acceptance Criteria

• It follows the style guidelines.
• The new metric is documented in code and user docs.
• Tests demonstrate that the metric computes expected scores on simple controlled examples.
• The metric integrates properly into Pruna’s evaluation framework.

And don’t forget to give us a ⭐️!

---

❓ Questions?

Feel free to jump into the #contributing Discord channel if you hit any roadblocks. Can’t wait to see your contribution! 🚀

---

Share on Socials

[AnikethBhosale]

@minettekaum I've never worked on something like this , but I feel I'll learn a lot while implementing this... , so I would love to work on this !!! If u are ok with it , then pls assign :)

[pranayyb]

@minettekaum could you assign me this issue?

[AnikethBhosale]

Thanks for assigning @minettekaum , I'll do my best ✨

[sdiazlor]

Hi @AnikethBhosale! Thanks for your interest in participating. However, we realized that this issue is duplicated. Would you mind working on this one instead? As mentioned in the description, it's also a metric what you would need to implement, and the process is similar. Let me know if this works for you, so I can assign you and close this one :)

[AnikethBhosale]

@sdiazlor it has already been assigned to someone ...
I'll be glad to work on any other hacktoberfest issue which you think is good and where I can learn a lot :)

[sdiazlor]

Sorry for the inconvenience @AnikethBhosale ! I updated the current issue and assigned it to you. Feel free to work on it and don't hesitate to ask in Discord if you have any questions :)

[AnikethBhosale]

Thanks @sdiazlor !!!
As a beginner, this means a lot to me.
And yes, I’ll not hesitate to ask on Discord. :)

[AnikethBhosale]

Hey , @minettekaum @sdiazlor , It'll be great if someone could help me with my doubts on discord (general channel) 🥲.