docs: use_memo docs #779
Merged
docs: use_memo docs #779
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
mofojed
commented
Aug 28, 2024
•
mofojed
commented
- Add docs for use_memo
- Give some examples of using memoization, and recommendations of when to use it and when not to use it
- Fixes ui.use_memo docs #728
- Add docs for use_memo - Give some examples of using memoization, and recommendations of when to use it and when not to use it
dsmmcken
requested changes
Aug 29, 2024
| 1. **Use memoization for expensive computations**: If you have a value that is expensive to compute, use `use_memo` to memoize the value between renders. | ||
| 2. **Use dependencies**: Pass in only the dependencies that the memoized value relies on. If any of the dependencies change, the memoized value is re-computed. If another prop or state value changes, the computation is not re-run. | ||
| 3. **Do not use for cheap computations**: There is small overhead to memoizing values, so only use `use_memo` for expensive computations. If the value is cheap to compute, it is not worth memoizing. | ||
|
|
There was a problem hiding this comment.
Should explicitly mention queries.
Co-authored-by: Don <[email protected]>
- Added a `time_table` example with memoization - Other misc cleanup
- Add details about looping
dsmmcken
requested changes
Sep 5, 2024
| `use_memo` can be used to memoize table operations. In the example below, we have a slider to adjust an integer value, a ticking table that will add a new row every second with the new result, and our theme picker from the previous example: | ||
|
|
||
| ```python | ||
| from deephaven import time_table, ui |
There was a problem hiding this comment.
I wonder if a more real example would work better of when I should an shouldn't memoize a query.
Also time tables will suck to auto generate screenshots.
Like _stocks
and memoize the rollup but not a filter?
with an option to selct rollup on sym or exchange and filter free-form?
There was a problem hiding this comment.
The problem with rollups and filters is that they are both memoized by the engine, so it doesn't really demonstrate why you need to memoize (since it's already memoized).
_stocks would have same issue as time_table for screenshots?
plugins/ui/docs/hooks/use_memo.md
Outdated
| @@ -1,6 +1,6 @@ | |||
| # use_memo | |||
|
|
|||
| `use_memo` is a hook to memoize a value. This is useful when you have a value that is expensive to compute, and you want to avoid re-computing it on every render. The value is computed once, and then stored in the memoized value. The memoized value is returned on subsequent renders until the dependencies change. | |||
| `use_memo` is a hook to cache the result of a calculation. This is useful when you have a value that is expensive to compute and you want to avoid re-computing it on every render. The value is computed once and then stored in the memoized value. The memoized value is returned on subsequent renders until the dependencies change. | |||
There was a problem hiding this comment.
Is calculation the right word? The result of a calculation, function or table reference (handle?)?
There was a problem hiding this comment.
Straight from the react.dev docs: https://react.dev/reference/react/useMemo
I could add some synonyms there.
Co-authored-by: Don <[email protected]>
dsmmcken
previously approved these changes
Sep 9, 2024
margaretkennedy
previously approved these changes
Sep 9, 2024
mofojed
dismissed stale reviews from margaretkennedy and dsmmcken
via
6eff906
dsmmcken
previously approved these changes
Sep 13, 2024
Adding one comma and removing one extra space.
margaretkennedy
approved these changes
Sep 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.