docs icon indicating copy to clipboard operation
docs copied to clipboard

Docs: clarify picklable requirement for st.cache_resource

Open S-PANDIYAN opened this issue 1 month ago • 2 comments

Docs: clarify picklable requirement for st.cache_resource

Clarifies that st.cache_resource requires pickle-able objects in addition to being hashable, aligning the documentation with current caching behavior and addressing confusion reported in #1399.

📚 Context

This change clarifies a documented requirement mismatch discussed in #1399, where st.cache_resource requires objects to be pickle-able in addition to being hashable.

🧠 Description of Changes

Added a documentation note explaining that st.cache_resource requires pickle-able objects in addition to being hashable.

This helps prevent confusion around errors such as: TypeError: cannot pickle 'function' object

💥 Impact

Size:Small

🌐 References

#1399 — Error (TypeError: cannot pickle 'function' object) thrown in st.cache_resource is confusing because the documentation previously mentioned only hashability, while pickle-ability is also required.

📜 Contribution License Agreement

By submitting this pull request, you agree that all contributions to this project are made under the Apache 2.0 license

S-PANDIYAN avatar Jan 01 '26 16:01 S-PANDIYAN