Long plot names

Question

Long plot names

jrbourbeau opened this issue 3 years ago · comments

In dask/distributed#5129 we added a new "Workers network bandwidth timeseries" plot. I noticed that when the labextension sidebar is small, this plot's name is large enough that its text doesn't fit inside the corresponding button:

A couple of things we might consider:

We can change the plot's name in distributed (e.g. drop the word "bandwidth" or "network"). However, as we make new plots in the future, some longer names might slip through. I suppose we could always add some test in distributed that plot names must be below X characters
I'm wondering if there's anything we can do in the labextension to dynamically change the name that's displayed based on the size of the sidebar (e.g. adding ellipsis like "Worker network bandwidth tim...").
... something else?

cc @ncclementi for visibility

Matthew Rocklin · Answer 1 · Fri Aug 20 2021 07:51:41 GMT+0800 (China Standard Time)

I think that short term we should use a more concise naming scheme and that long term we should have categories in the labextension buttons to help with hierarchy

…

On Thu, Aug 19, 2021 at 5:25 PM James Bourbeau ***@***.***> wrote: In dask/distributed#5129 <dask/distributed#5129> we added a new "Workers network bandwidth timeseries" plot. I noticed that when the labextension sidebar is small, this plot's name is large enough that its text doesn't fit inside the corresponding button: [image: Screen Shot 2021-08-19 at 3 53 51 PM] <https://user-images.githubusercontent.com/11656932/130151500-f101b681-5ffc-4a56-9d02-0a783b3f95a0.png> A couple of things we might consider: 1. We can change the plot's name in distributed (e.g. drop the word "bandwidth" or "network"). However, as we make new plots in the future, some longer names might slip through. I suppose we could always add some test in distributed that plot names must be below X characters 2. I'm wondering if there's anything we can do in the labextension to dynamically change the name that's displayed based on the size of the sidebar (e.g. adding ellipsis like "Worker network bandwidth tim..."). 3. ... something else? cc @ncclementi <https://github.com/ncclementi> for visibility — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#211>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AACKZTF5AS7ZGQY64R6ZUN3T5WAHDANCNFSM5CPEJNKQ> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&utm_campaign=notification-email> .

Naty Clementi · Answer 2 · Fri Aug 20 2021 22:30:07 GMT+0800 (China Standard Time)

This is a quick fix I can take care of by modifying the name on distributed, in these two lines

https://github.com/dask/distributed/blob/6a8b49db67896caeea1b6e6075c1dd50b45ae73b/distributed/dashboard/scheduler.py#L72

https://github.com/dask/distributed/blob/6a8b49db67896caeea1b6e6075c1dd50b45ae73b/distributed/dashboard/scheduler.py#L78

now, what do we want to remove "network" or "bandwidth" ? I'm curious what's the better name choice for the user to find the plot.

Ian Rose · Answer 3 · Fri Aug 20 2021 22:33:51 GMT+0800 (China Standard Time)

We can also do some things with CSS on the labextension side to wrap or clip long names (possibly with a hover for the full name)

James Bourbeau · Answer 4 · Fri Aug 20 2021 23:53:53 GMT+0800 (China Standard Time)

now, what do we want to remove "network" or "bandwidth" ?

I would drop "network" and go with "workers bandwidth"

Matthew Rocklin · Answer 5 · Fri Aug 20 2021 23:57:18 GMT+0800 (China Standard Time)

Just "bandwidth" and "bandwidth timeseries" maybe? I think that these are likely the default

…

On Fri, Aug 20, 2021 at 10:54 AM James Bourbeau ***@***.***> wrote: now, what do we want to remove "network" or "bandwidth" ? I would drop "network" and go with "workers bandwidth" — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#211 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AACKZTCY3UAJXVBJXQUBM6TT5Z3BZANCNFSM5CPEJNKQ> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&utm_campaign=notification-email> .

Naty Clementi · Answer 6 · Sat Aug 21 2021 01:24:55 GMT+0800 (China Standard Time)

I noticed that we already have a plot called "Bandwidth Workers" I wonder how would we deal with this since it might cause confusion.

Is this plot ever used?

This is plotting the bandwidth information in self.scheduler.bandwidth_workers
https://github.com/dask/distributed/blob/6a8b49db67896caeea1b6e6075c1dd50b45ae73b/distributed/dashboard/components/scheduler.py#L698

James Bourbeau · Answer 7 · Sat Aug 21 2021 01:44:03 GMT+0800 (China Standard Time)

Ah, good point. That plot is included in performance reports currently. @mrocklin feel free to correct me if I'm wrong, but my understanding is that plot is useful and we should keep it around.

Maybe the new plots should be "workers network" and "workers network timeseries". That will fit within the labextension button and is consistent with other plot names (e.g. "workers disk", "workers CPU timeseries", etc.). We can reevaluate after the release later today

Ian Rose · Answer 8 · Tue Dec 21 2021 05:15:43 GMT+0800 (China Standard Time)

This is now fixed by dask/distributed#5239