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

feat(src/utils): add cache to is_namedtuple and is_structseq #121

Merged
merged 11 commits into from
Mar 25, 2024

Conversation

XuehaiPan
Copy link
Member

@XuehaiPan XuehaiPan commented Jan 2, 2024

Description

Describe your changes in detail.

Add a static cache in C++ to cache the result of is_namedtuple and is_structseq. I got about 15% performance gain in the benchmark.

Motivation and Context

Why is this change required? What problem does it solve?
If it fixes an open issue, please link to the issue here.
You can use the syntax close #15213 if this solves the issue #15213

  • I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds core functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

  • I have read the CONTRIBUTION guide. (required)
  • My change requires a change to the documentation.
  • I have updated the tests accordingly. (required for a bug fix or a new feature)
  • I have updated the documentation accordingly.
  • I have reformatted the code using make format. (required)
  • I have checked the code using make lint. (required)
  • I have ensured make test pass. (required)

@XuehaiPan XuehaiPan added enhancement New feature or request cxx Something related to the CXX source code labels Jan 2, 2024
@XuehaiPan XuehaiPan self-assigned this Jan 2, 2024
include/utils.h Outdated
Comment on lines 528 to 549
inline bool IsStructSequenceClass(const py::handle& type) {
return PyType_Check(type.ptr()) && IsStructSequenceClassImpl(type);
if (PyType_Check(type.ptr())) [[likely]] {
static auto cache = std::unordered_map<py::handle, bool, TypeHash, TypeEq>{};
auto it = cache.find(type);
if (it != cache.end()) [[likely]] {
return it->second;
}
bool result = IsStructSequenceClassImpl(type);
cache.emplace(type, result);
(void)py::weakref(type, py::cpp_function([type](py::handle weakref) -> void {
cache.erase(type);
weakref.dec_ref();
}))
.release();
return result;
}
return false;
}
Copy link
Member Author

Choose a reason for hiding this comment

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

Is this the best way to cache Python objects while cooperating with the Python GC? Could you have a look of this @Skylion007? Thanks!

@XuehaiPan XuehaiPan force-pushed the cache-is-namedtuple-is-structseq branch 2 times, most recently from 54a7c56 to 8352ae9 Compare January 2, 2024 18:29
Copy link

codecov bot commented Jan 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (72ae407) to head (a42ad86).

❗ Current head a42ad86 differs from pull request most recent head 13d1756. Consider uploading reports for the commit 13d1756 to get more accurate results

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #121   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            8         8           
  Lines          777       777           
=========================================
  Hits           777       777           
Flag Coverage Δ
unittests 100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@XuehaiPan XuehaiPan force-pushed the cache-is-namedtuple-is-structseq branch 3 times, most recently from 10ef302 to 6f9c7d6 Compare January 3, 2024 15:57
@XuehaiPan XuehaiPan force-pushed the cache-is-namedtuple-is-structseq branch from edd4ccf to f17d905 Compare February 25, 2024 15:27
@XuehaiPan XuehaiPan force-pushed the cache-is-namedtuple-is-structseq branch 2 times, most recently from d24f48d to dd7e0cd Compare March 25, 2024 16:02
@XuehaiPan XuehaiPan force-pushed the cache-is-namedtuple-is-structseq branch from dd7e0cd to 05f3825 Compare March 25, 2024 16:08
@XuehaiPan XuehaiPan force-pushed the cache-is-namedtuple-is-structseq branch from 314cd17 to a42ad86 Compare March 25, 2024 16:37
@XuehaiPan XuehaiPan requested a review from JieRen98 March 25, 2024 16:39
@XuehaiPan XuehaiPan merged commit b3e2abf into metaopt:main Mar 25, 2024
40 checks passed
@XuehaiPan XuehaiPan deleted the cache-is-namedtuple-is-structseq branch March 25, 2024 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cxx Something related to the CXX source code enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant