Add the Popularity metric #20180

Jamim · 2023-12-25T09:26:28Z

Hello,

Thank you for this amazing torrent client! 🙇🏻‍♂️

I believe it would be nice to have a metric that shows how popular a torrent is.
It's especially helpful for clean up purposes if you want to delete the least popular torrents.
So I'd like to suggest an implementation of the Popularity metric.

Popularity

A new metric is inspired by the Interest Rate from the finance world.
An implementation is adapted to the use-case and has nothing to do with money.

Popularity is an average number that represents how many times a torrent is seeded back on a monthly basis calculated as all_time_upload / all_time_download / (activeTime() / MONTHS_SECONDS), translated to realRatio() / activeMonths for simplicity. The resulting values are reasonably small and easy to comprehend, just as for the classic Ratio metric.

~~Metric's name might be different, but I've kept it due to lack of creativity 🤷🏻‍♂️~~
Thanks to @Mazino-Urek and @LordNyriox for suggesting a better name!

Screenshots

Native UI

Web UI

Best regards!

glassez · 2023-12-25T11:59:18Z

@Jamim
Is this some kind of commonly used (well-known) metric?
Anyway would you mind to provide more details about it in the OP?

glassez · 2023-12-25T12:01:45Z

src/base/bittorrent/torrent.h

@@ -129,6 +129,7 @@ namespace BitTorrent
        static const qreal MAX_RATIO;
        static const int MAX_SEEDING_TIME;
        static const int MAX_INACTIVE_SEEDING_TIME;
+        static const qreal INTEREST_RATE_PERIOD;


I don't believe that it should be declared public. Just move its declaration in "torrentimpl.cpp".

Thanks! INTEREST_RATE_PERIOD has been renamed to MONTH_SECONDS and moved to torrentimpl.cpp.

glassez · 2023-12-25T12:03:50Z

src/base/bittorrent/torrentimpl.cpp

+qreal TorrentImpl::interestRate() const
+{
+    qlonglong elapsed = activeTime();
+    return elapsed ? realRatio() / (elapsed / INTEREST_RATE_PERIOD) : 0;


We discourage to use numbers as booleans.

~~Can't elapsed ever be zero?~~

We discourage to use numbers as booleans.

A comparison to zero has been added.

Can't elapsed ever be zero?

Yes, it's zero in case a torrent is added but not yet started due to the Start torrent checkbox was toggled.

Can't elapsed ever be zero?

Oops, i was asking for division by zero but didn't pay attention to the left side.

Jamim · 2023-12-25T14:43:38Z

Hello @glassez and @thalieht,

Thank you for reviewing this PR so quickly! 🚀

I've added some information about the metric to the original post and made necessary changes to the code. Could you please take a look once again?

Thanks in advance!

thalieht · 2023-12-25T17:43:18Z

It's especially helpful for clean up purposes if you want to delete the least popular torrents.

all_time_upload / all_time_download / (activeTime() / MONTHS_SECONDS)

100 GB / 10 GB / 2 months = 5
100 GB / 100 GB / 2 months = 0.5

You don't like big torrents huh :)

Jamim · 2023-12-25T17:55:18Z

100 GB / 10 GB / 2 months = 5
100 GB / 100 GB / 2 months = 0.5

You don't like big torrents huh :)

Being as helpful for the community while using only 1/10 of the volume is an appealing option 😅

Mazino-Urek · 2023-12-26T09:19:23Z

Well, I am from Finance World and find this analogy to be a bit hilarious.

Probably a better naming would be just "interest" or "Popularity". Nice idea, though.

Jamim · 2023-12-26T14:15:35Z

Thank you @Mazino-Urek and @LordNyriox for suggesting a better name! 🙇🏻‍♂️
I've made necessary changes to rename the suggested metric to Popularity.

glassez · 2023-12-27T12:36:17Z

Maybe I just don't understand something, or it's because I'm not familiar with its use, but will Popularity have the expected value if, for example, a torrent reached a large ratio (say 10.0) in the first month after it was added, and then it had it (almost) unchanged for several months?

thalieht · 2023-12-27T13:38:13Z

IMO "popularity" would be (finished or active time / time spent actually seeding) or something of the sort and maybe put the month somewhere in there.
Even then it could be skewed by other things e.g. not enough upload slots i.e. all currently available upload slots are occupied by other torrents.

Jamim · 2023-12-28T21:51:26Z

Hello @glassez,

will Popularity have the expected value if, for example, a torrent reached a large ratio (say 10.0) in the first month after it was added, and then it had it (almost) unchanged for several months?

Based on your input, I've prepared a script that draws a plot which shows a correlation between Ratio and Popularity metrics over time.
Popularity will slowly decay with deceleration after first 25 days 📉

You can play with the ratio curve to see how it affects Popularity.

Regarding expectations, the values look fine to me ✅

Jamim · 2023-12-28T22:16:07Z

Hello @thalieht,

IMO "popularity" would be (finished or active time / time spent actually seeding) or something of the sort and maybe put the month somewhere in there.

By actually seeding, do you mean time while data was actively uploaded after completion of downloading, excluding idle? If so, I'm not sure how to receive such information.

Even then it could be skewed by other things e.g. not enough upload slots i.e. all currently available upload slots are occupied by other torrents.

That's true. I understand there's no perfect formula for the popularity, but at least it's a good starting point and the initial formula might be changed based on user feedback in the future.

thalieht · 2023-12-28T23:26:43Z

By actually seeding, do you mean time while data was actively uploaded after completion of downloading, excluding idle?

Yep.

If so, I'm not sure how to receive such information.

Wow. I was sure libtorrent would have such a counter but i can't find anything. Let's forget about it then.

Jamim · 2023-12-28T23:45:58Z

In order to gather some additional feedback, I've submitted a post to Reddit:

📈 Adding the Popularity metric to qBittorrent

src/base/bittorrent/torrentimpl.cpp

Chocobo1

Probably the last comment, other code looks fine.
ps. I didn't consider the usefulness of this metric, I'll leave it for others to decide.

Chocobo1 · 2023-12-31T08:20:00Z

src/gui/transferlistmodel.cpp

@@ -171,6 +171,7 @@ QVariant TransferListModel::headerData(const int section, const Qt::Orientation
            case TR_DLSPEED: return tr("Down Speed", "i.e: Download speed");
            case TR_UPSPEED: return tr("Up Speed", "i.e: Upload speed");
            case TR_RATIO: return tr("Ratio", "Share ratio");
+            case TR_POPULARITY: return tr("Popularity", "Ratio / Time Active (in months), indicates how popular the torrent is");


Suggested change

case TR_POPULARITY: return tr("Popularity", "Ratio / Time Active (in months), indicates how popular the torrent is");

case TR_POPULARITY: return tr("Popularity");

The second parameter is for translation disambiguation so you don't need it.

However I think you should move the explanation of the metric to a tooltip (preferably in both GUI and WebUI). The tooltip can be set on the label.

Thanks! I've applied your suggestion. Now I'm working on adding tooltips.

I've added tooltips where it was possible without making a lot of additional changes.
It's not trivial to do so for the WebUI in most cases. It would be better to submit an additional PR to avoid unnecessary discussions on this one.

github-actions · 2024-03-04T00:14:53Z

This PR is stale because it has been 60 days with no activity. This PR will be automatically closed within 7 days if there is no further activity.

Jamim · 2024-03-11T20:52:18Z

Hello @glassez, @thalieht, and @Chocobo1!

Would you mind reviewing the current version of changes?

Thanks in advance!

src/gui/transferlistwidget.cpp

I believe it would be nice to have a metric that shows how popular a torrent is. It's especially helpful for clean up purposes if you want to delete the least popular torrents. Co-authored-by: Chocobo1 <Chocobo1@users.noreply.github.com>

src/gui/transferlistmodel.cpp

glassez · 2024-04-01T18:23:22Z

@Jamim
Thank you!

glassez reviewed Dec 25, 2023

View reviewed changes

Jamim force-pushed the feature/interest-rate branch from 43d4025 to f30ed42 Compare December 25, 2023 14:25

Jamim requested review from glassez and thalieht December 25, 2023 14:43

Jamim force-pushed the feature/interest-rate branch from f30ed42 to b33245e Compare December 26, 2023 14:11

Jamim changed the title ~~Add the Interest Rate metric~~ Add the Popularity metric Dec 26, 2023

Chocobo1 reviewed Dec 29, 2023

View reviewed changes

src/base/bittorrent/torrentimpl.cpp Outdated Show resolved Hide resolved

src/base/bittorrent/torrentimpl.cpp Outdated Show resolved Hide resolved

Jamim force-pushed the feature/interest-rate branch from b33245e to 0de8877 Compare December 30, 2023 02:35

Jamim requested a review from Chocobo1 December 30, 2023 02:37

Chocobo1 reviewed Dec 30, 2023

View reviewed changes

src/base/bittorrent/torrentimpl.cpp Outdated Show resolved Hide resolved

src/base/bittorrent/torrentimpl.cpp Show resolved Hide resolved

Jamim force-pushed the feature/interest-rate branch from 0de8877 to ceb7098 Compare December 31, 2023 03:52

Jamim requested a review from Chocobo1 December 31, 2023 03:55

Chocobo1 reviewed Dec 31, 2023

View reviewed changes

Jamim marked this pull request as draft January 3, 2024 06:37

github-actions bot added the Stale label Mar 4, 2024

Jamim force-pushed the feature/interest-rate branch from fb59678 to 1bcd2d5 Compare March 7, 2024 17:41

Jamim marked this pull request as ready for review March 7, 2024 17:50

Jamim requested a review from Chocobo1 March 7, 2024 17:50

github-actions bot removed the Stale label Mar 8, 2024

Chocobo1 reviewed Mar 12, 2024

View reviewed changes

src/gui/transferlistwidget.cpp Outdated Show resolved Hide resolved

Chocobo1 previously approved these changes Mar 12, 2024

View reviewed changes

Add the Popularity metric

3254082

I believe it would be nice to have a metric that shows how popular a torrent is. It's especially helpful for clean up purposes if you want to delete the least popular torrents. Co-authored-by: Chocobo1 <Chocobo1@users.noreply.github.com>

Jamim dismissed Chocobo1’s stale review via 3254082 March 12, 2024 09:02

Jamim force-pushed the feature/interest-rate branch from 1bcd2d5 to 3254082 Compare March 12, 2024 09:02

glassez approved these changes Mar 12, 2024

View reviewed changes

glassez added the Core label Mar 12, 2024

glassez added this to the 5.0 milestone Mar 12, 2024

github-advanced-security bot found potential problems Mar 12, 2024

View reviewed changes

src/gui/transferlistmodel.cpp Show resolved Hide resolved

Chocobo1 approved these changes Mar 24, 2024

View reviewed changes

glassez merged commit f37d0c4 into qbittorrent:master Apr 1, 2024
13 checks passed

Jamim deleted the feature/interest-rate branch April 2, 2024 10:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add the Popularity metric #20180

Add the Popularity metric #20180

Jamim commented Dec 25, 2023 •

edited

glassez commented Dec 25, 2023

glassez Dec 25, 2023

Jamim Dec 25, 2023

glassez Dec 25, 2023

thalieht Dec 25, 2023 •

edited

Jamim Dec 25, 2023

thalieht Dec 25, 2023

Jamim commented Dec 25, 2023

thalieht commented Dec 25, 2023

Jamim commented Dec 25, 2023

Mazino-Urek commented Dec 26, 2023

Jamim commented Dec 26, 2023

glassez commented Dec 27, 2023

thalieht commented Dec 27, 2023

Jamim commented Dec 28, 2023

Jamim commented Dec 28, 2023 •

edited

thalieht commented Dec 28, 2023

Jamim commented Dec 28, 2023

Chocobo1 left a comment

Chocobo1 Dec 31, 2023 •

edited

Jamim Jan 3, 2024

Jamim Mar 7, 2024

github-actions bot commented Mar 4, 2024

Jamim commented Mar 11, 2024

glassez commented Apr 1, 2024

	case TR_POPULARITY: return tr("Popularity", "Ratio / Time Active (in months), indicates how popular the torrent is");
	case TR_POPULARITY: return tr("Popularity");

Add the Popularity metric #20180

Add the Popularity metric #20180

Conversation

Jamim commented Dec 25, 2023 • edited

Popularity

Screenshots

Native UI

Web UI

glassez commented Dec 25, 2023

glassez Dec 25, 2023

Choose a reason for hiding this comment

Jamim Dec 25, 2023

Choose a reason for hiding this comment

glassez Dec 25, 2023

Choose a reason for hiding this comment

thalieht Dec 25, 2023 • edited

Choose a reason for hiding this comment

Jamim Dec 25, 2023

Choose a reason for hiding this comment

thalieht Dec 25, 2023

Choose a reason for hiding this comment

Jamim commented Dec 25, 2023

thalieht commented Dec 25, 2023

Jamim commented Dec 25, 2023

Mazino-Urek commented Dec 26, 2023

Jamim commented Dec 26, 2023

glassez commented Dec 27, 2023

thalieht commented Dec 27, 2023

Jamim commented Dec 28, 2023

Jamim commented Dec 28, 2023 • edited

thalieht commented Dec 28, 2023

Jamim commented Dec 28, 2023

Chocobo1 left a comment

Choose a reason for hiding this comment

Chocobo1 Dec 31, 2023 • edited

Choose a reason for hiding this comment

Jamim Jan 3, 2024

Choose a reason for hiding this comment

Jamim Mar 7, 2024

Choose a reason for hiding this comment

github-actions bot commented Mar 4, 2024

Jamim commented Mar 11, 2024

glassez commented Apr 1, 2024

Jamim commented Dec 25, 2023 •

edited

thalieht Dec 25, 2023 •

edited

Jamim commented Dec 28, 2023 •

edited

Chocobo1 Dec 31, 2023 •

edited