feat: track memoization stats #51

WinPlay02 · 2024-02-02T20:00:25Z

Closes partially #44

Summary of Changes

track more stats: last access, computation time, last access time, memory usage
refactored memoization logic into a new class
updated to safe-ds library 0.19

github-actions · 2024-02-02T20:01:49Z

🦙 MegaLinter status: ✅ SUCCESS

Descriptor	Linter	Files	Fixed	Errors	Elapsed time
✅ PYTHON	black	3	0	0	0.77s
✅ PYTHON	mypy	3		0	2.29s
✅ PYTHON	ruff	3	0	0	0.03s
✅ REPOSITORY	git_diff	yes		no	0.01s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by

codecov · 2024-02-02T20:02:10Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (9ee959d) 100.00% compared to head (b501fce) 100.00%.

Additional details and impacted files

@@            Coverage Diff            @@
##              main       #51   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            9        10    +1     
  Lines          436       499   +63     
=========================================
+ Hits           436       499   +63

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

docs: add docstrings

docs: fix documentation style: replace print with logging

src/safeds_runner/server/memoization_map.py

… try expression style: remove f-strings from logging statements

fix: correct order of memoization memory usage calculation

This is needed to correctly evaluate whether an object is worth memoizing or keeping in the cache. See for context: Safe-DS/Runner#51 and Safe-DS/Runner#44

Summary: - feat: return the correct size for custom container objects This is needed to correctly evaluate whether an object is worth memoizing or keeping in the cache. See for context: Safe-DS/Runner#51 and Safe-DS/Runner#44 For future container classes (like e.g. image set this would also need to be added, to be compatible with the memoizing implementation in the runner)

WinPlay02 · 2024-02-05T23:12:20Z

I would propose to merge the tracking of stats (this PR) first and continue the strategies for memoizing and removing in a follow-up PR.

…tion-expansion

…nner into memoization-expansion # Conflicts: # src/safeds_runner/server/memoization_map.py

test: update memory usage test to relative comparison, as the size is not constant across python versions

lars-reimann · 2024-02-06T14:24:35Z

I would propose to merge the tracking of stats (this PR) first and continue the strategies for memoizing and removing in a follow-up PR.

I'm all for that.

src/safeds_runner/server/memoization_map.py

tests/safeds_runner/server/test_memoization.py

src/safeds_runner/server/memoization_map.py

feat: track multiple stats per function instead of replacing them test: import directly, if possible

…nner into memoization-expansion # Conflicts: # src/safeds_runner/server/memoization_map.py

…ationStats`

src/safeds_runner/server/memoization_map.py

lars-reimann

I've made some changes that were easier to implement directly than to describe them.

@WinPlay02 Please take a quick look whether I broke anything and then feel free to merge if you're happy with it (or complain if you are not).

WinPlay02 · 2024-02-06T18:54:13Z

I've made some changes that were easier to implement directly than to describe them.

@WinPlay02 Please take a quick look whether I broke anything and then feel free to merge if you're happy with it (or complain if you are not).

This should be good to go

## [0.6.0](v0.5.0...v0.6.0) (2024-02-08) ### Features * track memoization stats ([#51](#51)) ([50f30a3](50f30a3)), closes [#44](#44)

lars-reimann · 2024-02-08T08:18:52Z

🎉 This PR is included in version 0.6.0 🎉

The release is available on:

v0.6.0
GitHub release

Your semantic-release bot 📦🚀

WinPlay02 added 2 commits February 2, 2024 20:24

refactor: move memoization logic into new class

18f0c85

feat: track more stats about memoized function calls

ab0213d

WinPlay02 added 3 commits February 3, 2024 23:58

Merge branch 'main' into memoization-expansion

6c328fb

feat: calculate memory usage better

670e8e0

docs: add docstrings

fix: comment out future functionality not yet preset in master

d0e25ff

docs: fix documentation style: replace print with logging

WinPlay02 commented Feb 4, 2024

View reviewed changes

src/safeds_runner/server/memoization_map.py Outdated Show resolved Hide resolved

WinPlay02 and others added 8 commits February 4, 2024 02:52

refactor: move rest of code not sensitive to keyerror to else part of…

184d16a

… try expression style: remove f-strings from logging statements

test: add tests for memoization memory usage calculation

02dc525

fix: correct order of memoization memory usage calculation

style: apply automated linter fixes

61f5c4d

style: apply automated linter fixes

9b2d08d

style: disable lines that are covered but coverage is broken

d86aeb9

style: apply automated linter fixes

b210b9a

Merge branch 'main' into memoization-expansion

2651b1a

style: remove unneeded coverage hints

506edbc

WinPlay02 mentioned this pull request Feb 5, 2024

feat: return the correct size for custom container objects Safe-DS/Library#547

Merged

WinPlay02 and others added 5 commits February 6, 2024 14:54

Merge branch 'main' of https://github.com/Safe-DS/Runner into memoiza…

bb53033

…tion-expansion

Merge branch 'memoization-expansion' of https://github.com/Safe-DS/Ru…

825de81

…nner into memoization-expansion # Conflicts: # src/safeds_runner/server/memoization_map.py

build: update to safe-ds 0.19

638963a

feat: update memoization map memory usage calculation

f452282

test: update memory usage test to relative comparison, as the size is not constant across python versions

style: apply automated linter fixes

a1adeb1

WinPlay02 changed the title ~~feat: memoization expansion~~ feat: memoization expansion part 1 Feb 6, 2024

WinPlay02 marked this pull request as ready for review February 6, 2024 14:24

WinPlay02 requested a review from a team as a code owner February 6, 2024 14:24

lars-reimann requested changes Feb 6, 2024

View reviewed changes

lars-reimann changed the title ~~feat: memoization expansion part 1~~ feat: track memoization stats Feb 6, 2024

WinPlay02 and others added 5 commits February 6, 2024 16:55

refactor: split memoization function into multiple parts

43dcb93

feat: track multiple stats per function instead of replacing them test: import directly, if possible

Merge branch 'memoization-expansion' of https://github.com/Safe-DS/Ru…

7b4ebdd

…nner into memoization-expansion # Conflicts: # src/safeds_runner/server/memoization_map.py

style: apply automated linter fixes

9ec25db

style: apply automated linter fixes

c18eccb

refactor: pluralize field names

48cf962

WinPlay02 requested a review from lars-reimann February 6, 2024 17:04

lars-reimann added 3 commits February 6, 2024 18:31

refactor: make _create_memoization_key a method of MemoizationMap

8044357

refactor: add methods update_on_hit and update_on_miss to `Memoiz…

880cd56

…ationStats`

refactor: restructure logic to track stats

368fc50

WinPlay02 commented Feb 6, 2024

View reviewed changes

src/safeds_runner/server/memoization_map.py Show resolved Hide resolved

lars-reimann previously approved these changes Feb 6, 2024

View reviewed changes

lars-reimann dismissed their stale review via 9ed137a February 6, 2024 17:46

fix: add explicit assignment to self._map_stats back

b501fce

lars-reimann force-pushed the memoization-expansion branch from 9ed137a to b501fce Compare February 6, 2024 17:48

lars-reimann approved these changes Feb 6, 2024

View reviewed changes

lars-reimann merged commit 50f30a3 into main Feb 6, 2024
8 checks passed

lars-reimann deleted the memoization-expansion branch February 6, 2024 19:09

lars-reimann pushed a commit that referenced this pull request Feb 8, 2024

chore(release): 0.6.0 [skip ci]

eb834fa

## [0.6.0](v0.5.0...v0.6.0) (2024-02-08) ### Features * track memoization stats ([#51](#51)) ([50f30a3](50f30a3)), closes [#44](#44)

lars-reimann added the released Included in a release label Feb 8, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: track memoization stats #51

feat: track memoization stats #51

WinPlay02 commented Feb 2, 2024 •

edited

Loading

github-actions bot commented Feb 2, 2024 •

edited

Loading

codecov bot commented Feb 2, 2024 •

edited

Loading

WinPlay02 commented Feb 5, 2024

lars-reimann commented Feb 6, 2024

lars-reimann left a comment

WinPlay02 commented Feb 6, 2024

lars-reimann commented Feb 8, 2024

feat: track memoization stats #51

feat: track memoization stats #51

Conversation

WinPlay02 commented Feb 2, 2024 • edited Loading

Summary of Changes

github-actions bot commented Feb 2, 2024 • edited Loading

🦙 MegaLinter status: ✅ SUCCESS

codecov bot commented Feb 2, 2024 • edited Loading

Codecov Report

WinPlay02 commented Feb 5, 2024

lars-reimann commented Feb 6, 2024

lars-reimann left a comment

Choose a reason for hiding this comment

WinPlay02 commented Feb 6, 2024

lars-reimann commented Feb 8, 2024

WinPlay02 commented Feb 2, 2024 •

edited

Loading

github-actions bot commented Feb 2, 2024 •

edited

Loading

codecov bot commented Feb 2, 2024 •

edited

Loading