Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document dynamic Callable API #1064

Open
philippjfr opened this issue Jan 16, 2017 · 4 comments
Open

Document dynamic Callable API #1064

philippjfr opened this issue Jan 16, 2017 · 4 comments
Assignees
Labels
type: docs Related to the documentation and examples
Milestone

Comments

@philippjfr
Copy link
Member

Our DynamicMaps wrap any callback that is passed in, in a Callable class, which performs memoization of the last returned value and also allows declaring the inputs to the function. Furthermore the callable allows traversing the call-graph of a DynamicMap. We should add a section to the DynamicMap tutorial to explain these details about Callable and how to work with them directly.

@philippjfr philippjfr added the type: docs Related to the documentation and examples label Jan 16, 2017
@jlstevens
Copy link
Contributor

There is a lot of material to cover in the tutorials if you include streams. We should consider the different ways we might want to split it across tutorials.

@jbednar
Copy link
Member

jbednar commented Jan 16, 2017

Presumably this would be where we explain how to deal with streaming data, i.e., something dependent on external data sources that update without our actions? Would we suggest adding a "counter" or "timestep" parameter that is ever-increasing to force the memoization to be bypassed, or should there be a more direct method?

@jlstevens
Copy link
Contributor

I've been discussing various ways memoization could be disabled with Philipp. I would prefer to do so in a more direct way than adding parameters just to keep changing the arguments..

@jlstevens
Copy link
Contributor

We'll see if we can add a little more documentation for 1.8.1.

@jlstevens jlstevens added this to the v1.8.1 milestone Jun 30, 2017
@jlstevens jlstevens modified the milestones: v1.8.1, 1.8.2 Jul 7, 2017
@philippjfr philippjfr modified the milestones: 1.8.4, v1.9 Sep 20, 2017
@philippjfr philippjfr modified the milestones: v1.9, v1.10 Oct 27, 2017
@philippjfr philippjfr modified the milestones: v1.10, v1.11 Mar 19, 2018
@philippjfr philippjfr modified the milestones: v1.11.0, v1.11.x Nov 5, 2018
@philippjfr philippjfr modified the milestones: v1.11.x, v1.12.0, v1.12.x Mar 22, 2019
@philippjfr philippjfr modified the milestones: v1.12.x, v1.13.0 Oct 7, 2019
@philippjfr philippjfr modified the milestones: v1.13.0, v1.13.x Mar 3, 2020
@philippjfr philippjfr modified the milestones: v1.14.x, v2.0 May 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Related to the documentation and examples
Projects
None yet
Development

No branches or pull requests

3 participants