Added FloatLogSlider #1928

sebasguts · 2018-01-23T21:41:41Z

a slider that uses a logarithmic scale. Closes #719

jasongrout

Thanks again for adding this! There are a few places I noted where it's confusing what is talking about the exponent and what is talking about the actual value. Can you look at those?

jasongrout · 2018-03-19T18:35:38Z

ipywidgets/widgets/widget_float.py

@@ -58,6 +58,39 @@ def _validate_max(self, proposal):
            self.value = max
        return max

+class _BoundedLogFloat(_Float):
+    max = CFloat(10.0, help="Max value").tag(sync=True)


Can we clarify that the min/max are exponents, while the value is an actual number? That was confusing to me.

jasongrout · 2018-03-19T18:36:15Z

ipywidgets/widgets/widget_float.py

+
+    @validate('max')
+    def _validate_max(self, proposal):
+        """Enforce min <= value <= max"""


We should compare value to the base**min and base**max, right?

jasongrout · 2018-03-19T18:37:05Z

ipywidgets/widgets/widget_float.py

+        min = proposal['value']
+        if min > self.max:
+            raise TraitError('Setting min > max')
+        if min > self.value:


We should compare value to the base**min and base**max, right?

jasongrout · 2018-03-19T18:38:24Z

ipywidgets/widgets/widget_float.py

@@ -141,6 +176,46 @@ class FloatSlider(_BoundedFloat):
    continuous_update = Bool(True, help="Update the value of the widget as the user is holding the slider.").tag(sync=True)
    disabled = Bool(False, help="Enable or disable user changes").tag(sync=True)

+    style = InstanceDict(SliderStyle).tag(sync=True, **widget_serialization)


Thanks for catching that we didn't have the right style!

jasongrout · 2018-03-19T18:38:46Z

ipywidgets/widgets/widget_float.py

+    value : float
+        position of the slider
+    min : float
+        minimal position of the slider


Again, please clarify min/max are exponents

jasongrout · 2018-03-19T18:39:16Z

ipywidgets/widgets/widget_float.py

+        minimal position of the slider
+    max : float
+        maximal position of the slider
+    step : float


Please clarify step is a step in the exponent, not the actual value.

jasongrout · 2018-03-19T18:40:34Z

ipywidgets/widgets/widget_float.py

+    """
+    _view_name = Unicode('FloatLogSliderView').tag(sync=True)
+    _model_name = Unicode('FloatLogSliderModel').tag(sync=True)
+    step = CFloat(0.1, help="Minimum step to increment the value").tag(sync=True)


help should clarify this is changing the exponent.

jasongrout · 2018-03-19T18:42:13Z

packages/schema/jupyterwidgetmodels.latest.md

+`description`    | string           | `''`             | Description of the control.
+`disabled`       | boolean          | `false`          | Enable or disable user changes
+`layout`         | reference to Layout widget | reference to new instance | 
+`max`            | number (float)   | `10.0`           | Max value


Changing the help above to clarify min/max/step are talking about the exponent, then regenerating this, should change the docs here too.

sebasguts · 2018-03-20T11:29:03Z

Thanks for the review :).

I changed all the comments as proposed, and updated the PR.

jasongrout · 2018-03-20T23:34:20Z

packages/controls/src/widget_float.ts

+        return _.extend(super.defaults(), {
+            _model_name: 'FloatLogSliderModel',
+            _view_name: 'FloatLogSliderView',
+            step: 1.0,


step has a different default than the python side.

jasongrout · 2018-03-20T23:38:08Z

packages/controls/src/widget_float.ts

+        if (isNaN(value as number)) {
+            this.readout.textContent = this.valueToString(this.model.get('value'));
+        } else {
+            value = Math.max(Math.min(value as number, vmax), vmin);


This is comparing the actual value to vmin and vmax, which are exponents. This means that setting the value using the readout is clipped by the exponents, not the actual value range (e.g., try setting the readout to 20 with the default parameters...)

Also, you don't need the as number here either.

jasongrout · 2018-03-20T23:40:51Z

packages/controls/src/widget_float.ts

+        this.touch();
+    }
+
+        _validate_slide_value(x) {


Please dedent this line.

jasongrout · 2018-03-20T23:53:01Z

ipywidgets/widgets/widget_float.py

+        '.2f', help="Format for the readout").tag(sync=True)
+    continuous_update = Bool(True, help="Update the value of the widget as the user is holding the slider.").tag(sync=True)
+    disabled = Bool(False, help="Enable or disable user changes").tag(sync=True)
+    base = CFloat(2., help="Base for the logarithm").tag(sync=True)


I know we had this discussion before - what do you think about defaulting to base 10? I think that might be more common in everyday use.

If we did change it to base 10 (I think we probably ought to), we probably ought to default the max to something like 4, so we only go up to 10k.

jasongrout · 2018-03-21T00:10:34Z

packages/controls/src/widget_float.ts

+        let vmin = this.model.get('min');
+        let vmax = this.model.get('max');
+
+        if (isNaN(value as number)) {


You don't need the as number since the stringToValue function above is declared as returning a number.

jasongrout · 2018-03-21T00:16:59Z

Thanks! Just a few more comments above, and then I think we are good to go.

sebasguts · 2018-03-21T09:25:38Z

Thanks for the review again :). I adressed all the comments, so I also changed the base to 10 and the default max to 4.

jasongrout · 2018-03-21T22:40:18Z

Thanks! I noticed one last issue in doing final testing:

Just invoking with FloatLogSlider() (or FloatLogSlider(value=0)) doesn't check against the min, apparently, so we get an invalid value (the value is actually 0, it's not just a readout problem).

jasongrout · 2018-03-22T00:19:20Z

I think the easiest way to correct it is to declare the default value for a _BoundedLogFloat to be one:

    value = CFloat(1.0, help="Float value").tag(sync=True)

(Would need to change the js side default too)

a slider that uses a logarithmic scale. Closes jupyter-widgets#719

sebasguts · 2018-03-22T12:27:29Z

Thank you for the review again, and thanks for the catch. I actually did not test it without parameters.

I added the default to both sides, and the bug seems to have disappeared.

This one was quite strange, as it only seem to be appeared if value=0 was passed, value=-1 for example would have set the initial value to 1. I assume it comes from the logarithm computation on the JavaScript side, but I am not completely sure.

jasongrout · 2018-03-23T18:28:45Z

Looks good. Thanks!

sebasguts · 2018-03-23T20:04:04Z

Thanks for all the useful comments and for merging this PR :).

sebasguts force-pushed the master branch from ef80229 to 9102aca Compare January 23, 2018 21:59

jasongrout added this to the Minor release milestone Feb 16, 2018

jasongrout requested changes Mar 19, 2018

View reviewed changes

sebasguts force-pushed the master branch 2 times, most recently from a794665 to c1c6e59 Compare March 20, 2018 11:28

jasongrout reviewed Mar 20, 2018

View reviewed changes

packages/controls/src/widget_float.ts Outdated

this.touch();

}

_validate_slide_value(x) {

Copy link

Member

jasongrout Mar 20, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please dedent this line.

jasongrout reviewed Mar 20, 2018

View reviewed changes

jasongrout reviewed Mar 21, 2018

View reviewed changes

jasongrout modified the milestones: Minor release, 7.2 Mar 21, 2018

sebasguts force-pushed the master branch from c1c6e59 to 3f4f2a6 Compare March 21, 2018 09:24

Added FloatLogSlider

73b8132

a slider that uses a logarithmic scale. Closes jupyter-widgets#719

sebasguts force-pushed the master branch from 3f4f2a6 to 73b8132 Compare March 22, 2018 12:23

Update FloatLogSlider js defaults

b4c47e6

jasongrout approved these changes Mar 23, 2018

View reviewed changes

jasongrout merged commit d1997c5 into jupyter-widgets:master Mar 23, 2018

github-actions bot added the resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion. label Feb 7, 2021

github-actions bot locked as resolved and limited conversation to collaborators Feb 7, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added FloatLogSlider #1928

Added FloatLogSlider #1928

sebasguts commented Jan 23, 2018

jasongrout left a comment

jasongrout Mar 19, 2018

jasongrout Mar 19, 2018

jasongrout Mar 19, 2018

jasongrout Mar 19, 2018

jasongrout Mar 19, 2018

jasongrout Mar 19, 2018

jasongrout Mar 19, 2018

jasongrout Mar 19, 2018

sebasguts commented Mar 20, 2018

jasongrout Mar 20, 2018 •

edited

Loading

jasongrout Mar 20, 2018 •

edited

Loading

jasongrout Mar 21, 2018

jasongrout Mar 20, 2018

jasongrout Mar 20, 2018

jasongrout Mar 21, 2018

jasongrout Mar 21, 2018

jasongrout commented Mar 21, 2018

sebasguts commented Mar 21, 2018

jasongrout commented Mar 21, 2018

jasongrout commented Mar 22, 2018 •

edited

Loading

sebasguts commented Mar 22, 2018

jasongrout commented Mar 23, 2018

sebasguts commented Mar 23, 2018

Added FloatLogSlider #1928

Added FloatLogSlider #1928

Conversation

sebasguts commented Jan 23, 2018

jasongrout left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sebasguts commented Mar 20, 2018

jasongrout Mar 20, 2018 • edited Loading

Choose a reason for hiding this comment

jasongrout Mar 20, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jasongrout commented Mar 21, 2018

sebasguts commented Mar 21, 2018

jasongrout commented Mar 21, 2018

jasongrout commented Mar 22, 2018 • edited Loading

sebasguts commented Mar 22, 2018

jasongrout commented Mar 23, 2018

sebasguts commented Mar 23, 2018

jasongrout Mar 20, 2018 •

edited

Loading

jasongrout Mar 20, 2018 •

edited

Loading

jasongrout commented Mar 22, 2018 •

edited

Loading